コンテンツにスキップ

配送先取得

GET
/recipient_addresses/{recipient_address_id}
curl --request GET \
--url https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/recipient_addresses/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'

配送先情報を取得します。

recipient_address_id
required
string format: uuid

配送先ID

取得成功

Media typeapplication/json
RecipientAddressResponse
object
id

配送先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
Exampledefault
{
"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"
}

指定されたIDのリソースが見つからない場合

Media typeapplication/json
object
type
required
string
title
required
string
detail
string
status
integer
Example
{
"type": "about:blank",
"title": "Not Found",
"detail": "指定されたIDのリソースが見つかりません",
"status": 404
}