Get Customer Order

Get individual Order

GET /api/v0/orders/:customerOrderId

Retrieve specific Order details for a given customerOrderId.

Sample Response

{
  "data": {
    "orderDetails": {
      "customerOrderId": "string",
      "orderDate": "2024-03-18T18:24:46.334Z",
      "sourceOfSale": "Wayfair",
      "lineItems": [
        {
          "productId": "string",
          "name": "string",
          "customerLineItemId": "string",
          "quantity": 0,
          "unitPrice": 0,
          "disposition": "string",
          "status": "string"
        }
      ],
      "subTotal": 0,
      "salesTax": 0,
      "grandTotal": 0,
      "disposition": "string"
    }
  },
  "requestId": "string"
}

Schema Elements

SourceOfSale

The originating source of sale. May be one of the following (case sensitive):

Amazon
AmazonCa
BestBuy
Ebay
Etsy
Express
FacebookMarketplace
GoogleExpress
HomeDepot
InstagramMarketplace
Kohls
Kroger
Lowes
LowesMarketplace
Macys
NBCUniversal
NewEgg
OfficeDepot_OfficeMax_Staples
OneEightHundredFlowers
Overstock
QVC_HSN
Sears
Shein
Shopify
Target
Temu
TheKnot
TikTok
Vmi
Walmart
WalmartCa
Wayfair
Wish
OtherMarketplace

Line Item Dispositions
`api_order`	A standard order submitted to Spreetail via the Spreetail API
`out_of_stock`	The original line item product was unavailable when the order was processed
`out_of_stock_in_location`	The original line item product was unavailable when the order was picked
`wrong_item_shipped`	The original line item was mis-shipped
`wrong_quantity_shipped`	The original line item shipment contained the wrong quantity
`confirmed_misdelivery`	The original line item was incorrectly delivered by the carrier
`damaged_shipment`	The original line item was damaged in transit by the carrier
`lost_label`	A shipment label that was previously generated was lost or damaged in the Spreetail fulfillment center
`lost_post_delivery_driver_follow_up`	The carrier correctly delivered the original line item, but the customer did not receive the package
`lost_pre_delivery_in_transit`	The carrier lost the original line item prior to delivery to the customer