Orders-API2026-11Preview

Zendingen

Een pakket onderweg naar je klant. De tracking gaat terug naar de winkel waar de bestelling vandaan kwam, zodat je klant van jou hoort, niet van ons.

order.shipped wordt verstuurd wanneer een zending wordt aangemaakt, met de tracking.

Endpoints

GET/v1/shipmentsZendingen opvragen
GET/v1/shipments/{id}Een zending ophalen
GET/v1/shipments/{id}/trackingTrackingevents ophalen

Het Shipment-object

idstring: Begint met shp_.
order, fulfillment_orderstring: Wat hij bevat.
lanestring: saver of fast.
carrier, tracking_number, tracking_urlstring: Tracking, klaar voor je klant.
weight_ginteger: Wat het pakket woog toen we het inpakten.
shipping_chargedmoney: Verzending, verwerkingskosten en belasting voor het gewogen pakket, in CN¥: wat je saldo betaalde.
pushed_to_channelboolean: Of de winkel waar de bestelling vandaan kwam de tracking heeft. Shopify mailt die dan naar je klant.
statusstring: in_transit, out_for_delivery, delivered, of exception (vastgehouden, geretourneerd, verloren).
shipped_at, delivered_atstring|null: Wanneer het bij ons vertrok, en wanneer de vervoerder meldt dat het is bezorgd.

shipment

{
  "id": "shp_5r8w",
  "order": "ord_3n7q",
  "fulfillment_order": "fo_7k2m",
  "lane": "saver",
  "carrier": "YunExpress",
  "tracking_number": "YT2630812345678",
  "tracking_url": "https://t.17track.net/en#nums=YT2630812345678",
  "weight_g": 176,
  "shipping_charged": { "amount": "134.52", "currency": "CNY" },
  "pushed_to_channel": true,
  "status": "in_transit",
  "shipped_at": "2026-11-03T06:00:00Z",
  "delivered_at": null
}

Zendingen opvragen

GET/v1/shipments

Nieuwste eerst. Filter op status om te vinden wat jouw actie nodig heeft.

Scopeorders:read

Queryparameters

statusstring: Optioneel.
orderstring: Optioneel. Een bestellings-id.
shipped_sincestring: Optioneel. Een tijdstip.
limit, cursor: Pagination

curl "https://www.ninjabuy.com/api/v1/shipments?status=exception" \
  -H "Authorization: Bearer $NINJABUY_API_KEY" \
  -H "NinjaBuy-Version: 2026-11"

Response 200

HTTP/2 200 OK

{
  "data": [
    {
      "id": "shp_5q1d",
      "order": "ord_3m2b",
      "tracking_number": "YT2630811190042",
      "status": "exception"
    }
  ],
  "has_more": false,
  "cursor": null
}

Een zending ophalen

GET/v1/shipments/{id}

Eén pakket, met tracking.

Scopeorders:read

Padparameters

idstringverplicht: De id van de zending.

Fouten

Status	Type	Wanneer
404	not-found	Deze zending bestaat niet op dit account.

curl "https://www.ninjabuy.com/api/v1/shipments/shp_5r8w" \
  -H "Authorization: Bearer $NINJABUY_API_KEY" \
  -H "NinjaBuy-Version: 2026-11"

Response 200

HTTP/2 200 OK

{
  "id": "shp_5r8w",
  "order": "ord_3n7q",
  "fulfillment_order": "fo_7k2m",
  "lane": "saver",
  "carrier": "YunExpress",
  "tracking_number": "YT2630812345678",
  "tracking_url": "https://t.17track.net/en#nums=YT2630812345678",
  "weight_g": 176,
  "shipping_charged": { "amount": "134.52", "currency": "CNY" },
  "pushed_to_channel": true,
  "status": "in_transit",
  "shipped_at": "2026-11-03T06:00:00Z",
  "delivered_at": null
}

Trackingevents ophalen

GET/v1/shipments/{id}/tracking

De scans van de vervoerder, oudste eerst, in het Engels.

Scopeorders:read

Padparameters

idstringverplicht: De id van de zending.

Fouten

Status	Type	Wanneer
404	not-found	Deze zending bestaat niet op dit account.

curl "https://www.ninjabuy.com/api/v1/shipments/shp_5r8w/tracking" \
  -H "Authorization: Bearer $NINJABUY_API_KEY" \
  -H "NinjaBuy-Version: 2026-11"

Response 200

HTTP/2 200 OK

{
  "shipment": "shp_5r8w",
  "status": "in_transit",
  "events": [
    {
      "at": "2026-11-03T06:00:00Z",
      "where": "Shenzhen, CN",
      "status": "in_transit",
      "description": "Left the NinjaBuy warehouse"
    },
    {
      "at": "2026-11-05T22:10:00Z",
      "where": "Shenzhen, CN",
      "status": "in_transit",
      "description": "Departed the origin country"
    },
    {
      "at": "2026-11-09T19:40:00Z",
      "where": "Los Angeles, US",
      "status": "in_transit",
      "description": "Arrived in the destination country"
    }
  ]
}