Create shipment

post

https://api.sensos.io/v1/accounts/{accountId}/shipments

Create a new shipment for an account. Returns 201 with the created shipment; the Location header contains the new shipment ID.

Path Params

accountId

string

required

The account ID.

Body Params

Shipment details to be created.

Request data for creating or updating a shipment.

setId

uuid | null

ID of a set in the account (400 if it does not exist).

name

string | null

^[^\$\%\^\*\{\}\@]*$

Name. Up to 40 characters; cannot contain $ % ^ * { } @.

description

string | null

Description.

deviceId

string | null

^[a-zA-Z0-9._\-\s]{0,70}$

ID of the paired device. Letters, numbers, spaces, dots, hyphens and underscores, up to 70 characters. The device must exist in the account (400).

healthStatus

string | null

enum

Health status. Closed cannot be set in a request (400); defaults to Healthy on create.

Allowed:

items

array of objects | null

Items (up to 10).

items

customProperties

object | null

Custom key-value properties: up to 30 keys, keys up to 50 characters, values up to 100 characters.

referenceId

string | null

Reference ID for the shipment in your system.

poNumber

string | null

^[a-zA-Z0-9._\-\s]{0,70}$

Purchase order number. Letters, numbers, spaces, dots, hyphens and underscores, up to 70 characters.

origin

object | null

Origin location of the shipment.

destination

object | null

Destination location of the shipment.

transportDetails

object | null

Transport details for the shipment.

dependsOn

array of strings | null, unique

ID of the shipment this shipment depends on (at most 1). The shipment will not start until the dependency is completed. A shipment can be depended on by at most 5 shipments, and cannot depend on itself.

dependsOn

Responses

401

Missing, invalid or expired access token. Returned by the gateway with an empty body.

403

The token lacks the required permission, the account is not accessible to it, or the tenant is inactive. Returned by the gateway with an empty body.

201Created

400Invalid request. Field and query validation failures return ValidationProblemDetails; business-rule failures return ErrorResponse.

402The request uses a feature (airway bill or ocean tracking) that is not included in your plan.