Skip to main content

Shipment Item

Each Shipment Item contains information about the shipped OrderItem in the Shipment.

When you create or update a ShipmentItem our system validates the Quantity can be fulfilled. Available quantity is calculated depending on orderItem.qty - orderItem.fulfilledQty.

ShipmentItems will be deleted automatically on delete parent Shipment object or related OrderItem object.

note

Once a ShipmentItem is created you cannot change the shipment, but you can change OrderItem and Quantity.

What you can do with ShipmentItem​

ShipmentItem Properties​

shipment
REQUIRED

Type: string (format: iri-reference)

The shipment reference to which the shipment item belongs.

Example: /shipments/83829499-f99c-4c91-9908-76c91f2ae312

orderItem
REQUIRED

Type: string|null (format: iri-reference)

The order item reference to which the shipment items item belongs.

Example: /order_items/83829499-f99c-4c91-9908-76c91f2ae312

qty

Type: integer|null

The number of items in the shipment. Default and the minimum value is 0. The value cannot be greater than available quantity of the order item (orderItem.qty - orderItem.fulfilledQty).

Example: 10

externalSourceSyncId

Type: string|null

The id of the shipment item in ecommerce store (WooCommerce, Shopify, etc.).

Example: wsi_123456

externalSourceIntegration

Type: string|null (format: iri-reference)

The workflow reference to integration for ecommerce store.

Example: /workflows/a0b97939-5aea-4b35-b7c6-64f56bff1721

fulfillmentIntegration

Type: string|null (format: iri-reference)

The workflow reference to integration for fulfillment source.

Example: /workflows/x5b97939-5aea-4b35-b7c6-64f56bff1722

fulfillmentSyncId

Type: string|null

The id of the shipment item in the fulfillment source system (AliExpress, Amazon, etc.).

Example: alsi_123456

id
READ-ONLY

Type: string (format: uuid)

A version 4 UUID.

Example: 7a1fbfed-48dc-4eaa-a1bb-e6e4c5754c7f

Endpoints​

GET
/shipment_items
Retrieves the collection of ShipmentItem resources.
Query Parameters
NameInIs RequiredTypeDescription
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
The maximal value: 500
idqueryNostring
id[]queryNoarray
Array of Strings.
shipment.idqueryNostring
shipment.id[]queryNoarray
Array of Strings.
shipment.trackingNumberqueryNostring
orderItem.idqueryNostring
orderItem.id[]queryNoarray
Array of Strings.
orderItem.order.idqueryNostring
orderItem.order.id[]queryNoarray
Array of Strings.
workspace.idqueryNostring
workspace.id[]queryNoarray
Array of Strings.
order[id]queryNostring
Allowed values: asc|desc
order[qty]queryNostring
Allowed values: asc|desc
qtyqueryNointeger
qty[]queryNoarray
Array of Integers.
qty[between]queryNostring
qty[gt]queryNostring
qty[gte]queryNostring
qty[lt]queryNostring
qty[lte]queryNostring
GET
/shipment_items/{id}
Retrieves a ShipmentItem resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstringResource identifier
GET
/shipments/{id}/shipment_items
Retrieves a Shipment resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstringShipment identifier
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
The maximal value: 500
idqueryNostring
id[]queryNoarray
Array of Strings.
shipment.idqueryNostring
shipment.id[]queryNoarray
Array of Strings.
shipment.trackingNumberqueryNostring
orderItem.idqueryNostring
orderItem.id[]queryNoarray
Array of Strings.
orderItem.order.idqueryNostring
orderItem.order.id[]queryNoarray
Array of Strings.
workspace.idqueryNostring
workspace.id[]queryNoarray
Array of Strings.
order[id]queryNostring
Allowed values: asc|desc
order[qty]queryNostring
Allowed values: asc|desc
qtyqueryNointeger
qty[]queryNoarray
Array of Integers.
qty[between]queryNostring
qty[gt]queryNostring
qty[gte]queryNostring
qty[lt]queryNostring
qty[lte]queryNostring
GET
/order_items/{id}/shipment_items
Retrieves a OrderItem resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstringOrderItem identifier
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
The maximal value: 500
idqueryNostring
id[]queryNoarray
Array of Strings.
shipment.idqueryNostring
shipment.id[]queryNoarray
Array of Strings.
shipment.trackingNumberqueryNostring
orderItem.idqueryNostring
orderItem.id[]queryNoarray
Array of Strings.
orderItem.order.idqueryNostring
orderItem.order.id[]queryNoarray
Array of Strings.
workspace.idqueryNostring
workspace.id[]queryNoarray
Array of Strings.
order[id]queryNostring
Allowed values: asc|desc
order[qty]queryNostring
Allowed values: asc|desc
qtyqueryNointeger
qty[]queryNoarray
Array of Integers.
qty[between]queryNostring
qty[gt]queryNostring
qty[gte]queryNostring
qty[lt]queryNostring
qty[lte]queryNostring
GET
/orders/{id}/items/{items}/shipment_items
Retrieves a Order resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstringOrder identifier
itemspathYesstringOrderItem identifier
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
The maximal value: 500
idqueryNostring
id[]queryNoarray
Array of Strings.
shipment.idqueryNostring
shipment.id[]queryNoarray
Array of Strings.
shipment.trackingNumberqueryNostring
orderItem.idqueryNostring
orderItem.id[]queryNoarray
Array of Strings.
orderItem.order.idqueryNostring
orderItem.order.id[]queryNoarray
Array of Strings.
workspace.idqueryNostring
workspace.id[]queryNoarray
Array of Strings.
order[id]queryNostring
Allowed values: asc|desc
order[qty]queryNostring
Allowed values: asc|desc
qtyqueryNointeger
qty[]queryNoarray
Array of Integers.
qty[between]queryNostring
qty[gt]queryNostring
qty[gte]queryNostring
qty[lt]queryNostring
qty[lte]queryNostring
GET
/workspaces/{id}/shipments/{shipments}/shipment_items
Retrieves a Workspace resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstringWorkspace identifier
shipmentspathYesstringShipment identifier
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
The maximal value: 500
idqueryNostring
id[]queryNoarray
Array of Strings.
shipment.idqueryNostring
shipment.id[]queryNoarray
Array of Strings.
shipment.trackingNumberqueryNostring
orderItem.idqueryNostring
orderItem.id[]queryNoarray
Array of Strings.
orderItem.order.idqueryNostring
orderItem.order.id[]queryNoarray
Array of Strings.
workspace.idqueryNostring
workspace.id[]queryNoarray
Array of Strings.
order[id]queryNostring
Allowed values: asc|desc
order[qty]queryNostring
Allowed values: asc|desc
qtyqueryNointeger
qty[]queryNoarray
Array of Integers.
qty[between]queryNostring
qty[gt]queryNostring
qty[gte]queryNostring
qty[lt]queryNostring
qty[lte]queryNostring
GET
/workspaces/{id}/orders/{orders}/items/{items}/shipment_items
Retrieves a Workspace resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstringWorkspace identifier
orderspathYesstringOrder identifier
itemspathYesstringOrderItem identifier
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
The maximal value: 500
idqueryNostring
id[]queryNoarray
Array of Strings.
shipment.idqueryNostring
shipment.id[]queryNoarray
Array of Strings.
shipment.trackingNumberqueryNostring
orderItem.idqueryNostring
orderItem.id[]queryNoarray
Array of Strings.
orderItem.order.idqueryNostring
orderItem.order.id[]queryNoarray
Array of Strings.
workspace.idqueryNostring
workspace.id[]queryNoarray
Array of Strings.
order[id]queryNostring
Allowed values: asc|desc
order[qty]queryNostring
Allowed values: asc|desc
qtyqueryNointeger
qty[]queryNoarray
Array of Integers.
qty[between]queryNostring
qty[gt]queryNostring
qty[gte]queryNostring
qty[lt]queryNostring
qty[lte]queryNostring
GET
/teams/{id}/workspaces/{workspaces}/shipments/{shipments}/shipment_items
Retrieves a Team resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstringTeam identifier
workspacespathYesstringWorkspace identifier
shipmentspathYesstringShipment identifier
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
The maximal value: 500
idqueryNostring
id[]queryNoarray
Array of Strings.
shipment.idqueryNostring
shipment.id[]queryNoarray
Array of Strings.
shipment.trackingNumberqueryNostring
orderItem.idqueryNostring
orderItem.id[]queryNoarray
Array of Strings.
orderItem.order.idqueryNostring
orderItem.order.id[]queryNoarray
Array of Strings.
workspace.idqueryNostring
workspace.id[]queryNoarray
Array of Strings.
order[id]queryNostring
Allowed values: asc|desc
order[qty]queryNostring
Allowed values: asc|desc
qtyqueryNointeger
qty[]queryNoarray
Array of Integers.
qty[between]queryNostring
qty[gt]queryNostring
qty[gte]queryNostring
qty[lt]queryNostring
qty[lte]queryNostring
GET
/teams/{id}/workspaces/{workspaces}/orders/{orders}/items/{items}/shipment_items
Retrieves a Team resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstringTeam identifier
workspacespathYesstringWorkspace identifier
orderspathYesstringOrder identifier
itemspathYesstringOrderItem identifier
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
The maximal value: 500
idqueryNostring
id[]queryNoarray
Array of Strings.
shipment.idqueryNostring
shipment.id[]queryNoarray
Array of Strings.
shipment.trackingNumberqueryNostring
orderItem.idqueryNostring
orderItem.id[]queryNoarray
Array of Strings.
orderItem.order.idqueryNostring
orderItem.order.id[]queryNoarray
Array of Strings.
workspace.idqueryNostring
workspace.id[]queryNoarray
Array of Strings.
order[id]queryNostring
Allowed values: asc|desc
order[qty]queryNostring
Allowed values: asc|desc
qtyqueryNointeger
qty[]queryNoarray
Array of Integers.
qty[between]queryNostring
qty[gt]queryNostring
qty[gte]queryNostring
qty[lt]queryNostring
qty[lte]queryNostring
POST
/shipment_items
Creates a ShipmentItem resource.
Query Parameters
NameInIs RequiredTypeDescription
Request Body Parameters

shipment
REQUIRED

Type: object

The shipment reference to which the shipment item belongs.

Example: 
"shipment": {
  "trackingNumber": "TM123456789TM",
  "orderNumbers": [
    "ON1",
    "ON2"
  ],
  "email": "non-existing@trackmage.com",
  "phoneNumber": 13125551212,
  "originCarrier": "china-post",
  "workspace": "/workspaces/cbe5589f-8869-4a9c-9d9c-3d7f70d66878",
  "orders": [
    "/orders/cbe5589f-8869-4a9c-9d9c-3d7f70d66878"
  ],
  "shipmentItems": [
    "/shipment_items/cbe5589f-8869-4a9c-9d9c-3d7f70d66878",
    "/shipment_items/3eb2f084-ea29-41ed-9bfb-691381bd7511"
  ],
  "externalSourceIntegration": "/workflows/a0b97939-5aea-4b35-b7c6-64f56bff1721",
  "externalSourceSyncId": "ws_123456",
  "fulfillmentIntegration": "/workflows/x5b97939-5aea-4b35-b7c6-64f56bff1722",
  "fulfillmentSyncId": "als_123456",
  "address": {
    "addressLine1": "567 East Cedar",
    "addressLine2": "Apartment 1",
    "city": "Liberal",
    "company": "Acme, Inc.",
    "country": "United States",
    "countryIso2": "US",
    "firstName": "Dorothy",
    "lastName": "Gale",
    "postcode": 67901,
    "state": "Kansas"
  },
  "shipmentStatus": {
    "code": "new",
    "title": "New"
  }
}
  • trackingNumber:

    A tracking number, provided by the shipping company.

  • orderNumbers:

    List of order numbers to which the shipment belongs.

  • email:

    Customer email address.

  • phoneNumber:

    Customer phone number.

  • originCarrier:

    The code of origin carrier. Origin Carrier will be identified automatically based on Tracking Number. Sometimes the carrier cannot be identified. In that case, the system will return the error with the suggested carriers list in the payload. The value of this field can be specified only once in POST request.

  • workspace:

    The workspace reference to which the shipment belongs.

  • orders:

    List of order references to which the shipment belongs.

  • shipmentItems:

    List of shipment items references that belong to the shipment.

  • externalSourceIntegration:

    The workflow reference to integration for ecommerce store.

  • externalSourceSyncId:

    The id of the shipment in ecommerce store (WooCommerce, Shopify, etc.).

  • fulfillmentIntegration:

    The workflow reference to integration for fulfillment source.

  • fulfillmentSyncId:

    The id of the shipment in the fulfillment source system (AliExpress, Amazon, etc.).

  • address:

    The mailing address to where the order will be shipped. Represented by the Address object.

  • shipmentStatus:

    The current status of shipment. Represented by the Status object.

orderItem
REQUIRED

Type: string|null (format: iri-reference)

The order item reference to which the shipment items item belongs.

Example: /order_items/83829499-f99c-4c91-9908-76c91f2ae312

qty

Type: integer|null

The number of items in the shipment. Default and the minimum value is 0. The value cannot be greater than available quantity of the order item (orderItem.qty - orderItem.fulfilledQty).

Example: 10

externalSourceSyncId

Type: string|null

The id of the shipment item in ecommerce store (WooCommerce, Shopify, etc.).

Example: wsi_123456

externalSourceIntegration

Type: string|null (format: iri-reference)

The workflow reference to integration for ecommerce store.

Example: /workflows/a0b97939-5aea-4b35-b7c6-64f56bff1721

fulfillmentIntegration

Type: string|null (format: iri-reference)

The workflow reference to integration for fulfillment source.

Example: /workflows/x5b97939-5aea-4b35-b7c6-64f56bff1722

fulfillmentSyncId

Type: string|null

The id of the shipment item in the fulfillment source system (AliExpress, Amazon, etc.).

Example: alsi_123456

PUT
/shipment_items/{id}
Replaces the ShipmentItem resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstringResource identifier
Request Body Parameters

orderItem
REQUIRED

Type: string|null (format: iri-reference)

The order item reference to which the shipment items item belongs.

Example: /order_items/83829499-f99c-4c91-9908-76c91f2ae312

qty

Type: integer|null

The number of items in the shipment. Default and the minimum value is 0. The value cannot be greater than available quantity of the order item (orderItem.qty - orderItem.fulfilledQty).

Example: 10

DELETE
/shipment_items/{id}
Removes the ShipmentItem resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstringResource identifier