Create shipment

post

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

Create a new shipment for an account.

Path Params

accountId

string

required

The account ID associated with the new shipment.

Body Params

Shipment details to be created.

Request data for creating or updating a shipment.

setId

string | null

ID of the set the shipment is part of.

name

string | null

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

Name of the shipment.

description

string | null

Description of the shipment.

referenceId

string | null

Reference ID for the shipment.

deviceId

string | null

ID of the device associated with the shipment.

poNumber

string | null

Purchase order number for the shipment.

origin

object

Origin location of the shipment.

destination

object

Destination location of the shipment.

transportDetails

object

The transport details for the shipment.

customProperties

object | null

Custom properties for the shipment.

items

array of objects | null

List of items in the shipment.

items

dependsOn

array of strings | null

List of shipment IDs this shipment depends on. Shipment will not start until all dependencies are completed.

dependsOn

healthStatus

string

enum

Health status of the shipment.

Allowed:

isPairingRequired

boolean | null

Does the shipment require label pairing.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

200Success