Welcome‎ > ‎Version 2‎ > ‎Publisher Api (Read/Write)‎ > ‎Methods‎ > ‎2 - Order‎ > ‎

By Id

Method used for loading an order by the order Id.

Method: /api/v2/publisher/order/{orderId}
Authentication: oauth

Required Parameters:
  orderId - The id of the order.

Optional Parameters:
  none

Returns:
  A Order

Sample Request:
GET /api/v2/publisher/order/3463 HTTP/1.1

Authorization: OAuth oauth_signature="I3dYwvZIlSh3NqWBtHSkePSKbEE%3d", oauth_nonce="7772081", oauth_timestamp="1305324191", oauth_consumer_key="43c5c674-620c-4f2b-bdcf-3082c99e8186", oauth_signature_method="HMAC-SHA1", oauth_version="1.0"

Host: apitest.groupcommerce.com


Sample XML Response:
<order xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <version>2.0</version>
    <success>true</success>
    <lastPublished>2011-05-13T22:32:11.9980039Z</lastPublished>
    <data>
        <amount>40</amount>
        <expirationDate>2014-07-19T20:20:00</expirationDate>
        <gifts/>
        <headline>40% Off Dinner and a Movie</headline>
        <merchantName>TL Admin Test Company</merchantName>
        <offerId>1027</offerId>
        <offerOptionId>265</offerOptionId>
        <optionTitle>40% Off Dinner and a Movie</optionTitle>
        <orderDate>2011-03-02T21:50:10</orderDate>
        <orderId>3461</orderId>
        <segmentKey>ny</segmentKey>
        <subtitle>This is the subtitle</subtitle>
        <vouchers>
            <voucher>
                <redemptionUrl i:nil="true"/>
                <voucherUrl>http://rewards.staging.thrillist.com/voucher?SecretKey=jH0YtKWDhL6AJhqeT0qLibbrgbkal%2fHs&amp;Code=P-1027-266-FFE</voucherUrl>
            </voucher>
        </vouchers>
    </data>
</order>


Sample JSON Response:
{
    "version": "2.0",
    "success": true,
    "lastPublished": "\/Date(1305325988881)\/",
    "data": {
        "amount": 40,
        "expirationDate": "\/Date(1405815600000-0400)\/",
        "gifts": [
           
        ],
        "headline": "40% Off Dinner and a Movie",
        "merchantName": "TL Admin Test Company",
        "offerId": 1027,
        "offerOptionId": 265,
        "optionTitle": "40% Off Dinner and a Movie",
        "orderDate": "\/Date(1299120610000-0500)\/",
        "orderId": 3461,
        "segmentKey": "ny",
        "subtitle": "This is the subtitle",
        "vouchers": [
            {
                "redemptionUrl": null,
                "voucherUrl": "http:\/\/rewards.staging.thrillist.com\/voucher?SecretKey=jH0YtKWDhL6AJhqeT0qLibbrgbkal%2fHs&Code=P-1027-266-FFE"
            }
        ]
    }
}

Comments