Skip to main content
POST
Upsert a shipment grouping several sales orders.

Authorizations

Authorization
string
header
required

Headers

X-Tenant-Id
string

If you want to emulate, please enter TenantId.

Body

Push payload for POST /openapi/v1/Shipments. Groups several existing sales orders (by reference number) into one outbound shipment with a transport mode and a target date. The list is authoritative for the shipment's membership on every upsert.

shipmentNo
string

External shipment number from the calling system (e.g. Flormar SAP). Upsert key.

shipmentType
string

Transport mode: Air, Road or Sea (English name, case-insensitive).

shipmentDate
string<date-time>
salesOrders
string[]

Reference numbers of the sales orders that belong to this shipment.

integrationId
string<uuid>

Optional; disambiguates when the tenant has more than one OpenApi/Entegra integration.

Response

Success

shipmentNo
string
shipmentType
string
shipmentDate
string<date-time>
results
object[]
detached
string[]