Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Methods‎ > ‎2 - Consumer Related‎ > ‎

Get Orders

Will retrieve a list of all orders for a specific consumer from the system.  The result will be sorted by purchase date descending.

Method: GET /api/v3/publisher/consumer/{userKey}/orders
Authentication: oauth
 
Parameters
  userKey - the userkey of the consumer.

Returns
base response fields
orders- Will return the list of orders for the consumer.

Sample Request:

GET http://api.groupcommerce.com/api/v3/publisher/consumer/3c651ac9e6054d72b9b938f782790c8c/orders

Authorization: OAuth oauth_signature="DIiRWqYZzc0KMoONtq8b%2fudx6mw%3d", oauth_nonce="8890961", oauth_timestamp="1320715393", oauth_consumer_key="eeb6b959-b854-4ad1-b563-e801c83cf81d", oauth_signature_method="HMAC-SHA1", oauth_version="1.0"

Sample JSON Response:

{
    "errors":[],
    "lastPublished":"/Date(1320715400251)/",
    "success":true,
    "version":"3",
    "metaData":{
        "pageCount":1,
        "pageNumber":1,
        "pageSize":3,
        "totalItems":3
    },
    "orders":[
        { /*
see order */ },
        { /* see order */ },
        { /* see order */ }
    ]
}


Sample XML Response:

<getConsumerOrdersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <errors/>
    <lastPublished>2011-11-08T01:25:53.5878793Z</lastPublished>
    <success>true</success>
    <version>3</version>
    <metaData>
        <pageCount>1</pageCount>
        <pageNumber>1</pageNumber>
        <pageSize>2</pageSize>
        <totalItems>2</totalItems>
    </metaData>
    <orders>
        <order>
            <!-- see order -->
        </order>
        <order>
            <!-- see order -->
        </order>

    </orders>
</getConsumerOrdersResponse>
Comments