Skip to main content
POST
Confirm pickup.

Authorizations

Authorization
string
header
required

OAuth 2.0 client_credentials grant via Keycloak service account. Clients are provisioned per IntegrationOrganization in the nt24-idp realm.

Headers

Idempotency-Key
string
required

Client-generated unique key (UUID recommended) for this write operation. Identical key + identical body within 24h returns the cached response. Identical key + different body returns 422.

Required string length: 1 - 255

Path Parameters

sellerId
string<uuid>
required

UUID of the seller trade partner (must be in caller's authorized list).

uuid
string<uuid>
required

Body

application/json
type
enum<string>
required

How the vehicle is collected. Named and valued as the platform's TransportPickupState; SELF_PICKUP is not expected to produce a CMR.

Available options:
TRANSPORT_COMPANY,
SELF_PICKUP
pickupDate
string<date>
required

Response

Pickup confirmed.

vins
object[]
required

One entry per vehicle of the order, sorted by VIN. Always present, and empty only for an order with no vehicle. Added in 1.5.0-draft; the order-level fields above keep their meaning.

status
enum<string>

The whole order's state, across its transports. On an order split across several shipments this is the least advanced transport: DELIVERED only once every transport has arrived. A shipment with no transport is not counted here; its vehicles read NOT_STARTED in vins, which also says which vehicles got further.

Available options:
NOT_STARTED,
PICKUP_CONFIRMED,
DELIVERED
pickupConfirmed
boolean
pickupDate
string<date>
deliveryConfirmed
boolean
deliveryDate
string<date>
arrivalConfirmed
boolean
cmrUploaded
boolean