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.

NameTypeRequired?Description
idstring

The marketplace's unique ID for the order item. This string must not contain newline characters.

namestring

The user-friendly name of the item. This is often the same as the product name. This string must not contain newline characters.

productobject

The product associated with this item.

product.idstring

The marketplace's unique ID for the product. This string must not contain newline characters.

product.identifiers

identifiers object

Your own identifiers for this product.

product.details

identifiers object

A list of details associated with this product.

product.skustring

The Stock Keeping Unit. This string must not contain newline characters.

product.upcstring

The Universal Product Code for this item. This string must not contain newline characters.

product.isbnstring

The International Standard Book Number for this item. This string must not contain newline characters.

product.asinstring

The Amazon Standard Identification Number for this item. This string must not contain newline characters.

product.fulfillmentSkustring

The Stock Keeping Unit related to the fulfillment of this item. This string must not contain newline characters.

product.inventoryIDstring

The inventory ID for this item. This string must not contain newline characters.

product.dimensionsobject

The dimensions for the product.

product.dimensions.lengthnumber

The length of the product. This value may contain decimals.

product.dimensions.widthnumber

The width of the product. This value may contain decimals.

product.dimensions.heightnumber

The height of the product. This value may contain decimals.

product.dimensions.unitstring

The unit of measurement for the dimensions. Valid values include the following:

  • in - inches
  • cm - centimeters
quantityobject

The quantity of this item in the sales order.

quantity.valuenumber

The quantity of items in this sales order item. The minimum value for this property is 1.

unitPriceobject

The sale price of each item. This should NOT include additional charges or adjustments, such as taxes or discounts.

unitPrice.valuenumber

The value for this amount.

unitPrice.currencystring

The currency for this amount.

unitWeightobject

The weight of each item.

unitWeight.valuenumber

The value for the weight. The minimum value for this property is 1.

unitWeight.unitstring

The unit of measure for this weight. Valid values include the following:

  • g for grams
  • oz for ounces
  • kg for kilograms
  • lb for pounds
skustring

The Stock Keeping Unit. This string must not contain newline characters.

identifiers

identifiers object

Your own identifiers for this sales order item.

descriptionstring

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.