Shipments

De Shipments API beheert verzendingen (shipments). Elke verzending is gekoppeld aan een verkooporder en bevat verzendregels met producten en hoeveelheden.

The shipment model

Properties

Name
id
Type
string
Description
Unieke identifier.
Name
number
Type
string
Description
Verzendnummer (uniek).
Name
reference
Type
string
Description
Externe referentie (bijv. deliveryOrderId).
Name
salesOrderId
Type
string
Description
ID van de gekoppelde verkooporder.
Name
status
Type
string
Description
Status: draft, shipped, delivered.
Name
shipDate
Type
timestamp
Description
Verzenddatum.
Name
trackingNumber
Type
string
Description
Track & trace nummer.
Name
carrier
Type
string
Description
Vervoerder.
Name
notes
Type
string
Description
Opmerkingen.
Name
lines
Type
array
Description
Verzendregels met productEan, quantity en salesOrderLineId.
Name
inserted
Type
timestamp
Description
Aanmaakdatum.
Name
updated
Type
timestamp
Description
Laatste wijzigingsdatum.

GET/v1/shipments

List all shipments

Haal een gepagineerde lijst van verzendingen op.

Optional attributes

Name
take
Type
integer
Description
Aantal per pagina (standaard 10).
Name
skip
Type
integer
Description
Aantal over te slaan.
Name
include
Type
string
Description
Relaties: lines, salesOrder.

Request

GET

/v1/shipments

curl -G https://api.example.nl/v1/shipments \
  -H "Authorization: Bearer {token}" \
  -d take=10 \
  -d include=lines,salesOrder

Response

[
  {
    "id": "clx...",
    "number": "SH-001",
    "salesOrderId": "clx...",
    "status": "shipped",
    "shipDate": "2026-03-25T08:00:00.000Z",
    "trackingNumber": "3SPOST1234567",
    "carrier": "PostNL",
    "lines": [
      {
        "productEan": "9789493113862",
        "quantity": 30,
        "product": {
          "name": "POLARIS nask1 leerwerkboek vmbo-basis 3 deel A"
        }
      }
    ],
    "_count": {
      "lines": 1
    }
  }
]

POST/v1/shipments

Create a shipment

Maak een nieuwe verzending aan voor een verkooporder.

Required attributes

Name
number
Type
string
Description
Uniek verzendnummer.
Name
salesOrderId
Type
string
Description
ID van de verkooporder.

Optional attributes

Name
lines
Type
array
Description
Verzendregels met productEan, quantity, salesOrderLineId.
Name
status
Type
string
Description
Initiële status (standaard draft).
Name
shipDate
Type
timestamp
Description
Verzenddatum.
Name
trackingNumber
Type
string
Description
Track & trace nummer.
Name
carrier
Type
string
Description
Vervoerder.

Request

POST

/v1/shipments

curl https://api.example.nl/v1/shipments \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "SH-001",
    "salesOrderId": "clx...",
    "carrier": "PostNL",
    "lines": [
      {
        "productEan": "9789493113862",
        "salesOrderLineId": "clx...",
        "quantity": 30
      }
    ]
  }'

Response

{
  "id": "clx...",
  "number": "SH-001",
  "salesOrderId": "clx...",
  "status": "draft",
  "carrier": "PostNL",
  "lines": [
    {
      "productEan": "9789493113862",
      "quantity": 30
    }
  ]
}

GET/v1/shipments/:id

Retrieve a shipment

Haal een enkele verzending op met de gekoppelde order en verzendregels.

Request

GET

/v1/shipments/clx...

curl https://api.example.nl/v1/shipments/clx... \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "clx...",
  "number": "SH-001",
  "status": "shipped",
  "salesOrder": {
    "id": "clx...",
    "number": "SO-106021"
  },
  "lines": [
    {
      "productEan": "9789493113862",
      "quantity": 30,
      "product": {
        "name": "POLARIS nask1 leerwerkboek vmbo-basis 3 deel A"
      }
    }
  ]
}

PUT/v1/shipments/:id

Update a shipment

Werk een verzending bij, bijvoorbeeld om de status te wijzigen of een track & trace toe te voegen.

Optional attributes

Name
status
Type
string
Description
Nieuwe status.
Name
shipDate
Type
timestamp
Description
Verzenddatum.
Name
trackingNumber
Type
string
Description
Track & trace nummer.
Name
carrier
Type
string
Description
Vervoerder.

Request

PUT

/v1/shipments/clx...

curl -X PUT https://api.example.nl/v1/shipments/clx... \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"status": "shipped", "trackingNumber": "3SPOST1234567"}'

Response

{
  "id": "clx...",
  "number": "SH-001",
  "status": "shipped",
  "trackingNumber": "3SPOST1234567",
  "updated": "2026-03-25T08:00:00.000Z"
}

DELETE/v1/shipments/:id

Delete a shipment

Verwijder een verzending permanent, inclusief alle verzendregels.

Request

DELETE

/v1/shipments/clx...

curl -X DELETE https://api.example.nl/v1/shipments/clx... \
  -H "Authorization: Bearer {token}"