配送情報の一覧

GET /shipments

配送情報の一覧を取得するには、/api/shipmentsエンドポイントにGETリクエストを送信します。

リクエスト：ヘッダー

Name	Value
Content-Type	application/json
Authorization	Basic <認証情報>

認証情報について

認証情報は、ユーザーのEメールアドレスとAPIキーをコロンで連結したものをBase64エンコードしたものです。

クエリ パラメータ

Name	Type	説明	デフォルト値
page	integer	ページ番号	1
items_per_page	integer	1ページあたりの表示数	10

レスポンス

200

{
  "shipments": [
    {
      "shipment_id": "1",
      "shipment_timestamp": "1578295969",
      "comments": "コメント",
      "status": "P",
      "order_id": "97",
      "order_timestamp": "1572431735",
      "s_firstname": "George",
      "s_lastname": "Nills",
      "company": "",
      "user_id": "3",
      "shipping_id": "12",
      "shipping": "ゆうパック",
      "tracking_number": "1234",
      "carrier": "usps",
      "products": {
        "4163016541": "1"
      },
      "group_key": 0,
      "carrier_info": {
        "name": "USPS",
        "tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1234"
      },
      "one_full": false
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "advanced_info": true,
    "sort_order": "desc",
    "sort_by": "id",
    "sort_order_rev": "asc",
    "total_items": "1"
  }
}

400