注文API2026-11プレビュー

発送注文

お客様へ配送中の荷物。追跡情報は注文元のストアに戻るので、お客様には当社ではなくあなたから連絡が届きます。

order.shippedは発送が作成されたときに追跡情報付きで発生します。

エンドポイント

GET/v1/shipments発送一覧
GET/v1/shipments/{id}発送を取得
GET/v1/shipments/{id}/tracking追跡イベントを取得

Shipmentオブジェクト

idstring: shp_ で始まります。
order, fulfillment_orderstring: 含まれるもの。
lanestring: saver または fast。
carrier, tracking_number, tracking_urlstring: 追跡情報、お客様に届ける準備完了。
weight_ginteger: 梱包時の荷物の重さ。
shipping_chargedmoney: 計量した荷物の送料、出荷作業料、税金（CN¥）：残高から支払った額。
pushed_to_channelboolean: 注文元のストアに追跡情報があるかどうか。その後Shopifyがお客様にメールします。
statusstring: in_transit、out_for_delivery、delivered、または exception（保留、返送、紛失）。
shipped_at, delivered_atstring|null: 当社を出た日時と、配送業者が到着と報告した日時。

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
}

発送一覧

GET/v1/shipments

新しい順。ステータスで絞り込むと、対応が必要なものが見つかります。

スコープorders:read

クエリパラメータ

statusstring: 任意。
orderstring: 任意。注文ID。
shipped_sincestring: 任意。日時。
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
}

発送を取得

GET/v1/shipments/{id}

荷物1個とその追跡情報。

スコープorders:read

パスパラメータ

idstring必須: 発送のID。

エラー

ステータス	タイプ	時期
404	not-found	このアカウントにその発送はありません。

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
}

追跡イベントを取得

GET/v1/shipments/{id}/tracking

配送業者のスキャン（古い順、英語）。

スコープorders:read

パスパラメータ

idstring必須: 発送のID。

エラー

ステータス	タイプ	時期
404	not-found	このアカウントにその発送はありません。

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