Add shipments asynchronously
POST /easy-shipment-asynchronous on the Webhooks API. Base URL: https://api.sinay.ai/webhook/api/v1.
Add containers, bills of lading or bookings to one or several endpoints, using their container, bill of lading or booking numbers. The request is acknowledged immediately and processed asynchronously.
The request body is an object keyed by endpoint ID (ep_…). Each value holds a shipments array; each shipment has a number, and optionally a type and a sealine.
Every shipment sent is processed, whatever the errors on the other shipments of the same request. Each one then triggers either a shipment.added.to.endpoint or a shipment.in.error webhook event: follow those events to know whether a shipment has been added.
Request body
application/json, required.
| Field | Type | Required | Description |
|---|---|---|---|
<key> | object | No | — |
<key>.shipments | array of object | Yes | Array of shipments. |
<key>.shipments[].number | string | Yes | A shipment number. Can be a container number, a booking number or a Bill of Lading number. |
<key>.shipments[].sealine | string | No | A SCAC code (Sealine identifier). Specifying it will ensure we retrieve information from the right shipping line. To retrieve the list of supported sealines and their corresponding code, use our GET /sealines endpoint. This parameter is strongly recommended. Using it will greatly improve our response time and avoid sealine autodetection issues. |
<key>.shipments[].type | string | No | The shipment type (CT for container, BK for booking, BL for Bill of Lading) this parameter is recommended. Using it will improve our autodetection capabilities. One of: BK, BL, CT. |
Responses
No body.