Create a shipment event

Create an event for a shipment. Typically, forwarder will only create ORDER event for import/export shipment to announce arrival of goods or DELIVERY_ORDER event for requesting the delivery of an export shipment.

Create a shipment event

post

Create a shipment event

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

shipmentstring · uuidRequired

etaany | nullableRequired

ataany | nullableRequired

commentstring | nullableRequired

typestring · enumRequiredPossible values:

Responses

201Success

application/json

400

Bad Request

application/json

401

Unauthorized Entity

application/json

409

Conflict

application/json

422

Unprocessable Entity

application/json

post

/shipment-event

HTTPcURLJavaScriptPython

POST /shipment-event HTTP/1.1
Host: api.one-record.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "shipment": "123e4567-e89b-12d3-a456-426614174000",
  "eta": null,
  "ata": null,
  "comment": "text",
  "type": "ARRIVAL"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "shipment": "123e4567-e89b-12d3-a456-426614174000",
  "type": "ARRIVAL",
  "eta": null,
  "ata": null,
  "comment": "text",
  "createdAt": null,
  "updatedAt": null
}