Sales Order Item Object
Sales order item objects are used throughout ShipEngine Connect to describe single items in a sales order.
Properties
This table lists the properties of a sales order item object and identifies those properties that are required. This object
is used for a property of the object returned from the getSalesOrdersByDate method method and is
not passed as an argument to any method.
| Name | Type | Required? | Description |
|---|---|---|---|
id | string | ✔ | The marketplace's unique ID for the order item. This string must not contain newline characters. |
name | string | ✔ | The user-friendly name of the item. This is often the same as the product name. This string must not contain newline characters. |
product | object | ✔ | The product associated with this item. |
product.id | string | ✔ | The marketplace's unique ID for the product. This string must not contain newline characters. |
product.identifiers | Your own identifiers for this product. | ||
product.details | A list of details associated with this product. | ||
product.sku | string | The Stock Keeping Unit. This string must not contain newline characters. | |
product.upc | string | The Universal Product Code for this item. This string must not contain newline characters. | |
product.isbn | string | The International Standard Book Number for this item. This string must not contain newline characters. | |
product.asin | string | The Amazon Standard Identification Number for this item. This string must not contain newline characters. | |
product.fulfillmentSku | string | The Stock Keeping Unit related to the fulfillment of this item. This string must not contain newline characters. | |
product.inventoryID | string | The inventory ID for this item. This string must not contain newline characters. | |
product.dimensions | object | The dimensions for the product. | |
product.dimensions.length | number | The length of the product. This value may contain decimals. | |
product.dimensions.width | number | The width of the product. This value may contain decimals. | |
product.dimensions.height | number | The height of the product. This value may contain decimals. | |
product.dimensions.unit | string | ✔ | The unit of measurement for the dimensions. Valid values include the following:
|
quantity | object | ✔ | The quantity of this item in the sales order. |
quantity.value | number | ✔ | The quantity of items in this sales order item. The minimum value for this property is |
unitPrice | object | ✔ | The sale price of each item. This should NOT include additional charges or adjustments, such as taxes or discounts. |
unitPrice.value | number | ✔ | The value for this amount. |
unitPrice.currency | string | ✔ | The currency for this amount. |
unitWeight | object | The weight of each item. | |
unitWeight.value | number | ✔ | The value for the weight. The minimum value for this property is |
unitWeight.unit | string | ✔ | The unit of measure for this weight. Valid values include the following:
|
sku | string | The Stock Keeping Unit. This string must not contain newline characters. | |
identifiers | Your own identifiers for this sales order item. | ||
description | string | The carrier's description of the charge, not specific to the user. This string must not contain newline characters. | |
itemURL | URL or string | The URL of a webpage where the customer can view the order item. Must be a valid HTTP or HTTPS url. | |
thumbnailURL | URL or string | The URL of a webpage where the customer can view an image of the order item. | |
location | string | The location where the product can be found in a warehouse. |