Orders-API2026-11Vorschau

Sendungen

Ein Paket auf dem Weg zu deinem Kunden. Die Sendungsverfolgung geht an den Shop zurück, aus dem die Bestellung kam, damit dein Kunde von dir hört, nicht von uns.

order.shipped wird ausgelöst, wenn eine Sendung angelegt wird, mit ihrer Sendungsverfolgung.

Endpunkte

GET/v1/shipmentsSendungen auflisten
GET/v1/shipments/{id}Eine Sendung abrufen
GET/v1/shipments/{id}/trackingTracking-Events abrufen

Das Shipment-Objekt

idstring: Beginnt mit shp_.
order, fulfillment_orderstring: Was es enthält.
lanestring: saver oder fast.
carrier, tracking_number, tracking_urlstring: Sendungsverfolgung, bereit für deinen Kunden.
weight_ginteger: Was das Paket beim Packen gewogen hat.
shipping_chargedmoney: Versand, Bearbeitungsgebühr und Steuer für das gewogene Paket, in CN¥: was dein Guthaben bezahlt hat.
pushed_to_channelboolean: Ob der Shop, aus dem die Bestellung kam, die Sendungsverfolgung hat. Shopify schickt sie dann per E-Mail an deinen Kunden.
statusstring: in_transit, out_for_delivery, delivered oder exception (zurückgehalten, zurückgeschickt, verloren).
shipped_at, delivered_atstring|null: Wann es uns verlassen hat und wann der Versanddienstleister die Zustellung meldet.

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
}

Sendungen auflisten

GET/v1/shipments

Neueste zuerst. Filtere nach Status, um die zu finden, die dich brauchen.

Scopeorders:read

Query-Parameter

statusstring: Optional.
orderstring: Optional. Eine Bestell-ID.
shipped_sincestring: Optional. Ein Zeitpunkt.
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
}

Eine Sendung abrufen

GET/v1/shipments/{id}

Ein Paket, mit seiner Sendungsverfolgung.

Scopeorders:read

Pfadparameter

idstringerforderlich: Die ID der Sendung.

Fehler

Status	Typ	Wann
404	not-found	Keine solche Sendung in diesem Konto.

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
}

Tracking-Events abrufen

GET/v1/shipments/{id}/tracking

Die Scans des Versanddienstleisters, älteste zuerst, auf Englisch.

Scopeorders:read

Pfadparameter

idstringerforderlich: Die ID der Sendung.

Fehler

Status	Typ	Wann
404	not-found	Keine solche Sendung in diesem Konto.

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"
    }
  ]
}