Shipments

This API call is used to confirm the details of one or more shipment records in the WMS system. A confirmed shipment means that Invenco has despatched the order as per your reference number.

To get shipment confirmations, you make a HTTP GET request to the Shipments resource with an addtional ?created_min=1571055783104 query parameter. This will return all shipments shipped after the UNIX milliseconds timestamp in ascending order. This allows you to use this query parameter to progressively synchronise shipment data back into your system.

Shipment Properties

Shipment properties are detailed below

Property Name	Description
id	`"id": "a41bc281-6069-4f40-834c-ba6188b85e8e"` Unique shipment identifier in UUID format uuid (read only)
order_id	`"order_id": "944df17d-251c-4dbf-9bfe-5f970763aff8"` Unique order identifier in UUID format uuid (read only)
order_external_id	`"order_external_id": "SO12345"` Originally provided External Id of the order string (read only)
account_id	`"account_id": 0a7a1b5a-ed6c-4df9-9445-95a589928d0f"` Unique order identifier in UUID format uuid (read only)
status	`"status": "Shipped"` Status of the shipment - `Shipped` string (read only)
type	`"type": "Sales Shipment"` Type of the shipment - `Sales Shipment` string (read only)
tracking_number	`"tracking_number": "GNV0000213456"` Tracking number of the shipment - `Sales Shipment` string (read only)
tracking_number	`"tracking_link": "https://www.auspost.com.au/track/GNV0000213456"` Tracking link / url of the shipment to track the delivery progress string (read only)
tracking_carrier	`"tracking_carrier": "Australia Post"` Name of the carrier delivering the shipment string (read only)
line_items	`"order_line_number": "1"` `"sku": "ABC123"` `"description": "Blue Widget"` `"qty_ordered": 10` `"qty_shipped": 0` `"requires_shipping": true` `"unit_price": 14.95` Array of `line_item` objects. Each `line_item` object contains the following properties: order_line_number - the line number property of the order line item that this shipment line item corresponds to sku - the unique sku code for the item shipped description - the description for the item shipped qty_ordered - the qty ordered of this item by the customer qty_shipped - the qty shipped of this item by the warehouse unit_price - price charged by the seller for each item shipped array of objects (read only)
created	`"created": 1500906789123` Created timestamp in UNIX Milliseconds format integer (read only)
updated	`"updated": 1500906789123` Updated timestamp in UNIX Milliseconds format integer (read only)