MImirakl
Shipments

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). We recommend integrating this API in synchronous mode, directly in your shipment creation process.

<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/orders/{order_id}/shipments

Request

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

Example request

{
  "carrier": "DHL Express",
  "items": [
    {
      "id": "SELLER_ID_1",
      "order_line_id": "01JYGX3F6A2P8QW4KZRD9TBEH5"
    }
  ],
  "return_tracking_number": "78910",
  "tracking_number": "123456",
  "tracking_url": "https://wwwapps.ups.com/WebTracking/track"
}

Response

Success. The shipment has been created.

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>
  • ...
channel_shipment_idstring required

Shipment identifier on the sales channel. This identifier is unique for a sales channel, but multiple channels can use the same identifier.

created_atstring date-time required

Shipment creation date

idstring required

Unique shipment identifier used by Connect. This identifier can be used as a primary key, but it must not be shared with final users.

tracking_numberstring

Carrier tracking number

tracking_urlstring

Carrier tracking URL

updated_atstring date-time required

Date of last shipment modification

Example response

{
  "carrier": "DHL Express",
  "channel_shipment_id": "SHIPMENT_CHANNEL_ID_1",
  "created_at": "2021-07-06T09:24:36.32Z",
  "id": "0001_SHIPMENT-0001",
  "items": [
    {
      "id": "SELLER_ID_1",
      "order_line_id": "01JYGX3F6A2P8QW4KZRD9TBEH5"
    }
  ],
  "tracking_number": "123456",
  "tracking_url": "https://www.apps.ups.com/WebTracking/track",
  "updated_at": "2021-07-06T09:24:36.32Z"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.