Shipments

v2-createShipment - Ship items of a Connect order

<div class="extension-title">Description</div>

Use this API to ship one or more items from the same order within the same package (using the same tracking information).

<div class="api-description-extension"> <div class="extension-title">Call Frequency</div> <div class="recommended-call-frequency">Recommended usage: On each new shipment</div> <div class="max-call-frequency">Maximum usage: On each new shipment</div> </div>

post/v2/orders/{order_id}/shipments

Path parameters

order_idstring required

Connect order identifier

Request body

carrierstring

Carrier company name. For example:

<code>UPS</code>
<code>DHL Express</code>
<code>Amazon Logistics UK</code>
<code>FedEx</code>
<code>China Post</code>
...

return_tracking_numberstring

Return shipment tracking number is required only for marketplaces that expect return tracking information when the shipment is created. If the marketplace doesn't require it to create the shipment, the value won't be synchronized.

tracking_numberstring

Carrier tracking number

tracking_urlstring

Carrier tracking URL

warehouse_idstring

Identifier of the warehouse from which the items are shipped. Optional; ignored by channels that do not require it.

Example request

{
  "carrier": "DHL Express",
  "items": [
    {
      "id": "SELLER_ID_1",
      "order_line_id": "0024_COMMERCIAL_ID-A-1"
    }
  ],
  "return_tracking_number": "78910",
  "tracking_number": "123456",
  "tracking_url": "https://wwwapps.ups.com/WebTracking/track",
  "warehouse_id": "WH-001"
}

Response

Success. The shipment has been created.

action_idstring required

The unique identifier for the asynchronous action. It should be used with the v2-getActionStatus API to retrieve current action status and potential errors.

tracking_idstring

Deprecated: This field was previously used to obtain the action ID. It has been replaced by action_id and contains the same value. It is retained for backward compatibility.

Example response

{
  "action_id": "1ba5fc4b-c4fd-4251-880b-3052e301bbd4",
  "tracking_id": "1ba5fc4b-c4fd-4251-880b-3052e301bbd4"
}