取引先一覧取得

GET

/customers

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/customers?limit=10&page=1&sort=updatedAt%3Adesc';
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/customers?limit=10&page=1&sort=updatedAt%3Adesc' \
  --header 'Authorization: Bearer <token>'

取引先情報の一覧を取得します。

Authorizations

AppAccessToken
ec-b2b.customers:read

Parameters

Query Parameters

limit

integer

default: 10 >= 1 <= 100

取得件数

page

integer

default: 1 >= 1

ページ

sort

string

default: updatedAt:desc

Allowed values: updatedAt updatedAt:desc

ソート

updatedAt: 更新日時

Example

updatedAt:desc

Responses

200

取得成功

application/json

Array

CustomerResponse

object

取引先ID

string format: uuid

statusCode

ステータス

1: 仮会員
2: メルマガ会員
3: 本会員
4: 否認済

integer

Allowed values: 1 2 3 4

registrationStatus

登録状況

1: 未承認
2: 承認
3: 否認
4: 管理者登録

integer

Allowed values: 1 2 3 4

companyName

会社名

string

<= 255 characters

lastName

名前(姓)

string

<= 50 characters

firstName

名前(名)

string

<= 50 characters

lastNameFurigana

名前フリガナ(姓)

string

<= 50 characters

firstNameFurigana

名前フリガナ(名)

string

<= 50 characters

countryCode

CountryCode

国コード（ISO 3166-1 numeric）

392: 日本

国コード一覧（ISO 3166-1 numeric）

integer

zipCode

郵便番号

string

<= 8 characters

prefectureCode

PrefectureCode

都道府県コード（JIS X 0401）

More information

integer

>= 1 <= 47

address01

住所1

string

<= 255 characters

address02

住所2

string

nullable <= 255 characters

address03

住所3

string

nullable <= 255 characters

telephoneNumber

電話番号(ハイフン無し)

string

<= 13 characters

faxNumber

FAX番号(ハイフン無し)

string

<= 13 characters

email

メールアドレス

string format: email

<= 255 characters

genderCode

性別

1: 男性
2: 女性
3: 不明

integer

Allowed values: 1 2 3

birthOn

生年月日

string format: date

nullable

invitationAt

招待日時[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

registrationAt

会員登録日時[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

note

備考

string

nullable <= 5000 characters

isLineLink

LINE ID連携

0: 未連携
1: 連携済

integer

Allowed values: 0 1

pricingMethodCode

ロット価格指定

1: 指値
2: 掛け率

integer

Allowed values: 1 2

defaultPriceRate

ロット価格掛け率

integer

regularShippingFeeNoTax

送料条件-通常送料（税抜）

string

regularShippingFeeTaxRate

送料条件-通常送料の税率

integer

campaignShippingFeeCondition

送料条件-キャンペーン送料条件

integer

nullable

campaignShippingFeeNoTax

送料条件-キャンペーン送料（税抜）

string

nullable

campaignShippingFeeTaxRate

送料条件-キャンペーン送料の税率

integer

updatedAt

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

Examples

default

[
  {
    "id": "12345678-1234-1234-1234-1234567890ab",
    "statusCode": 3,
    "registrationStatus": 4,
    "companyName": "株式会社スマレジ",
    "lastName": "すまれじ",
    "firstName": "太郎",
    "lastNameFurigana": "スマレジ",
    "firstNameFurigana": "タロウ",
    "countryCode": 392,
    "zipCode": "5555555",
    "prefectureCode": 13,
    "address01": "大阪市中央区",
    "address02": "大繁盛物産ビル 65F",
    "address03": null,
    "telephoneNumber": "00011112222",
    "faxNumber": "00033334444",
    "email": "taro@example.com",
    "genderCode": 2,
    "birthOn": "2024-05-05",
    "invitationAt": "2025-06-02T03:03:33+09:00",
    "registrationAt": "2025-06-02T03:03:33+09:00",
    "note": "備考用のメモです",
    "isLineLink": 0,
    "pricingMethodCode": 1,
    "defaultPriceRate": 0,
    "regularShippingFeeNoTax": "0",
    "regularShippingFeeTaxRate": 10,
    "campaignShippingFeeCondition": null,
    "campaignShippingFeeNoTax": null,
    "campaignShippingFeeTaxRate": 10,
    "updatedAt": "2025-06-09T14:15:40+09:00"
  },
  {
    "id": "12345678-1234-1234-1234-1234567890cd",
    "statusCode": 3,
    "registrationStatus": 4,
    "companyName": "株式会社スマレジ",
    "lastName": "すまれじ",
    "firstName": "花子",
    "lastNameFurigana": "スマレジ",
    "firstNameFurigana": "ハナコ",
    "countryCode": 392,
    "zipCode": "1111111",
    "prefectureCode": 13,
    "address01": "大阪市中央区本町",
    "address02": null,
    "address03": null,
    "telephoneNumber": "00044445555",
    "faxNumber": "00066667777",
    "email": "hanako@example.com",
    "genderCode": 2,
    "birthOn": "2024-05-05",
    "invitationAt": "2025-06-02T03:03:33+09:00",
    "registrationAt": "2025-06-02T03:03:33+09:00",
    "note": null,
    "isLineLink": 0,
    "pricingMethodCode": 1,
    "defaultPriceRate": 0,
    "regularShippingFeeNoTax": "0",
    "regularShippingFeeTaxRate": 10,
    "campaignShippingFeeCondition": null,
    "campaignShippingFeeNoTax": null,
    "campaignShippingFeeTaxRate": 10,
    "updatedAt": "2025-06-09T14:15:40+09:00"
  }
]

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
}