配送方法一覧取得

GET

/delivery_methods

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/delivery_methods?limit=10&page=1&name=%E8%87%AA%E7%A4%BE%E9%85%8D%E9%80%81&delivery_code=10';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/delivery_methods?limit=10&page=1&name=%E8%87%AA%E7%A4%BE%E9%85%8D%E9%80%81&delivery_code=10' \
  --header 'Authorization: Bearer <token>'

配送方法の一覧を取得します。

Authorizations

AppAccessToken
ec-b2b.delivery-methods:read

Parameters

Query Parameters

limit

integer

default: 10 >= 1 <= 100

取得件数

page

integer

default: 1 >= 1

ページ

name

string

<= 50 characters

名前で絞り込み

Example

自社配送

delivery_code

integer

配送コードで絞り込み

Example

Responses

200

取得成功

application/json

Array

DeliveryMethodResponse

object

配送方法ID

string format: uuid

name

名前

string

<= 50 characters

deliveryCode

配送コード

integer

deliveryMethodCategoryCode

配送方法種別

1: 自社配送
2: メーカー直送
3: 店舗受け取り
4: その他

integer

Allowed values: 1 2 3 4

isEnabled

有効フラグ

true: 有効
false: 無効

boolean

Examples

default

[
  {
    "id": "12345678-1234-1234-1234-1234567890ab",
    "name": "自社配送",
    "deliveryCode": 10,
    "deliveryMethodCategoryCode": 1,
    "isEnabled": true
  },
  {
    "id": "12345678-1234-1234-1234-1234567890cd",
    "name": "ヤマト運輸",
    "deliveryCode": 20,
    "deliveryMethodCategoryCode": 4,
    "isEnabled": true
  },
  {
    "id": "12345678-1234-1234-1234-1234567890ef",
    "name": "福山通運",
    "deliveryCode": 30,
    "deliveryMethodCategoryCode": 4,
    "isEnabled": true
  }
]

Headers

Link

string

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

400

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

application/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
}