Order Data API V5

Shoppable's Order Data API allows you to securely import your order data, including personally identifiable information (PII).

You can use the Order API to fetch all of your order data, including personally identifiable information (PII) using the order number. 

Order Data API v5

Headers

Please include the following header in the request to be authenticated. You can contact your CSM representative for required tokens

  "Authorization": “Bearer <Bearer token that will be provided by shoppable>”, 
  "x-shoppable-secret": “<Shoppable Secret will be provided by shoppable>”
  "Content-Type": "application/json"

Request

GET https://cloud.(staging.)shoppable.com/orders/:orderNumbers

• Order numbers must be separated by commas (,) like R803321771,R844106348...
• Maximum 20 orders can be queried at once. 

Response

Success HTTP 200 - All good and orders matching with orderNumbers are returned. If there is no matching orders an empty array will be returned.

[{
    "updatedAt": "2024-12-10T22:38:15.000Z",
    "orderNumber": "R803321771",
    "marketingOptIn": true,
    "status": "test",
    "shippingTotal": 0,
    "lineItemsTotal": 55.94,
    "total": 55.94,
    "email": "john.doe@example.com",
    "shippingDetails": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "120 Green St",
      "address2": "",
      "city": "Montclair",
      "state": "NJ",
      "country": "US",
      "zipCode": "071234",
      "phoneNumber": "1234567890"
    },
    "billingDetails": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "120 Green St",
      "address2": "",
      "city": "Montclair",
      "state": "NJ",
      "country": "US",
      "zipCode": "071234"
    },
    "merchants": [
      {
        "id": "62a0b5555ce2f83f392eca85",
        "merchant": "Walmart",
        "orderNumber": null,
        "shipping": 0,
        "items": [
          {
            "id": "62a0b5555ce2f83f392eca85-00037000799000",
            "upc": "00037000799000",
            "price": 55.94,
            "quantity": 1,
            "subTotal": 55.94,
            "name": "product name goes here",
            "color": "green",
            "size": "XL",
            "brand": "ACME",
            "status": "processing"
          }
        ]
      }
    ]
  },{
    "updatedAt": "2024-12-10T22:13:18.000Z",
    "orderNumber": "R844106348",
    "marketingOptIn": true,
    "status": "test",
    "shippingTotal": 0,
    "lineItemsTotal": 55.94,
    "total": 55.94,
    "shippingDetails": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "120 Green St",
      "address2": "",
      "city": "Montclair",
      "state": "NJ",
      "country": "US",
      "zipCode": "071234",
      "phoneNumber": "1234567890"
    },
    "billingDetails": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "120 Green St",
      "address2": "",
      "city": "Montclair",
      "state": "NJ",
      "country": "US",
      "zipCode": "071234"
    },
    "merchants": [
      {
        "id": "62a0b5555ce2f83f392eca85",
        "merchant": "Walmart",
        "orderNumber": null,
        "shipping": 0,
        "items": [
          {
            "id": "62a0b5555ce2f83f392eca85-00037000799788",
            "upc": "00037000799788",
            "price": 55.94,
            "quantity": 1,
            "subTotal": 55.94,
            "name": "product name goes here",
            "color": null,
            "size": null,
            "brand": "ACME",
            "status": "processing"
          }
        ]
      }
    ]
  }]

Bad Request HTTP 400 - Bad Request

{
  type:"request",
  message: "", // check message for detailed information
  outOfStockItems: [],
  itemsWithPriceChange: []
}

Internal Server Error 500 - On rare case something went wrong on Shoppable's end.

{
  type:"unexpected",
  message: "", // check message for detailed information
  outOfStockItems: [], // itemIds that are out of stock will be listed here
  itemsWithPriceChange: [] // itemIds that has price change will be listed here
}