配送業者一覧取得

利用可能な配送業者を、表示順で取得します。

取得した id は、注文の発送情報を登録するときに delivery_company_id として指定できます。 決済手段によって利用できる配送業者が異なり、発送情報の登録時に判定されます。 取得によるデータの変更はありません。

GET /api/delivery_companies
スコープ orders.read

リクエスト例

curl
curl -X GET "https://apiv2.thebase.com/api/delivery_companies" \
  -H "Authorization: Bearer <your-token>"

レスポンス

200 取得成功。利用可能な配送業者を表示順で返します。

200 のレスポンスボディ(application/json):

配列。各要素: DeliveryCompany

  • idinteger必須≥ 0
    配送業者 ID。注文の発送情報を登録するときに delivery_company_id として指定できます。
  • namestring必須
    配送業者の表示名

エラー

エラーは application/problem+json の Problem 形式で返します。 認証・スコープ・予期しない内部エラーなど、すべてのエンドポイントに共通のエラーと 構造・判別方法は エラーレスポンス を参照してください。

このエンドポイントが返すその他のエラーはありません。