配送先登録

POST

/recipient_addresses

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/recipient_addresses';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"customerId":"12345678-1234-1234-1234-1234567890ab","identification":"ADDR-001","status":1,"companyName":"株式会社スマレジ","department":"営業部","lastName":"すまれじ","firstName":"太郎","lastNameFurigana":"スマレジ","firstNameFurigana":"タロウ","countryCode":392,"zipCode":"5555555","prefectureCode":13,"address01":"大阪市中央区","address02":"大繁盛物産ビル 65F","address03":null,"telephoneNumber":"00011112222","faxNumber":"00033334444","email":"sample@example.com","displayName":"本社営業部"}'
};

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

curl --request POST \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/recipient_addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "customerId": "12345678-1234-1234-1234-1234567890ab", "identification": "ADDR-001", "status": 1, "companyName": "株式会社スマレジ", "department": "営業部", "lastName": "すまれじ", "firstName": "太郎", "lastNameFurigana": "スマレジ", "firstNameFurigana": "タロウ", "countryCode": 392, "zipCode": "5555555", "prefectureCode": 13, "address01": "大阪市中央区", "address02": "大繁盛物産ビル 65F", "address03": null, "telephoneNumber": "00011112222", "faxNumber": "00033334444", "email": "sample@example.com", "displayName": "本社営業部" }'

配送先情報を登録します。

Authorizations

AppAccessToken
ec-b2b.recipient-addresses:write

Request Body^required

application/json

RecipientAddressRequest

companyNameまたはlastName・firstNameのいずれかは必須です。 lastName・firstNameを指定する場合は両方をセットで指定してください。

object

identification

コード

string

nullable <= 50 characters

status

ステータス

0: 無効
1: 有効

integer

default: 1

Allowed values: 0 1

companyName

会社名

string

nullable <= 255 characters

department

部署名

string

nullable <= 255 characters

lastName

名前(姓)

string

nullable <= 50 characters

firstName

名前(名)

string

nullable <= 50 characters

lastNameFurigana

名前フリガナ(姓)

string

nullable <= 50 characters

firstNameFurigana

名前フリガナ(名)

string

nullable <= 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

nullable <= 13 characters

faxNumber

FAX番号(ハイフン無し)

string

nullable <= 13 characters

email

メールアドレス

string format: email

nullable <= 255 characters

displayName

表示名称

string

nullable <= 50 characters

customerId

required

取引先ID

string format: uuid

Any of:

会社名で指定
氏名で指定

会社名で指定

One of:

氏名を指定しない
姓名を両方指定

氏名を指定しない

Any of:

姓（lastName）を含む
名（firstName）を含む

姓（lastName）を含む

Examples

default

{
  "customerId": "12345678-1234-1234-1234-1234567890ab",
  "identification": "ADDR-001",
  "status": 1,
  "companyName": "株式会社スマレジ",
  "department": "営業部",
  "lastName": "すまれじ",
  "firstName": "太郎",
  "lastNameFurigana": "スマレジ",
  "firstNameFurigana": "タロウ",
  "countryCode": 392,
  "zipCode": "5555555",
  "prefectureCode": 13,
  "address01": "大阪市中央区",
  "address02": "大繁盛物産ビル 65F",
  "address03": null,
  "telephoneNumber": "00011112222",
  "faxNumber": "00033334444",
  "email": "sample@example.com",
  "displayName": "本社営業部"
}

Responses

201

登録成功

application/json

RecipientAddressResponse

object

配送先ID

string format: uuid

customerId

取引先ID

string format: uuid

identification

コード

string

nullable <= 50 characters

status

ステータス

0: 無効
1: 有効

integer

default: 1

Allowed values: 0 1

companyName

会社名

string

nullable <= 255 characters

department

部署名

string

nullable <= 255 characters

lastName

名前(姓)

string

nullable <= 50 characters

firstName

名前(名)

string

nullable <= 50 characters

lastNameFurigana

名前フリガナ(姓)

string

nullable <= 50 characters

firstNameFurigana

名前フリガナ(名)

string

nullable <= 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

nullable <= 13 characters

faxNumber

FAX番号(ハイフン無し)

string

nullable <= 13 characters

email

メールアドレス

string format: email

nullable <= 255 characters

displayName

表示名称

string

nullable <= 50 characters

updatedAt

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

string format: date-time

Examples

default

{
  "id": "cccccccc-1234-1234-1234-1234567890ab",
  "customerId": "12345678-1234-1234-1234-1234567890ab",
  "identification": "ADDR-001",
  "status": 1,
  "companyName": "株式会社スマレジ",
  "department": "営業部",
  "lastName": "すまれじ",
  "firstName": "太郎",
  "lastNameFurigana": "スマレジ",
  "firstNameFurigana": "タロウ",
  "countryCode": 392,
  "zipCode": "5555555",
  "prefectureCode": 13,
  "address01": "大阪市中央区",
  "address02": "大繁盛物産ビル 65F",
  "address03": null,
  "telephoneNumber": "00011112222",
  "faxNumber": "00033334444",
  "email": "sample@example.com",
  "displayName": "本社営業部",
  "updatedAt": "2025-06-09T14:15:40+09:00"
}

400

入力チェックエラーの場合
指定された都道府県コードが不正な場合
指定された国コードが不正な場合
メールアドレスの形式が不正な場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[lastName]は50文字以下で指定してください。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[prefectureCode]は1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47に該当する値を指定してください。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[countryCode]は392, 352, 372, 31, 4, 840, 850, 16, 784, 12, 32, 533, 8, 51, 660, 24, 28, 20, 887, 826, 86, 92, 376, 380, 368, 364, 356, 360, 876, 800, 804, 860, 858, 218, 818, 233, 748, 231, 232, 222, 36, 40, 248, 512, 528, 288, 132, 831, 328, 398, 634, 581, 124, 266, 120, 270, 116, 807, 580, 324, 624, 196, 192, 531, 300, 296, 417, 320, 312, 316, 414, 184, 304, 162, 308, 191, 136, 404, 384, 166, 188, 174, 170, 178, 180, 682, 239, 882, 678, 652, 894, 666, 674, 663, 694, 262, 292, 832, 388, 268, 760, 702, 534, 716, 756, 752, 729, 744, 724, 740, 144, 703, 705, 690, 226, 686, 688, 659, 670, 654, 662, 706, 90, 796, 764, 410, 158, 762, 834, 203, 148, 140, 156, 788, 408, 152, 798, 208, 276, 768, 772, 214, 212, 780, 795, 792, 776, 566, 520, 516, 10, 570, 558, 562, 732, 540, 554, 524, 574, 578, 334, 48, 332, 586, 336, 591, 548, 44, 598, 60, 585, 600, 52, 275, 348, 50, 626, 612, 242, 608, 246, 64, 74, 630, 234, 238, 76, 250, 254, 258, 260, 100, 854, 96, 108, 704, 204, 862, 112, 84, 604, 56, 616, 70, 72, 535, 68, 620, 344, 340, 584, 446, 450, 175, 454, 466, 470, 474, 458, 833, 583, 710, 728, 104, 484, 480, 478, 508, 492, 462, 498, 504, 496, 499, 500, 400, 418, 428, 440, 434, 438, 430, 642, 442, 646, 426, 422, 638, 643に該当する値を指定してください。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[email]は有効なメールアドレスを指定してください。",
  "status": 400
}

配送先登録

Authorizations

Request Bodyrequired

Examples

Responses

201

Examples

400

Examples

Request Body^required