| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Listing all Orders
GET /api/v0/orders?lastDays=30&orderDisposition=api&orderLineItemDisposition=all
Get Details about all Orders within “lastDays”. If not provided, defaults to 30. Maximum allowed of 365.
| Get Orders Request (Query String Options) | |
|---|---|
lastDays | Integer (Optional). Specify the number, in days, or orders to return |
orderDisposition | String (Optional). Specify the order type dispositions to return. Defaults to api when not specified. Parameter can be repeated. Value can be one of the following:
|
orderLineItemDisposition | String (Optional). Specify an Order Line Item Disposition Type to search for. Any order containing the specified disposition(s) will be returned. Defaults to all when not specified. Parameter can be repeated. Value can be one of the following:
|
Sample Response
{
"data": [
{
"orderDetails": {
"customerOrderId": "string",
"orderDate": "2024-03-18T18:24:21.505Z",
"orderRegionInfo": {
"city": "Omaha",
"state": "NE",
"country": "US",
"portalCode":"68010"
},
"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"
}Response
| orderDetails Response Field | |
|---|---|
customerOrderId | The value provided to the API. Alternatively, the Order ID provided to Spreetail by the marketplace for non-API orders |
orderDate | Date the order was created |
orderRegionInfo.city | The city of the order shipping address. This information will be redacted 30 days after the order creation day. |
orderRegionInfo.state | The state of the order shipping address. This information will be redacted 30 days after the order creation day. |
orderRegionInfo.country | The country of the order shipping address. This information will be redacted 30 days after the order creation day. |
orderRegionInfo.portalCode | The portal code of order shipping address. This information will be redacted 30 days after the order creation day. |
sourceOfSale | Originating source of sale. See Schema Elements > SourceOfSale for details |
lineItems.productId | The ProductID value for the line item. This is Spreetails ProductID |
lineItems.name | Title of the item |
lineItems.customerLineItemId | Unique identifier for the line item |
lineItems.Quantity | Quantity included in the order |
lineItems.unitPrice | Unit price for the item. Including any discounts |
lineItems.discount | Amount applied as a discount to the line item |
lineItems.disposition | Indicates the type of line item. See Line Item Dispositions in the Schema Elements section for additional details. May be one of the following:
|
lineItems.status | The current status of the line item. The following are the most common values: Waiting to Clear The order line item has been received, and is pending validation, order processing, and tracking number generation Shipped The order line item has been packaged and is ready to leave or has already left our fulfillment center network Order Canceled The order line item has been canceled. If this is unexpected, check the order for new line items with a |
subTotal | Sub total of all line items, including any discounts |
salesTax | Sales tax total for the order |
discountTotal | Total discount amount applied to the order |
grandTotal | Total order price. Includes Subtotal plus SalesTax |
disposition | Indicates the type of order. May be one of the following:
|
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.
Unauthorized
Forbidden