GET /v1/delivery_companies

scope

read_items write_shipping

リクエストパラメーター

パラメーターはありません。

レスポンスの例

{
  "data": [
    {
      "id": "string",
      "name": "ヤマト運輸",
      "url": "string"
    }
  ]
}

解説

POST /v1/orders/{id}/trackings の carrier_id に指定できる配送会社を一覧取得します。ショップ固有の業者に加え、全ショップ共通の業者も含みます。出荷連携だけを行うクライアント向けに write_shipping でも参照できます。

エラーレスポンスの例

{
  "error": {
    "code": "insufficient_scope",
    "message": "requires scope 'read_items'",
    "request_id": "req_01H..."
  }
}

返しうるエラー: 401 / 403