This service is in BETA. For access please Fill out the application
The orders resource is used to create, modify, and view orders associated with your account. An order is an order placed on a venue and contains one one or more orderItems.
Each order contains a SLAPI-generated id field. Currently the 'id' is a concatanation of the venueId and the venueOrderId, but that may not be so in the future and should not be assumed.
The Parameters Common to Collections are supported in addition to the following:
| Parameter | Explanation |
|---|---|
| search | performs a wildcard search on msku, recipient, buyerName, buyerEmail, orderItems.title, orderItems.msku, orderId, and venueOrderId. Note that since this searches so many fields, it may be slow to respond. If you know the specific field, then specifying it is much preferred |
| start | specify as start date in the format YYYY-MM-DD |
| end | specify as end date in the format YYYY-MM-DD |
| modifiedSince | orders only modified since the specified UTC time |
| venueId | filter by a specific venueId |
| orderId | filter by a specific orderId |
| venueOrderId | filter by a specific venueOrderId |
| recipient | filter by a specific recipient |
| shipCity | filter by a specific shipCity |
| shipZip | filter by a specific shipZip |
| shipCountry | filter by a specific shipCountry |
| buyerName | filter by a specific buyerName |
| buyerId | filter by a specific buyerId |
By specifying expand=orderItems, an orderItems collection will be included with each order in the response
| Attribute | Data Type | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| id | string | yes | unique key for an order. Currently a concatanation of the venueId and venueOrderId | ||||||||
| venueId | integer | yes | sets the item status to active or inactive | ||||||||
| venueOrderId | string | yes | The unique identifier assigned from the venue for this order | ||||||||
| timestamp | timestamp | yes | the timestamp that the order was placed from the venue | ||||||||
| modified | timestamp | no | The timestamp that the order was last modified | ||||||||
| status | string | yes |
|
||||||||
| recipient | string | recommended | Recipient (ship-to) Name | ||||||||
| shipAddress1 | string | recommended | Shipping Address (line 1) | ||||||||
| shipAddress2 | string | recommended | Shipping Address (line 2) | ||||||||
| shipCity | string | recommended | Shipping City | ||||||||
| shipState | string | recommended | Shipping State | ||||||||
| shipZip | string | recommended | Shipping Zip/Postal Code | ||||||||
| shipCountry | string | recommended | Shipping Country | ||||||||
| total | float | yes | The numeric total for the order | ||||||||
| buyerName | string | recommended | The buyer's name | ||||||||
| buyerEmail | string | recommended | The buyer's email address | ||||||||
| buyerId | string | no | The venue-specific buyer identifier (if available) | ||||||||
| buyerPhone | string | no | The buyer's phone number |
| GET /orders | Returns all of the orders for an account |
|---|---|
| GET /orders/id | Returns the information for that specific item |
| POST /orders | Creates a new order. Overwrites an existing setting if it already exists |
| POST /orders/id | Updates and order. Overwrites only values that are passed |
| PUT /orders | Not Permitted. Returns HTTP 405 |
| PUT /orders/id | Updates the existing orer. Overrides all exisiting values |
| DELETE /orders | Not Permitted. Returns HTTP 405 |
| DELETE /orders/id | Not permitted. Returns HTTP 405 |
expand=orderItems Includes an orderItems collection response on each order in the response
Response from GET https://api.sellerlabs.com/v1/orders?expand=orderItems&limit=3
{
"status":"success",
"code":200,
"httpCode":"200",
"user":"107",
"data":{
"offset":0,
"limit":3,
"count":4,
"prev":"",
"next":"\/orders?expand=orderItems&limit=3&offset=3",
"first":"\/orders?expand=orderItems&limit=3&offset=0",
"last":"\/orders?expand=orderItems&limit=3&offset=3",
"pages":2,
"orders":[
{
"id":"1-115-9149487-0123456",
"venueId":"1",
"venueOrderId":"115-9149487-0123456",
"timestamp":"2014-07-01T17:02:50Z",
"modified":"2014-07-01T17:09:47Z",
"status":"Pending",
"recipient":"",
"shipAddress1":"",
"shipAddress2":"",
"shipCity":"",
"shipState":"",
"shipZip":"",
"shipCountry":"",
"total":"0",
"buyerName":"",
"buyerEmail":"",
"buyerId":"",
"buyerPhone":"",
"orderItems":{
"offset":0,
"limit":50,
"count":"2",
"prev":"",
"next":"",
"first":"\/orderItems?orderId=1-115-9149487-0123456&offset=0&limit=50",
"last":"\/orderItems?orderId=1-115-9149487-0123456&offset=0&limit=50",
"pages":1,
"orderItems":[
{
"orderId":"1-115-9149487-0123456",
"orderItemId":"31731294543938",
"msku":"0HL-H3QCD",
"fulfillmentChannel":"MFN",
"title":"All Kinds of Families [Hardcover] [1976] Simon, Norma; Lasker, Joe",
"image":"",
"quantity":"1",
"priceItem":"0",
"priceShipping":"0",
"priceTax":"0",
"priceOther":"0",
"priceDiscount":"0",
"status":"",
"modified":"2014-07-01T17:09:48Z",
"notes":"",
"cond":"",
"purchaseId":"0",
"locationId":"0",
"returnTimestamp":null,
"returnReason":null,
"returnCondition":null,
"carrier":"",
"shipMethod":"",
"trackingNumber":"",
"estimatedArrivalDate":"0000-00-00",
"deliveryStatus":"",
"deliveryLastChecked":null,
"shipTimestamp":null,
"outForDeliveryTimestamp":null,
"deliveryTimestamp":null,
"id":"1-115-9149487-0123456-ZZZ-31731294543938",
"link":"http:\/\/api.sellerlabs.com\/v1\/orderItems\/1-115-9149487-0123456-ZZZ-31731294543938"
},
{
"orderId":"1-115-9149487-0123456",
"orderItemId":"67490291966634",
"msku":"0BL-ZR8CW",
"fulfillmentChannel":"MFN",
"title":"I Love You the Purplest [Paperback] [1998] Joosse, barbara M.; Whyte, Mary",
"image":"",
"quantity":"1",
"priceItem":"0",
"priceShipping":"0",
"priceTax":"0",
"priceOther":"0",
"priceDiscount":"0",
"status":"",
"modified":"2014-07-01T17:09:48Z",
"notes":"",
"cond":"",
"purchaseId":"0",
"locationId":"0",
"returnTimestamp":null,
"returnReason":null,
"returnCondition":null,
"carrier":"",
"shipMethod":"",
"trackingNumber":"",
"estimatedArrivalDate":"0000-00-00",
"deliveryStatus":"",
"deliveryLastChecked":null,
"shipTimestamp":null,
"outForDeliveryTimestamp":null,
"deliveryTimestamp":null,
"id":"1-115-9149487-0123456-ZZZ-67490291966634",
"link":"http:\/\/api.sellerlabs.com\/v1\/orderItems\/1-115-9149487-0123456-ZZZ-67490291966634"
}
]
},
"link":"http:\/\/api.sellerlabs.com\/v1\/orders\/1-115-9149487-0123456"
},
{
"id":"1-002-3503601-7654321",
"venueId":"1",
"venueOrderId":"002-3503601-7654321",
"timestamp":"2014-07-01T17:02:08Z",
"modified":"2014-07-01T17:14:47Z",
"status":"Pending",
"recipient":"",
"shipAddress1":"",
"shipAddress2":"",
"shipCity":"",
"shipState":"",
"shipZip":"",
"shipCountry":"",
"total":"0",
"buyerName":"",
"buyerEmail":"",
"buyerId":"",
"buyerPhone":"",
"orderItems":{
"offset":0,
"limit":50,
"count":"1",
"prev":"",
"next":"",
"first":"\/orderItems?orderId=1-002-3503601-7654321&offset=0&limit=50",
"last":"\/orderItems?orderId=1-002-3503601-7654321&offset=0&limit=50",
"pages":1,
"orderItems":[
{
"orderId":"1-002-3503601-7654321",
"orderItemId":"33187930194850",
"msku":"0GH-GYDWQ",
"fulfillmentChannel":"MFN",
"title":"Passages Of Light [Hardcover] [2000] Kinkade, Thomas",
"image":"",
"quantity":"1",
"priceItem":"0",
"priceShipping":"0",
"priceTax":"0",
"priceOther":"0",
"priceDiscount":"0",
"status":"",
"modified":"2014-07-01T17:14:48Z",
"notes":"",
"cond":"",
"purchaseId":"0",
"locationId":"0",
"returnTimestamp":null,
"returnReason":null,
"returnCondition":null,
"carrier":"",
"shipMethod":"",
"trackingNumber":"",
"estimatedArrivalDate":"0000-00-00",
"deliveryStatus":"",
"deliveryLastChecked":null,
"shipTimestamp":null,
"outForDeliveryTimestamp":null,
"deliveryTimestamp":null,
"id":"1-002-3503601-7654321-ZZZ-33187930194850",
"link":"http:\/\/api.sellerlabs.com\/v1\/orderItems\/1-002-3503601-7654321-ZZZ-33187930194850"
}
]
},
"link":"http:\/\/api.sellerlabs.com\/v1\/orders\/1-002-3503601-7654321"
},
{
"id":"1-113-2745904-4536271",
"venueId":"1",
"venueOrderId":"113-2745904-4536271",
"timestamp":"2014-07-01T14:56:53Z",
"modified":"2014-07-01T16:55:05Z",
"status":"Unshipped",
"recipient":"Sample Recipient",
"shipAddress1":"123 OAK ST",
"shipAddress2":"",
"shipCity":"ATHENS",
"shipState":"GA",
"shipZip":"30601-4633",
"shipCountry":"US",
"total":"5.09",
"buyerName":"Sample Recipient",
"buyerEmail":"foobarfoobar@marketplace.amazon.com",
"buyerId":"",
"buyerPhone":"",
"orderItems":{
"offset":0,
"limit":50,
"count":"1",
"prev":"",
"next":"",
"first":"\/orderItems?orderId=1-113-2745904-4536271&offset=0&limit=50",
"last":"\/orderItems?orderId=1-113-2745904-4536271&offset=0&limit=50",
"pages":1,
"orderItems":[
{
"orderId":"1-113-2745904-4536271",
"orderItemId":"69912309302730",
"msku":"0VB-92HL5",
"fulfillmentChannel":"MFN",
"title":"Let the Lions Roar!: The Evolution of Brookfield Zoo [Hardcover] [1997] Ross, Andrea Friederici",
"image":"",
"quantity":"1",
"priceItem":"1.1",
"priceShipping":"3.99",
"priceTax":"0",
"priceOther":"0",
"priceDiscount":"0",
"status":"",
"modified":"2014-07-01T16:55:05Z",
"notes":"",
"cond":"",
"purchaseId":"0",
"locationId":"0",
"returnTimestamp":null,
"returnReason":null,
"returnCondition":null,
"carrier":"",
"shipMethod":"",
"trackingNumber":"",
"estimatedArrivalDate":"0000-00-00",
"deliveryStatus":"",
"deliveryLastChecked":null,
"shipTimestamp":null,
"outForDeliveryTimestamp":null,
"deliveryTimestamp":null,
"id":"1-113-2745904-4536271-ZZZ-69912309302730",
"link":"http:\/\/api.sellerlabs.com\/v1\/orderItems\/1-113-2745904-4536271-ZZZ-69912309302730"
}
]
},
"link":"http:\/\/api.sellerlabs.com\/v1\/orders\/1-113-2745904-4536271"
}
]
}
}