Creates an Order for fulfillment. Spreetail uses a unique Spreetail ProductID in order to process orders.
CustomerDetails
| Field | Contents |
|---|---|
shippingAddress | An object of Address |
Address
| Field | Contents |
|---|---|
fullName | Full Name of the recipient. Required, max length is 100. |
email | Contact email for delivery issues. Optional, max length is 100. |
addressLines | Must have at least 1 address line, at most 3. Each address line must not exceed 255 characters. Required. |
city | Delivery City. Required, max length is 50 |
provinceOrState | Delivery Province or State. Required |
postalOrZipCode | ZioCode. Required. When 'CountryCode' is US the 'PostalOrZipCode' must be 5 digits, or when specifying a Zip+4 be formatted with a separating dash |
countryCode | Two character Country Code (ISO 3166-1 alpha-2). Required |
phone | Contact phone for delivery issues. Phone Number' Must have at least 10 numeric digits. Max length = 35. Required |
OrderDetails
Field | Contents |
|---|---|
| Your unique order ID, this can be used to retrieve further details about an order. Required, max length = 40, cannot using existing customer Order Id |
| The unique identifier for the order within the originating marketplace. Optional, max length is 40 |
| A UTC time. Required, orderDate must be less that 30 days old (UTC) |
| Originating source of sale. Required, max length is 50，must in the below sourceOfSale list: See Schema Elements > SourceOfSale for details |
| An array of OrderLineItems. Required |
| The total discount from the order. Must be the sum of all line items unit discount times quantity |
| The total revenue from the order, including discounts, excluding taxes. Must be the sum of all line items unit price times quantity. Required. Should >= 0. |
| Sales Tax of the line item. Required, it can be 0. |
| Total financial value received from the order, including any discounts and taxes. Must be subtotal plus taxes. Required |
| The preferred date and time that the marketplace is requesting. Optional |
OrderShippingDetails (Optional)
| Field | Contents |
|---|---|
carrierId | The specific carrier of the order. It is later used to identify the name of the carrier and its service level. Required. |
shippingAccountNumber | The account number of the source of sale. Optional |
shipLabelNameDisplay | The name that the brand wants to display on the shipping label. Optional |
shippingContactName | The shipper's company name. Optional |
shippingContactPhoneNumber | The shipper's phone number. Optional |
OrderLineItems
Note
ProductID is critical in order to fulfill orders. This must be the Spreetail mapped ProductID mapped to the product. This is a unique identifier created by Spreetail for inventory tracking and fulfillment in our supply chain. This can be retrieved using 'Get All Inventory Items' endpoint (/api/v0/inventory/items).
| Field | Contents |
|---|---|
productId | The Spreetail provided Product Identification. This can be retrieved using 'Get All Inventory Items' endpoint (/api/v0/inventory/items). Max length is 50. Required. |
customerLineItemId | A unique identifier for this item in the order. Must only be unique per order. (Example: 001, 002, 003, 004). Max length is 40. Required. |
name | The name of the item sold. Max length is 100. Required. |
quantity | Quantity sold. Required, must greater than 0 |
unitPrice | Total unit sale price of the item sold, excluding any discounts. Must >= 0 |
Sample Data Submission
{
"customerDetails": {
"shippingAddress": {
"fullName": "string",
"email": "string",
"addressLines": [
"string"
],
"city": "string",
"provinceOrState": "string",
"postalOrZipCode": "string",
"countryCode": "st",
"phone": "string"
}
},
"orderDetails": {
"customerOrderId": "string",
"orderDate": "2024-03-18T18:23:57.089Z",
"sourceOfSale": "OtherMarketplace",
"lineItems": [
{
"productId": "string",
"name": "string",
"customerLineItemId": "string",
"quantity": 0,
"unitPrice": 0
"discount": 0
}
],
"subTotal": 0,
"salesTax": 0,
"grandTotal": 0
},
"orderShippingDetails": {
"carrierId": "FedExGround",
"shippingAccountNumber": "string",
"shipLabelNameDisplay": "string",
"shippingContactName": "string",
"shippingContactPhoneNumber": "string"
}
}CarrierId
The id of the carrier of the order. May be one of the following (case sensitive)
| CarrierId |
|---|
| FedExGround |
| FedEx2Day |
| FedExOvernight |
SourceOfSale
The originating source of sale. May be one of the following (case sensitive):
| SourceOfSale |
|---|
| 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 |
Error Messages
409 Error Messages
"Shippable Inventory out of stock for ProductId 'ProductId'"
There is currently no available inventory to ship this order.
400 Error Messages
"0 Shippable Quantity"
There is an invalid field in the order.
"Must have at least one address line"
Address is missing in the transmission in the order.