配送業者一覧取得

GET

/delivery_companies

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/delivery_companies?limit=10&page=1&name=%E3%83%A4%E3%83%9E%E3%83%88%E9%81%8B%E8%BC%B8&code=10' \
  --header 'Authorization: Bearer <token>'

• サンドボックス
• 本番

配送業者の一覧を取得します。

Authorizations

• AppAccessToken
  ec-b2b.delivery-companies:read

Parameters

Query Parameters

limit

integer

default: 10 >= 1 <= 100

取得件数

page

integer

default: 1 >= 1

ページ

name

string

<= 50 characters

名前で絞り込み

Example

ヤマト運輸

code

integer

配送業者コードで絞り込み

Example

10

Responses

200

取得成功

Media typeapplication/json

Array

DeliveryCompanyResponse

object

id

配送業者ID

string format: uuid

name

名前

string

<= 50 characters

code

配送業者コード

integer

Examples

Exampledefault

[
  {
    "id": "12345678-1234-1234-1234-1234567890ab",
    "name": "ヤマト運輸",
    "code": 10
  },
  {
    "id": "12345678-1234-1234-1234-1234567890cd",
    "name": "日本郵便",
    "code": 20
  },
  {
    "id": "12345678-1234-1234-1234-1234567890ef",
    "name": "佐川急便",
    "code": 30
  },
  {
    "id": "12345678-1234-1234-1234-1234567890gh",
    "name": "福山通運",
    "code": 40
  },
  {
    "id": "12345678-1234-1234-1234-1234567890ij",
    "name": "西濃運輸",
    "code": 50
  }
]

Headers

Link

string

<前ページURI>; rel="prev", <次ページURI>; rel="next"

400

• 入力チェックエラーの場合

Media typeapplication/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[limit]は100以下の数字を指定してください。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[page]は1以上の数字を指定してください。",
  "status": 400
}