Add shipments asynchronously

Add container or BL or BK to one or multiple endpoints with their container / BL / BK numbers. Your request will immediatelly be acknowledged. You can then monitor if you shipment has been correctly added with the events 'shipment.added.to.endpoint' and 'shipment.in.error

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The request body should contain a list of endpoints, each one with an array of shipments.

Example

{
  "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2": {
    "shipments": [
      {
        "number": "MSDU9813721",
        "sealine": "HLCU"
      },
      {
        "type": "BL",
        "number": "HLCUSHA2302AWXB8",
        "sealine": "HLCU"
      },
      {
        "number": "ZZZZ0000000"
      }
    ]
  }
}

All sent shipments will be processed regardless of their individual errors. Once the request has been sent, all shipments will then trigger "shipment.added.to.endpoint" or "shipment.in.error" events following the behavior described here.

Response body is empty : if 202 response, all asynchronous requests have been initiated successfully.

📘

To try the endpoint using the Body Params console below, enter your endpoint id in the "newkey" field.

Body Params

Array of shipments followed by the endpoint. Each shipment is described by a shipment number, shipment type and sealine.

Responses
202

Accepted. Your request is beeing processed asynchronously. Follow your shipment status with the webhook events.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json