DEXTRE Merchant API (1.0.0)

Download OpenAPI specification:Download

DEXTRE Merchant API サポート: info@oned-technologies.com

DEXTRE Merchant APIのご利用について

DEXTRE Merchant APIは、マーチャント(メーカー)向けのAPIです。マーチャント(メーカー)をお持ちの方のみ、ご利用いただけます。ご利用をご希望の方は、マニュアルに記載の手順でご利用ください。

認証・認可

DEXTRE Merchant APIは、APIキーによる認証を行います。 API利用申請をいただいたのちに、機能がアンロックされ、メーカーアプリの設定画面からAPIキーを発行いただけます。 APIキーは、リクエストヘッダーの X-Merchant-API-Key に設定してください。

APIリクエスト制限

DEXTRE Merchant APIでは、以下のリクエスト制限があります。制限を超過した場合は、 429 Too Many Requests が返却されます。

Merchant(マーチャント(メーカー))ごとに 300リクエスト / 分

＊今後、プランごとに制限の上限を変更する場合がございます。

Errors

APIでエラーが発生した場合、下記のステータスコードが返却されます。

ステータスコード	原因
400	不正リクエスト
401	認証エラー
402	有効期限が超過しているなど、API利用料金の支払いが必要な状態
403	認可エラー
404	リソースが見つからない
422	処理できないリクエスト
429	リクエスト制限超過
500	サーバーエラー
503	メンテナンスやサーバーダウンなどにより、サービス利用不可

また、エラーレスポンスは下記のJSON形式で返却されます。

{
  "error": {
    "statusCode": 403,
    "messages": [
      "Forbidden"
    ]
  }
}

ドキュメント更新予定

在庫数量更新通知などのWebhookの仕様を公開予定です。(見通しが立ち次第、正確な日程を記載いたします。)
順次、各スキーマの各プロパティの説明を追記してまいります。

基本的な概念について

マーチャント

マーチャント(メーカー)はご契約主体の組織アカウントを指します。(DEXTRE上ではメーカー組織やマーチャント組織と表記されるものです。)
- また、一部マスターデータはマーチャント(メーカー)単位で管理します。
  - 設定する言語、通貨、取引条件など
  - 適用可能な税
  - 在庫ラベル、在庫ロケーション、在庫受注(オーダー)ポリシー

ブランド

ブランドとは、マーチャント(メーカー)に紐づくDEXTREにおける基本となる管理単位です。
- 現行のDEXTREでは、ブランド単位で製品や顧客、カタログ、受注などといった管理を独立させます。

製品について

製品はブランド上で管理され、品番(モデル番号)ごとにユニークになります。
製品は必ず1つ以上のSKUを持つ必要があります。
- SKUは在庫管理単位であり、実際の受注単位です。
- DEXTREにおける製品はSKUを包むための概念となります。
製品登録に際して、言語、通貨、取引条件、SKUテンプレートなどのマスタ情報が必要になります。
製品ではSKUテンプレートを用いて、その製品のSKUの構造を決定します。
SKUテンプレートとは
- SKUテンプレートは、SKUの階層構造を決定するための概念です。
- SKUプロパティから構成され、任意の階層構造を自由に定義いただけます。
  - 「カラー - サイズ」でバリエーションを管理したい場合、「カラー」「サイズ」のSKUプロパティをそれぞれご登録いただき、その二階層から構成されるSKUテンプレートをご登録いただくことで、「カラー - サイズ」構造の製品・SKUをご登録いただけます。
- SKUプロパティとは「カラーマスター」「サイズマスター」などのことを指します。
  - 例えば「カラー」SKUプロパティがあったとして、その子要素となるバリエーション(白色、黒色、赤色など)を自由に定義いただくことが可能です。

補足資料

DEXTRE Merchant API 補足資料

マーチャント

Merchant object
マーチャント(Maker)設定情報を表します。
有効化する言語、通貨、取引条件などの設定を持ちます。

object	string Default: "merchant"
merchantId	string
	Array of objects マーチャントの名称マーチャントで有効化している言語の数だけ設定されます。
countryCode	string マーチャントの所在国コード。 ISO 3166-1 alpha-2形式・大文字で表現します。例: 'JP'
enabledLanguageCodes	Array of strings Items Enum: "ja" "en" "zh" "es" "fr" "de" "it" "ko" "ru" "nl" "pt" マーチャントで有効化している言語コードのリスト。この設定をもとに、製品などを含む様々な名称の言語枠が設定されます。
primaryLanguageCode	string Enum: "ja" "en" "zh" "es" "fr" "de" "it" "ko" "ru" "nl" "pt" マーチャントの主要な言語コード。
enabledCurrencyCodes	Array of strings Items Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" マーチャントで有効化している通貨コードのリスト。この設定をもとに、製品やSKUの価格で利用可能な通貨が設定されます。
primaryCurrencyCode	string Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" マーチャントの主要な通貨コード。
enabledTransactionTermCodes	Array of strings Items Enum: "exw" "fca" "cpt" "cip" "dap" "dpu" "ddp" "fas" "fob" "cfr" "cif" "kakeritsu_transaction" "wholesale_transaction" マーチャントで有効化している取引条件コードのリスト。この設定をもとに、製品やSKUの価格で利用可能な取引条件が設定されます。
primaryTransactionTermCode	string Enum: "exw" "fca" "cpt" "cip" "dap" "dpu" "ddp" "fas" "fob" "cfr" "cif" "kakeritsu_transaction" "wholesale_transaction" マーチャントの主要な取引条件コード。

{"object": "merchant",
"merchantId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"countryCode": "string",
"enabledLanguageCodes": ["ja"
],
"primaryLanguageCode": "ja",
"enabledCurrencyCodes": ["AUD"
],
"primaryCurrencyCode": "AUD",
"enabledTransactionTermCodes": ["exw"
],
"primaryTransactionTermCode": "exw"
}

マーチャント(メーカー)を取得する

Authorizations:

ApiKeyAuth

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"data": {"merchant": {"object": "merchant",
"merchantId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"countryCode": "string",
"enabledLanguageCodes": ["ja"
],
"primaryLanguageCode": "ja",
"enabledCurrencyCodes": ["AUD"
],
"primaryCurrencyCode": "AUD",
"enabledTransactionTermCodes": ["exw"
],
"primaryTransactionTermCode": "exw"
}
}
}

税

Tax object
税情報を表します。

object	string Default: "tax"
taxId	string 税を一意に識別するためのID。主に製品に紐付けて使用します。
code	string 税のコード。例: 'TAX_001'
	Array of objects 税の名前。複数の言語に対応する場合があります。
merchantId	string
countryCode	string 税を適用する国コード。 ISO 3166-1 alpha-2形式・大文字で表現します。例: 'JP'
rate	number [ 0 .. 1 ] 税率。 0から1.0の範囲で値を持ちます。 0.08の場合は8%を表します。
status	string Value: "active"
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "tax",
"taxId": "string",
"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"merchantId": "string",
"countryCode": "string",
"rate": 1,
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

税のリストを取得する

Authorizations:

ApiKeyAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 20 Examples: limit=20 -
cursor	string Cursor to fetch next or previous page (taxId)
direction	string Enum: "next" "previous"
taxIds	string Comma separated ids

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Request samples

cURL

curl -X GET "https://api.dextre.app/v1/merchant/taxes?limit=20"
  -H "X-Merchant-API-Key: YOUR_API_KEY"
  -H "X-Merchant-API-Version: latest"

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"taxes": [{"object": "tax",
"taxId": "string",
"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"merchantId": "string",
"countryCode": "string",
"rate": 1,
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

税を取得する

Authorizations:

ApiKeyAuth

path Parameters

taxId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"tax": {"object": "tax",
"taxId": "string",
"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"merchantId": "string",
"countryCode": "string",
"rate": 1,
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

在庫ラベル

InventoryLabel object
在庫データを構成する在庫ラベル情報を表します。

object	string Default: "inventory_label"
labelId	string
code	string
merchantId	string
type	string Enum: "anticipated_inventory" "actual_inventory" "disposed_inventory" "sold" "production_discontinued" 在庫ラベルのタイプを表します。 anticipated_inventory: 仮在庫 actual_inventory: 実在庫 disposed_inventory: 廃棄在庫 sold: 販売済み production_discontinued: 生産中止
displayName	string 在庫ラベルの表示名を表します。
isSaleable	boolean この在庫ラベルが適用された在庫が販売可能かどうかを表します。 true: 販売可能 false: 販売不可
isDefault	boolean
isUserControlRestricted	boolean この在庫ラベルが適用された在庫がユーザーによる操作を制限されるかどうかを表します。 true: 制限される false: 制限されない主にパートナー在庫用のラベルに設定されます。
status	string Enum: "active" "inactive"
sortKey	integer
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "inventory_label",
"labelId": "string",
"code": "string",
"merchantId": "string",
"type": "anticipated_inventory",
"displayName": "string",
"isSaleable": true,
"isDefault": true,
"isUserControlRestricted": true,
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

在庫ラベルの一覧を取得する

Authorizations:

ApiKeyAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (labelId)
direction	string Enum: "next" "previous"
labelIds	string Comma separated ids
createdAtFrom	string <date-time> 作成日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtToとセットで使用する必要はありません。
createdAtTo	string <date-time> 作成日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtFromとセットで使用する必要はありません。
updatedAtFrom	string <date-time> 更新日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtToとセットで使用する必要はありません。
updatedAtTo	string <date-time> 更新日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtFromとセットで使用する必要はありません。

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"labels": [{"object": "inventory_label",
"labelId": "string",
"code": "string",
"merchantId": "string",
"type": "anticipated_inventory",
"displayName": "string",
"isSaleable": true,
"isDefault": true,
"isUserControlRestricted": true,
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

在庫ラベルを取得する

Authorizations:

ApiKeyAuth

path Parameters

labelId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"label": {"object": "inventory_label",
"labelId": "string",
"code": "string",
"merchantId": "string",
"type": "anticipated_inventory",
"displayName": "string",
"isSaleable": true,
"isDefault": true,
"isUserControlRestricted": true,
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

在庫ロケーション

InventoryLocation object
在庫データを構成する在庫ロケーション情報を表します。

object	string Default: "inventory_location"
locationId	string
code	string
merchantId	string
displayName	string 在庫ロケーションの表示名を表します。
	object 在庫ロケーションの住所情報。
isDefault	boolean
isUserControlRestricted	boolean この在庫ロケーションがユーザーによる操作を制限されるかどうかを表します。 true: 制限される false: 制限されない主にパートナー在庫用のロケーションに設定されます。
status	string Enum: "active" "inactive"
sortKey	integer
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "inventory_location",
"locationId": "string",
"code": "string",
"merchantId": "string",
"displayName": "string",
"address": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"isDefault": true,
"isUserControlRestricted": true,
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

在庫ロケーションのリストを取得する

Authorizations:

ApiKeyAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (locationId)
direction	string Enum: "next" "previous"
locationIds	string Comma separated ids
createdAtFrom	string <date-time> 作成日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtToとセットで使用する必要はありません。
createdAtTo	string <date-time> 作成日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtFromとセットで使用する必要はありません。
updatedAtFrom	string <date-time> 更新日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtToとセットで使用する必要はありません。
updatedAtTo	string <date-time> 更新日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtFromとセットで使用する必要はありません。

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"locations": [{"object": "inventory_location",
"locationId": "string",
"code": "string",
"merchantId": "string",
"displayName": "string",
"address": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"isDefault": true,
"isUserControlRestricted": true,
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

在庫ロケーションを取得する

Authorizations:

ApiKeyAuth

path Parameters

locationId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"location": {"object": "inventory_location",
"locationId": "string",
"code": "string",
"merchantId": "string",
"displayName": "string",
"address": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"isDefault": true,
"isUserControlRestricted": true,
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

在庫受注ポリシー

InventoryOrderPolicy object
在庫受注ポリシー情報を表します。
カタログに紐づけるなどして、そのカタログでの受注時の在庫の引き当てルールなどを設定します。

object	string Default: "inventory_order_policy"
policyId	string
type	string Enum: "inventory_sales" "made_to_order" 在庫受注ポリシーのタイプを表します。 inventory_sales: 在庫販売 made_to_order: 受注生産
sourceInventoryLabelIds	Array of strings typeがinventory_salesの場合に、引き当てる在庫ラベルのIDのリストを表します。
sourceInventoryLocationIds	Array of strings typeがinventory_salesの場合に、引き当てる在庫ロケーションのIDのリストを表します。
destinationInventoryLabelId	string 注文内容確認書が確定した後の移動先の在庫ラベルのIDを表します。
destinationInventoryLocationId	string 注文内容確認書が確定した後の移動先の在庫ロケーションのIDを表します。
backorderDestinationInventoryLabelId	string or null 在庫が不足した場合のバックオーダー時の在庫ラベルのIDを表します。(移動先)
backorderDestinationInventoryLocationId	string or null 在庫が不足した場合のバックオーダー時の在庫ロケーションのIDを表します。(移動先)
status	string Value: "available"
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "inventory_order_policy",
"policyId": "string",
"type": "inventory_sales",
"sourceInventoryLabelIds": ["string"
],
"sourceInventoryLocationIds": ["string"
],
"destinationInventoryLabelId": "string",
"destinationInventoryLocationId": "string",
"backorderDestinationInventoryLabelId": "string",
"backorderDestinationInventoryLocationId": "string",
"status": "available",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

在庫受注ポリシーのリストを取得する

Authorizations:

ApiKeyAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (policyId)
direction	string Enum: "next" "previous"
policyIds	string Comma separated ids
createdAtFrom	string <date-time> 作成日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtToとセットで使用する必要はありません。
createdAtTo	string <date-time> 作成日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtFromとセットで使用する必要はありません。
updatedAtFrom	string <date-time> 更新日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtToとセットで使用する必要はありません。
updatedAtTo	string <date-time> 更新日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtFromとセットで使用する必要はありません。

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"policies": [{"object": "inventory_order_policy",
"policyId": "string",
"type": "inventory_sales",
"sourceInventoryLabelIds": ["string"
],
"sourceInventoryLocationIds": ["string"
],
"destinationInventoryLabelId": "string",
"destinationInventoryLocationId": "string",
"backorderDestinationInventoryLabelId": "string",
"backorderDestinationInventoryLocationId": "string",
"status": "available",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

在庫受注ポリシーを取得する

Authorizations:

ApiKeyAuth

path Parameters

policyId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"policy": {"object": "inventory_order_policy",
"policyId": "string",
"type": "inventory_sales",
"sourceInventoryLabelIds": ["string"
],
"sourceInventoryLocationIds": ["string"
],
"destinationInventoryLabelId": "string",
"destinationInventoryLocationId": "string",
"backorderDestinationInventoryLabelId": "string",
"backorderDestinationInventoryLocationId": "string",
"status": "available",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

ブランド

Brand object
ブランド情報を表します。

object	string Default: "brand"
brandId	string
merchantId	string
	Array of objects ブランドの名称マーチャントで有効化している言語の数だけ設定されます。
	Array of objects ブランドの説明文マーチャントで有効化している言語の数だけ設定されます。
status	string Enum: "active" "inactive" ブランドのステータス active: 有効 inactive: 無効

{"object": "brand",
"brandId": "string",
"merchantId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"localizedDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"status": "active"
}

ブランドのリストを取得する

Authorizations:

ApiKeyAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (brandId)
direction	string Enum: "next" "previous"
brandIds	string Comma separated ids

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"data": {"brands": [{"object": "brand",
"brandId": "string",
"merchantId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"localizedDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"status": "active"
}
]
}
}

ブランドを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"brand": {"object": "brand",
"brandId": "string",
"merchantId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"localizedDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"status": "active"
}
}
}

ブランドを更新する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

status

required

string

Enum: "active" "inactive"

ブランドのステータス
active: 有効
inactive: 無効

Responses

Request samples

Payload

Content type

application/json

{"status": "active"
}

Response samples

Content type

application/json

{"data": {"brand": {"object": "brand",
"brandId": "string",
"merchantId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"localizedDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"status": "active"
}
}
}

カタログ

Catalog object
カタログ情報を表します。
カタログは、展示会の単位であり、カタログごとに注文を受け付けます。

object	string Default: "catalog"
catalogId	string
merchantId	string
brandId	string
code	string or null カタログのコードを表します。ブランド内で一意のコードを設定します。
	Array of objects カタログの名称 Merchantで有効化している言語の数だけ設定されます。
	Array of objects カタログのサブタイトル Merchantで有効化している言語の数だけ設定されます。
	Array of objects カタログの説明文 Merchantで有効化している言語の数だけ設定されます。
	Array of objects カタログの画像
	Array of objects
orderDeadline	string or null <date-time> カタログの注文締め切り日時カタログの注文締め切り日時を設定します。
inventoryOrderPolicyId	string or null カタログの在庫受注ポリシーカタログの在庫受注ポリシーを設定します。
	Array of objects カタログに設定されたカスタム属性
sortKey	integer
status	string Default: "open" Enum: "open" "closed" "limited_access" "draft"
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "catalog",
"catalogId": "string",
"merchantId": "string",
"brandId": "string",
"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"localizedSubTitles": [{"languageCode": "ja",
"text": "string"
}
],
"localizedDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"images": [{"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
],
"videos": [{"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
],
"orderDeadline": "2019-08-24T14:15:22Z",
"inventoryOrderPolicyId": "string",
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"sortKey": 0,
"status": "open",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

カタログのリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (catalogId)
direction	string Enum: "next" "previous"
catalogIds	string Comma separated ids
createdAtFrom	string <date-time> 作成日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtToとセットで使用する必要はありません。
createdAtTo	string <date-time> 作成日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtFromとセットで使用する必要はありません。
updatedAtFrom	string <date-time> 更新日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtToとセットで使用する必要はありません。
updatedAtTo	string <date-time> 更新日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtFromとセットで使用する必要はありません。

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"catalogs": [{"object": "catalog",
"catalogId": "string",
"merchantId": "string",
"brandId": "string",
"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"localizedSubTitles": [{"languageCode": "ja",
"text": "string"
}
],
"localizedDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"images": [{"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
],
"videos": [{"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
],
"orderDeadline": "2019-08-24T14:15:22Z",
"inventoryOrderPolicyId": "string",
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"sortKey": 0,
"status": "open",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

カタログを作成する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

カタログの情報

code required	string
required	Array of objects
	Array of objects
	Array of objects
orderDeadline	string or null <date-time>
inventoryOrderPolicyId	string or null
	Array of objects
status required	string Default: "open" Enum: "open" "closed" "limited_access"

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"localizedSubTitles": [{"languageCode": "ja",
"text": "string"
}
],
"localizedDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"orderDeadline": "2019-08-24T14:15:22Z",
"inventoryOrderPolicyId": "string",
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"status": "open"
}

Response samples

201
400
401
403
429

Content type

application/json

{"data": {"catalog": {"object": "catalog",
"catalogId": "string",
"merchantId": "string",
"brandId": "string",
"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"localizedSubTitles": [{"languageCode": "ja",
"text": "string"
}
],
"localizedDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"images": [{"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
],
"videos": [{"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
],
"orderDeadline": "2019-08-24T14:15:22Z",
"inventoryOrderPolicyId": "string",
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"sortKey": 0,
"status": "open",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

カタログを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
catalogId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"catalog": {"object": "catalog",
"catalogId": "string",
"merchantId": "string",
"brandId": "string",
"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"localizedSubTitles": [{"languageCode": "ja",
"text": "string"
}
],
"localizedDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"images": [{"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
],
"videos": [{"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
],
"orderDeadline": "2019-08-24T14:15:22Z",
"inventoryOrderPolicyId": "string",
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"sortKey": 0,
"status": "open",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

カタログを更新する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
catalogId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

カタログの情報

code	string or null
	Array of objects
	Array of objects
	Array of objects
orderDeadline	string or null <date-time>
inventoryOrderPolicyId	string or null
	Array of objects
status	string Default: "open" Enum: "open" "closed" "limited_access"

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"localizedSubTitles": [{"languageCode": "ja",
"text": "string"
}
],
"localizedDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"orderDeadline": "2019-08-24T14:15:22Z",
"inventoryOrderPolicyId": "string",
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"status": "open"
}

Response samples

200
400
401
403
429

Content type

application/json

{"data": {"catalog": {"object": "catalog",
"catalogId": "string",
"merchantId": "string",
"brandId": "string",
"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"localizedSubTitles": [{"languageCode": "ja",
"text": "string"
}
],
"localizedDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"images": [{"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
],
"videos": [{"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
],
"orderDeadline": "2019-08-24T14:15:22Z",
"inventoryOrderPolicyId": "string",
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"sortKey": 0,
"status": "open",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

カタログを削除する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
catalogId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Responses

Response samples

Content type

application/json

{"data": { }
}

カタログの順序を更新する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

カタログの並び替え情報

catalogIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"catalogIds": ["string"
]
}

Response samples

200
400
401
403
429

Content type

application/json

{"data": {"catalogIds": ["string"
]
}
}

カタログ画像をアップロードする

このAPIでは、Base64エンコードされた画像をアップロードし、対象のカタログに関連付けることができます。

注意事項:

アップロード可能な画像の最大サイズは15MBです。
ただし、アプリケーションでの表示速度を考慮して、可能であれば数十〜数百KB程度に圧縮することを推奨しております。

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
catalogId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

base64Image required	string 画像をBase64エンコードした文字列を指定します。画像のファイル形式は、JPEG、PNG、GIFのいずれかを指定してください。
fileName required	string 画像のファイル名を指定します。画像のファイル名は、拡張子を含むファイル名を指定してください。
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"base64Image": "string",
"fileName": "string",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}

Response samples

Content type

application/json

{"data": {"image": {"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
}
}

カタログにアクセス可能な顧客バイヤーIDを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
catalogId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"catalogStatus": "limited_access",
"accessibleCustomerBuyerIds": ["string"
]
}
}

限定公開カタログのアクセス可能な顧客バイヤーを設定する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
catalogId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

アクセス可能にする顧客バイヤーの情報

customerBuyerIds

required

Array of strings

アクセス可能にする顧客バイヤーID配列

Responses

Request samples

Payload

Content type

application/json

{"customerBuyerIds": ["string"
]
}

Response samples

Content type

application/json

{"data": {"accessibleCustomerBuyerIds": ["string"
]
}
}

限定公開カタログのアクセス可能な顧客バイヤーをリセットする

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
catalogId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

リセット対象の顧客バイヤーの情報

customerBuyerIds

required

Array of strings

リセット対象の顧客バイヤーID配列

Responses

Request samples

Payload

Content type

application/json

{"customerBuyerIds": ["string"
]
}

Response samples

Content type

application/json

{"data": {"accessibleCustomerBuyerIds": ["string"
]
}
}

カタログ製品

CatalogProduct object
カタログに登録された製品を表します。
カタログに登録された製品は、カタログ内での表示順序を表すsortKeyを持ちます。

object	string Default: "catalog_product"
productId	string
merchantId	string
brandId	string
catalogId	string
sortKey	integer
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "catalog_product",
"productId": "string",
"merchantId": "string",
"brandId": "string",
"catalogId": "string",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

カタログ製品のリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
catalogId required	string

query Parameters

cursor	string
limit	integer [ 1 .. 100 ] Default: 30
direction	string Enum: "next" "previous"
productIds	string Comma separated ids
createdAtFrom	string <date-time> 作成日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtToとセットで使用する必要はありません。
createdAtTo	string <date-time> 作成日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtFromとセットで使用する必要はありません。
updatedAtFrom	string <date-time> 更新日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtToとセットで使用する必要はありません。
updatedAtTo	string <date-time> 更新日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtFromとセットで使用する必要はありません。

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"catalogProducts": [{"object": "catalog_product",
"productId": "string",
"merchantId": "string",
"brandId": "string",
"catalogId": "string",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

カタログ製品を作成する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
catalogId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

productId

required

string

Responses

Request samples

Payload

Content type

application/json

{"productId": "string"
}

Response samples

Content type

application/json

{"data": {"catalogProduct": {"object": "catalog_product",
"productId": "string",
"merchantId": "string",
"brandId": "string",
"catalogId": "string",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

カタログ製品を取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
catalogId required	string
productId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"catalogProduct": {"object": "catalog_product",
"productId": "string",
"merchantId": "string",
"brandId": "string",
"catalogId": "string",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

カタログ製品を削除する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
catalogId required	string
productId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Responses

Response samples

Content type

application/json

{"data": { }
}

カタログ製品の順序を更新する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
catalogId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

productIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"productIds": ["string"
]
}

Response samples

Content type

application/json

{"data": {"productIds": ["string"
]
}
}

全てのカタログ製品を更新日順で取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

cursor	string
limit	integer [ 1 .. 100 ] Default: 30
direction	string Enum: "next" "previous"
updatedAtFrom	string <date-time> 更新日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtToとセットで使用する必要はありません。
updatedAtTo	string <date-time> 更新日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtFromとセットで使用する必要はありません。

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"catalogProducts": [{"object": "catalog_product",
"productId": "string",
"merchantId": "string",
"brandId": "string",
"catalogId": "string",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

製品

Product object
製品情報を表します。

object	string Default: "product"
productId	string 製品のID (システム側で生成されるユニークな文字列)
modelNumber	string 製品のモデル番号 (品番) ユニークな値である必要があります。
merchantId	string
brandId	string
hsCode	string 製品のHSコード輸出取引などを行う場合にご登録ください。
	Array of objects 製品の名称マーチャント(メーカー)で有効化している言語の数だけ、ご登録いただく必要があります。
	Array of objects 製品の説明文
	Array of objects 製品の短い説明文 DEXTREバイヤーアプリの製品一覧に表示される短い説明文になります。
renderLocalizedDescriptionsAsHtml	boolean Default: false DEXTRE上で製品の説明文をHTMLとして表示するかどうか true: HTMLとして表示する false: HTMLとして表示しない
	Array of objects カタログPDFに記載される備考
transactionTermCodes	Array of strings Items Enum: "exw" "fca" "cpt" "cip" "dap" "dpu" "ddp" "fas" "fob" "cfr" "cif" "kakeritsu_transaction" "wholesale_transaction" 製品の取引条件コード製品の価格設定に存在する取引条件コードが列挙されます。
currencyCodes	Array of strings Items Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" 製品の通貨コード製品の価格設定に存在する通貨コードが列挙されます。
languageCodes	Array of strings Items Enum: "ja" "en" "zh" "es" "fr" "de" "it" "ko" "ru" "nl" "pt" 製品の言語コード製品の名称や説明文などに使用される言語コードが列挙されます。
taxIds	Array of strings 製品に適用される税のID
skuTemplateId	string SKUテンプレートのID 製品を登録する前にSKUテンプレートを必ず登録していただく必要があります。
	Array of objects この製品で有効なSKUオプションと、そのSKUオプションに属する有効化するSKUオプションバリアントを表します。
	Array of objects 製品レベルの価格を表します。
	Array of objects 製品レベルの参考小売価格を表します。
	object or null 製品の納期の設定を表します。
	Array of objects 大分類・中分類・小分類のカテゴリーの組み合わせをひとつのグループとして、複数のグループを登録することができます。
countryOfOrigin	string or null 製品の原産国コード製品の原産国を設定する場合は、ISO 3166-1 alpha-2形式・大文字で表現します。
	Array of objects 製品に設定されたカスタム属性
catalogIds	Array of strings 製品が属するカタログのID Read Only
	Array of objects
	Array of objects
	Array of objects 依存するSKUテンプレートのシンボルSKUプロパティに対応するSKUプロパティバリアントごとの画像 SKUテンプレートにシンボルSKUプロパティが設定されている場合のみ登録可能
status	string Default: "public" Enum: "public" "private" "draft" "closed" 製品のステータス public: 公開中 private: 非公開 draft: 下書き closed: クローズ (削除状態ではないが、販売が終了した製品など)
createdAt	string <date-time>
updatedAt	string <date-time>

{"object": "product",
"productId": "string",
"modelNumber": "string",
"merchantId": "string",
"brandId": "string",
"hsCode": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"localizedDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"localizedShortDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"renderLocalizedDescriptionsAsHtml": false,
"localizedNotesForCatalogPdf": [{"languageCode": "ja",
"text": "string"
}
],
"transactionTermCodes": ["exw"
],
"currencyCodes": ["AUD"
],
"languageCodes": ["ja"
],
"taxIds": ["string"
],
"skuTemplateId": "string",
"skuOptions": [{"skuOptionId": "string",
"availableSkuOptionVariantIds": ["string"
]
}
],
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "AUD",
"unitPrice": 0
}
],
"deliverySchedule": {"scheduleType": "fixed_window",
"fixedWindow": {"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"isDeliveryDateSelectableByBuyer": true
}
},
"categoryGroups": [{"level1CategoryId": "string",
"level2CategoryId": "string",
"level3CategoryId": "string"
}
],
"countryOfOrigin": "string",
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"catalogIds": ["string"
],
"images": [{"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
],
"videos": [{"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
],
"symbolSkuImages": [{"symbolSkuPropertyId": "string",
"skuPropertyVariantId": "string",
"image": {"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
}
],
"status": "public",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

製品のリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (productId)
direction	string Enum: "next" "previous"
productIds	string Comma separated ids
catalogIds	string Comma separated ids
categoryIds	string Comma separated ids
productName	string
modelNumber	string
createdAtFrom	string <date-time> 作成日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtToとセットで使用する必要はありません。
createdAtTo	string <date-time> 作成日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtFromとセットで使用する必要はありません。
updatedAtFrom	string <date-time> 更新日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtToとセットで使用する必要はありません。
updatedAtTo	string <date-time> 更新日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtFromとセットで使用する必要はありません。
minImageCount	integer >= 0 検索したい製品に登録されている画像の最小枚数を指定します。
maxImageCount	integer >= 0 検索したい製品に登録されている画像の最大枚数を指定します。

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "nextCursor",
"previousCursor": "previousCursor"
},
"data": {"products": [{"object": "product",
"productId": "lhj004x3h3zcdhqor84eoo0kowdb181n",
"modelNumber": "品番",
"merchantId": "YOUR MERCHANT ID",
"brandId": "YOUR BRAND ID",
"hsCode": "",
"localizedNames": [{"languageCode": "ja",
"text": "製品名"
},
{"languageCode": "en",
"text": "Product Name"
},
{"languageCode": "zh",
"text": "产品名称"
}
],
"localizedDescriptions": [ ],
"localizedShortDescriptions": [ ],
"renderLocalizedDescriptionsAsHtml": false,
"transactionTermCodes": ["kakeritsu_transaction"
],
"currencyCodes": ["JPY"
],
"languageCodes": ["ja",
"en",
"zh"
],
"taxIds": [ ],
"skuTemplateId": "YOUR SKU TEMPLATE ID",
"skuOptions": [ ],
"prices": [{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "JPY",
"unitPrice": 1000
},
{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "EUR",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "JPY",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "EUR",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "JPY",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "EUR",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "JPY",
"unitPrice": 0
},
{"currencyCode": "USD",
"unitPrice": 0
},
{"currencyCode": "EUR",
"unitPrice": 0
}
],
"categoryGroups": [ ],
"countryOfOrigin": null,
"customAttributes": [ ],
"catalogIds": [ ],
"images": [ ],
"videos": [ ],
"symbolSkuImages": [{"symbolSkuPropertyId": "YOUR SYMBOL SKU PROPERTY ID",
"skuPropertyVariantId": "YOUR SKU PROPERTY VARIANT ID",
"image": null
}
],
"status": "public",
"createdAt": "2024-10-27T23:26:32.580Z",
"updatedAt": "2024-10-27T23:26:32.580Z"
}
]
}
}

製品を作成する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

modelNumber required	string 製品のモデル番号を指定します。このフィールドは必須であり、ブランド内で一意である必要があります。
hsCode	string 製品のHSコードを指定します。このフィールドの指定はオプショナルです。
required	Array of objects 製品名を指定します。このフィールドは必須であり、Merchantで有効化されている言語分のデータを指定してください。
	Array of objects 製品説明を指定します。このフィールドの指定はオプショナルです。なお、指定する場合はMerchantで有効化されている言語分のデータを指定してください。
	Array of objects 製品の短い説明を指定します。このフィールドの指定はオプショナルです。なお、指定する場合はMerchantで有効化されている言語分のデータを指定してください。
renderLocalizedDescriptionsAsHtml	boolean localizedDescriptionsの値をHTMLとして認識させてレンダリングするかどうかを指定します。このフィールドの指定はオプショナルです。
	Array of objects カタログPDFに記載される備考を指定します。このフィールドの指定はオプショナルです。なお、指定する場合はMerchantで有効化されている言語分のデータを指定してください。
taxIds	Array of strings 製品に適用する税のIDを指定します。税マスタに登録されている税のIDを指定してください。このフィールドの指定はオプショナルです。
skuTemplateId required	string SKUテンプレートのIDを指定します。このフィールドは必須であり、SKUテンプレートは事前に作成されている必要があります。
required	Array of objects 製品レベルの価格を指定します。このフィールドは必須です。 Merchant で有効化されている取引条件 × 通貨の各組み合わせについて価格を指定できます。指定したい組み合わせのみを送信しても問題ありません。なお、リクエストに含まれなかった組み合わせの unitPrice は 0 として登録されます。
	Array of objects 製品の参考小売価格を指定します。このフィールドの指定はオプショナルです。
	object or null 製品の納期の設定を表します。
	Array of objects 大分類・中分類・小分類のカテゴリーの組み合わせをひとつのグループとして、複数のグループを登録することができます。
countryOfOrigin	string or null 製品の原産国を国コード(ISO 3166-1 alpha-2形式・大文字)で指定します。このフィールドの指定はオプショナルです。
	Array of objects 製品に適用するカスタム属性を指定します。このフィールドの指定はオプショナルです。
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"modelNumber": "string",
"hsCode": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"localizedDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"localizedShortDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"renderLocalizedDescriptionsAsHtml": true,
"localizedNotesForCatalogPdf": [{"languageCode": "ja",
"text": "string"
}
],
"taxIds": ["string"
],
"skuTemplateId": "string",
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "AUD",
"unitPrice": 0
}
],
"deliverySchedule": {"scheduleType": "fixed_window",
"fixedWindow": {"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"isDeliveryDateSelectableByBuyer": true
}
},
"categoryGroups": [{"level1CategoryId": "string",
"level2CategoryId": "string",
"level3CategoryId": "string"
}
],
"countryOfOrigin": "string",
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"skus": [{"skuNumber": "string",
"barcode": "string",
"components": [{"skuPropertyId": "string",
"skuPropertyVariantId": "string"
}
],
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "AUD",
"unitPrice": 0
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"cost": {"currencyCode": "AUD",
"amount": 0
},
"backorderException": null
}
]
}

Response samples

Content type

application/json

{"data": {"product": {"object": "product",
"productId": "lhj004x3h3zcdhqor84eoo0kowdb181n",
"modelNumber": "品番",
"merchantId": "YOUR MERCHANT ID",
"brandId": "YOUR BRAND ID",
"hsCode": "",
"localizedNames": [{"languageCode": "ja",
"text": "製品名"
},
{"languageCode": "en",
"text": "Product Name"
},
{"languageCode": "zh",
"text": "产品名称"
}
],
"localizedDescriptions": [ ],
"localizedShortDescriptions": [ ],
"renderLocalizedDescriptionsAsHtml": false,
"transactionTermCodes": ["kakeritsu_transaction"
],
"currencyCodes": ["JPY"
],
"languageCodes": ["ja",
"en",
"zh"
],
"taxIds": [ ],
"skuTemplateId": "YOUR SKU TEMPLATE ID",
"skuOptions": [ ],
"prices": [{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "JPY",
"unitPrice": 1000
},
{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "EUR",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "JPY",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "EUR",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "JPY",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "EUR",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "JPY",
"unitPrice": 0
},
{"currencyCode": "USD",
"unitPrice": 0
},
{"currencyCode": "EUR",
"unitPrice": 0
}
],
"categoryGroups": [ ],
"countryOfOrigin": null,
"customAttributes": [ ],
"catalogIds": [ ],
"images": [ ],
"videos": [ ],
"symbolSkuImages": [{"symbolSkuPropertyId": "YOUR SYMBOL SKU PROPERTY ID",
"skuPropertyVariantId": "YOUR SKU PROPERTY VARIANT ID",
"image": null
}
],
"status": "public",
"createdAt": "2024-10-27T23:26:32.580Z",
"updatedAt": "2024-10-27T23:26:32.580Z"
},
"skus": [{"object": "sku",
"skuId": "cij1w9z1dker028sy978rhs59hdh27dx",
"productId": "lhj004x3h3zcdhqor84eoo0kowdb181n",
"skuNumber": "SKU番号",
"barcode": "",
"merchantId": "YOUR MERCHANT ID",
"brandId": "YOUR BRAND ID",
"skuTemplateId": "YOUR SKU TEMPLATE ID",
"skuComponents": [{"skuPropertyId": "YOUR SKU PROPERTY ID",
"skuPropertyVariantId": "YOUR SKU PROPERTY VARIANT ID"
},
{"skuPropertyId": "YOUR SKU PROPERTY ID",
"skuPropertyVariantId": "YOUR SKU PROPERTY VARIANT ID"
}
],
"prices": [{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "JPY",
"unitPrice": 1000
},
{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "EUR",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "JPY",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "EUR",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "JPY",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "EUR",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "JPY",
"unitPrice": 0
},
{"currencyCode": "USD",
"unitPrice": 0
},
{"currencyCode": "EUR",
"unitPrice": 0
}
],
"customAttributes": [ ],
"cost": null,
"status": "active",
"sortKey": 1730071594580,
"createdAt": "2024-10-27T23:26:32.580Z",
"updatedAt": "2024-10-27T23:26:32.580Z"
}
]
}
}

製品を取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
productId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"product": {"object": "product",
"productId": "lhj004x3h3zcdhqor84eoo0kowdb181n",
"modelNumber": "品番",
"merchantId": "YOUR MERCHANT ID",
"brandId": "YOUR BRAND ID",
"hsCode": "",
"localizedNames": [{"languageCode": "ja",
"text": "製品名"
},
{"languageCode": "en",
"text": "Product Name"
},
{"languageCode": "zh",
"text": "产品名称"
}
],
"localizedDescriptions": [ ],
"localizedShortDescriptions": [ ],
"renderLocalizedDescriptionsAsHtml": false,
"transactionTermCodes": ["kakeritsu_transaction"
],
"currencyCodes": ["JPY"
],
"languageCodes": ["ja",
"en",
"zh"
],
"taxIds": [ ],
"skuTemplateId": "YOUR SKU TEMPLATE ID",
"skuOptions": [ ],
"prices": [{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "JPY",
"unitPrice": 1000
},
{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "EUR",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "JPY",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "EUR",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "JPY",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "EUR",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "JPY",
"unitPrice": 0
},
{"currencyCode": "USD",
"unitPrice": 0
},
{"currencyCode": "EUR",
"unitPrice": 0
}
],
"categoryGroups": [ ],
"countryOfOrigin": null,
"customAttributes": [ ],
"catalogIds": [ ],
"images": [ ],
"videos": [ ],
"symbolSkuImages": [{"symbolSkuPropertyId": "YOUR SYMBOL SKU PROPERTY ID",
"skuPropertyVariantId": "YOUR SKU PROPERTY VARIANT ID",
"image": null
}
],
"status": "public",
"createdAt": "2024-10-27T23:26:32.580Z",
"updatedAt": "2024-10-27T23:26:32.580Z"
},
"skus": [ ]
}
}

製品を更新する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
productId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

modelNumber	string 製品のモデル番号を指定します。このフィールドの指定はオプショナルですが、指定した場合は、製品のモデル番号が更新されます。
hsCode	string 製品のHSコードを指定します。このフィールドの指定はオプショナルですが、指定した場合は、製品のHSコードが更新されます。
	Array of objects 製品名を指定します。このフィールドの指定はオプショナルですが、指定した場合は、製品のローカライズされた名前が更新されます。なお、指定する場合はMerchantで有効化されている言語分のデータを指定してください。
	Array of objects 製品説明を指定します。このフィールドの指定はオプショナルですが、指定した場合は、製品のローカライズされた説明が更新されます。なお、指定する場合はMerchantで有効化されている言語分のデータを指定してください。
	Array of objects 製品の短い説明を指定します。このフィールドの指定はオプショナルですが、指定した場合は、製品のローカライズされた短い説明が更新されます。なお、指定する場合はMerchantで有効化されている言語分のデータを指定してください。
renderLocalizedDescriptionsAsHtml	boolean localizedDescriptionsの値をHTMLとして認識させてレンダリングするかどうかを指定します。このフィールドの指定はオプショナルです。
	Array of objects カタログPDFに記載される備考を指定します。このフィールドの指定はオプショナルです。なお、指定する場合はMerchantで有効化されている言語分のデータを指定してください。
taxIds	Array of strings 製品に適用する税のIDを指定します。税マスタに登録されている税のIDを指定してください。このフィールドの指定はオプショナルですが、指定した場合は、製品に適用される税が更新されます。
	Array of objects 製品レベルの価格を指定します。このフィールドの指定はオプショナルですが、指定した場合は、製品の価格が更新されます。指定する場合、入力値で既存の価格が全て上書きされるため、すべての組み合わせの価格を指定してください。
	Array of objects 製品の参考小売価格を指定します。このフィールドの指定はオプショナルですが、指定した場合は、製品の参考小売価格が更新されます。指定する場合、入力値で既存の参考小売価格が全て上書きされるため、すべての組み合わせの参考小売価格を指定してください。
	object or null 製品の納期の設定を表します。
	Array of objects 大分類・中分類・小分類のカテゴリーの組み合わせをひとつのグループとして、複数のグループを登録することができます。このフィールドの指定はオプショナルですが、指定した場合は、該当製品のカテゴリーグループが全て上書きされます。そのため、指定する場合は必要な全てのカテゴリーグループを入力してください。
countryOfOrigin	string or null 製品の原産国を国コード(ISO 3166-1 alpha-2形式・大文字)で指定します。このフィールドの指定はオプショナルですが、指定した場合は、製品の原産国が更新されます。
	Array of objects 製品に適用するカスタム属性を指定します。このフィールドの指定はオプショナルですが、指定した場合は、製品に適用されるカスタム属性が更新されます。指定する場合、入力値で既存のカスタム属性が全て上書きされるため、すべてのカスタム属性を指定してください。
	Array of objects skusを指定してリクエストする場合、inactiveステータスにしたくない場合は、製品に紐づく既存のSKUを全て含めてください。含まれなかったSKUはinactiveステータスになります。(削除はされないため、アプリ画面などからactiveステータスに変更いただくことが可能です。) また、inactiveステータスのSKUを含めてリクエストした場合、inactiveステータスのSKUはactiveステータスに変更されます。

Responses

Request samples

Payload

Content type

application/json

{"modelNumber": "string",
"hsCode": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"localizedDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"localizedShortDescriptions": [{"languageCode": "ja",
"text": "string"
}
],
"renderLocalizedDescriptionsAsHtml": true,
"localizedNotesForCatalogPdf": [{"languageCode": "ja",
"text": "string"
}
],
"taxIds": ["string"
],
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "AUD",
"unitPrice": 0
}
],
"deliverySchedule": {"scheduleType": "fixed_window",
"fixedWindow": {"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"isDeliveryDateSelectableByBuyer": true
}
},
"categoryGroups": [{"level1CategoryId": "string",
"level2CategoryId": "string",
"level3CategoryId": "string"
}
],
"countryOfOrigin": "string",
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"skus": [{"skuNumber": "string",
"barcode": "string",
"components": [{"skuPropertyId": "string",
"skuPropertyVariantId": "string"
}
],
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "AUD",
"unitPrice": 0
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"cost": {"currencyCode": "AUD",
"amount": 0
},
"backorderException": null
}
]
}

Response samples

Content type

application/json

{"data": {"product": {"object": "product",
"productId": "lhj004x3h3zcdhqor84eoo0kowdb181n",
"modelNumber": "品番",
"merchantId": "YOUR MERCHANT ID",
"brandId": "YOUR BRAND ID",
"hsCode": "",
"localizedNames": [{"languageCode": "ja",
"text": "製品名"
},
{"languageCode": "en",
"text": "Product Name"
},
{"languageCode": "zh",
"text": "产品名称"
}
],
"localizedDescriptions": [ ],
"localizedShortDescriptions": [ ],
"renderLocalizedDescriptionsAsHtml": false,
"transactionTermCodes": ["kakeritsu_transaction"
],
"currencyCodes": ["JPY"
],
"languageCodes": ["ja",
"en",
"zh"
],
"taxIds": [ ],
"skuTemplateId": "YOUR SKU TEMPLATE ID",
"skuOptions": [ ],
"prices": [{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "JPY",
"unitPrice": 1000
},
{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "EUR",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "JPY",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "EUR",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "JPY",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "EUR",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "JPY",
"unitPrice": 0
},
{"currencyCode": "USD",
"unitPrice": 0
},
{"currencyCode": "EUR",
"unitPrice": 0
}
],
"categoryGroups": [ ],
"countryOfOrigin": null,
"customAttributes": [ ],
"catalogIds": [ ],
"images": [ ],
"videos": [ ],
"symbolSkuImages": [{"symbolSkuPropertyId": "YOUR SYMBOL SKU PROPERTY ID",
"skuPropertyVariantId": "YOUR SKU PROPERTY VARIANT ID",
"image": null
}
],
"status": "public",
"createdAt": "2024-10-27T23:26:32.580Z",
"updatedAt": "2024-10-27T23:26:32.580Z"
},
"skus": [{"object": "sku",
"skuId": "cij1w9z1dker028sy978rhs59hdh27dx",
"productId": "lhj004x3h3zcdhqor84eoo0kowdb181n",
"skuNumber": "SKU番号",
"barcode": "",
"merchantId": "YOUR MERCHANT ID",
"brandId": "YOUR BRAND ID",
"skuTemplateId": "YOUR SKU TEMPLATE ID",
"skuComponents": [{"skuPropertyId": "YOUR SKU PROPERTY ID",
"skuPropertyVariantId": "YOUR SKU PROPERTY VARIANT ID"
},
{"skuPropertyId": "YOUR SKU PROPERTY ID",
"skuPropertyVariantId": "YOUR SKU PROPERTY VARIANT ID"
}
],
"prices": [{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "JPY",
"unitPrice": 1000
},
{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "kakeritsu_transaction",
"currencyCode": "EUR",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "JPY",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "exw",
"currencyCode": "EUR",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "JPY",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "USD",
"unitPrice": 0
},
{"transactionTermCode": "ddp",
"currencyCode": "EUR",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "JPY",
"unitPrice": 0
},
{"currencyCode": "USD",
"unitPrice": 0
},
{"currencyCode": "EUR",
"unitPrice": 0
}
],
"customAttributes": [ ],
"cost": null,
"status": "active",
"sortKey": 1730071594580,
"createdAt": "2024-10-27T23:26:32.580Z",
"updatedAt": "2024-10-27T23:26:32.580Z"
}
]
}
}

製品を削除する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
productId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Responses

Response samples

Content type

application/json

{"data": { }
}

製品画像をアップロードする

このAPIでは、Base64エンコードされた画像をアップロードし、対象の製品に関連付けることができます。

注意事項:

アップロード可能な画像の最大サイズは15MBです。
ただし、アプリケーションでの表示速度を考慮して、可能であれば数十〜数百KB程度に圧縮することを推奨しております。

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
productId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

base64Image required	string 画像をBase64エンコードした文字列を指定します。画像のファイル形式は、JPEG、PNG、GIFのいずれかを指定してください。
fileName required	string 画像のファイル名を指定します。画像のファイル名は、拡張子を含むファイル名を指定してください。
orientation required	string Enum: "landscape" "portrait" 画像の向きを指定します。 landscape: 横向き portrait: 縦向き
position	integer 画像の表示順序を指定します。 0以上の整数を指定してください。
positionStrategy	string Enum: "insert" "replace" 画像の表示順序を指定します。 insert: 指定した位置に画像を挿入します。 replace: 指定した位置に画像を上書きします。デフォルトはinsertです。
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"base64Image": "string",
"fileName": "string",
"orientation": "landscape",
"position": 0,
"positionStrategy": "insert",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}

Response samples

Content type

application/json

{"data": {"image": {"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
}
}

シンボルSKU画像をアップロードする

このAPIでは、Base64エンコードされた画像をアップロードし、対象の製品のシンボルSKU画像として設定することができます。対象のシンボルSKUに対して既に画像が設定されていた場合、新しい画像で上書きされます。

注意事項:

アップロード可能な画像の最大サイズは15MBです。
ただし、アプリケーションでの表示速度を考慮して、可能であれば数十〜数百KB程度に圧縮することを推奨しております。

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
productId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

symbolSkuPropertyId required	string 製品で設定されているSKUテンプレートの、シンボル設定されているSKUプロパティIDを指定してください。
skuPropertyVariantId required	string シンボルとなっているSKUプロパティのバリアントIDを指定してください。
base64Image required	string 画像をBase64エンコードした文字列を指定します。画像のファイル形式は、JPEG、PNG、GIFのいずれかを指定してください。
fileName required	string 画像のファイル名を指定します。画像のファイル名は、拡張子を含むファイル名を指定してください。
orientation required	string Enum: "landscape" "portrait" 画像の向きを指定します。 landscape: 横向き portrait: 縦向き
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"symbolSkuPropertyId": "string",
"skuPropertyVariantId": "string",
"base64Image": "string",
"fileName": "string",
"orientation": "landscape",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}

Response samples

Content type

application/json

{"data": {"image": {"url": "string",
"aspectRatio": "3:2",
"localizedCaptions": [{"languageCode": "ja",
"text": "string"
}
]
}
}
}

SKU

SKU object
SKU情報を表します。

object	string Default: "sku"
skuId	string
productId	string
skuNumber	string SKU番号製品内でユニークな値である必要があります。
barcode	string
merchantId	string
brandId	string
skuTemplateId	string このSKUの組成情報を表すSKUテンプレートのID
	Array of objects SKUテンプレートに設定されたSKUプロパティと、そのSKUプロパティに属するSKUプロパティバリアントの組み合わせで組成を表します。 SKUテンプレートの構造に絶対準拠する必要があります。また、製品内でユニークな組成である必要があります。
	Array of objects SKUレベルの価格を表します。
	Array of objects SKUレベルの参考小売価格を表します。
	Array of objects SKUに設定されたカスタム属性
	object or null SKUの製造原価
backorderException	string or null Enum: null "backorder_disallowed" 本フィールドでは、バックオーダーの例外設定を行います。バックオーダーが有効な在庫受注ポリシーが適用されたカタログで受注する際に評価されます。デフォルトはnullであり、在庫受注ポリシーの設定に従います。 backorder_disallowedを指定すると、指定したSKUはバックオーダー対象外となります。 null: デフォルト (例外なし) backorder_disallowed: バックオーダー対象外とする
status	string Default: "active" Enum: "active" "inactive"
sortKey	integer
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "sku",
"skuId": "string",
"productId": "string",
"skuNumber": "string",
"barcode": "string",
"merchantId": "string",
"brandId": "string",
"skuTemplateId": "string",
"skuComponents": [{"skuPropertyId": "string",
"skuPropertyVariantId": "string"
}
],
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "AUD",
"unitPrice": 0
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"cost": {"currencyCode": "AUD",
"amount": 0
},
"backorderException": null,
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

SKUのリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (skuId)
direction	string Enum: "next" "previous"
skuIds	string Comma separated ids
skuNumber	string
barcode	string
productIds	string Comma separated ids
skuTemplateIds	string Comma separated ids
skuPropertyIds	string Comma separated ids
skuPropertyVariantIds	string Comma separated ids

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"skus": [{"object": "sku",
"skuId": "string",
"productId": "string",
"skuNumber": "string",
"barcode": "string",
"merchantId": "string",
"brandId": "string",
"skuTemplateId": "string",
"skuComponents": [{"skuPropertyId": "string",
"skuPropertyVariantId": "string"
}
],
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "AUD",
"unitPrice": 0
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"cost": {"currencyCode": "AUD",
"amount": 0
},
"backorderException": null,
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

SKUを作成する

SKUを作成するには、製品(Product)が必ず事前登録されている必要があります。
製品作成APIで、SKUを同時に登録することが可能なため、必要に応じて製品作成APIをご利用ください。

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
productId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

skuNumber required	string
barcode	string
required	Array of objects or objects
required	Array of objects
	Array of objects
	Array of objects
	object or null SKUの製造原価
backorderException	string or null Enum: null "backorder_disallowed" 本フィールドでは、バックオーダーの例外設定を行います。バックオーダーが有効な在庫受注ポリシーが適用されたカタログで受注する際に評価されます。デフォルトはnullであり、在庫受注ポリシーの設定に従います。 backorder_disallowedを指定すると、指定したSKUはバックオーダー対象外となります。 null: デフォルト (例外なし) backorder_disallowed: バックオーダー対象外とする

Responses

Request samples

Payload

Content type

application/json

{"skuNumber": "string",
"barcode": "string",
"components": [{"skuPropertyId": "string",
"skuPropertyVariantId": "string"
}
],
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "AUD",
"unitPrice": 0
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"cost": {"currencyCode": "AUD",
"amount": 0
},
"backorderException": null
}

Response samples

Content type

application/json

{"data": {"sku": {"object": "sku",
"skuId": "string",
"productId": "string",
"skuNumber": "string",
"barcode": "string",
"merchantId": "string",
"brandId": "string",
"skuTemplateId": "string",
"skuComponents": [{"skuPropertyId": "string",
"skuPropertyVariantId": "string"
}
],
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "AUD",
"unitPrice": 0
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"cost": {"currencyCode": "AUD",
"amount": 0
},
"backorderException": null,
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

SKUを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
productId required	string
skuId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"sku": {"object": "sku",
"skuId": "string",
"productId": "string",
"skuNumber": "string",
"barcode": "string",
"merchantId": "string",
"brandId": "string",
"skuTemplateId": "string",
"skuComponents": [{"skuPropertyId": "string",
"skuPropertyVariantId": "string"
}
],
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "AUD",
"unitPrice": 0
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"cost": {"currencyCode": "AUD",
"amount": 0
},
"backorderException": null,
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

SKUを更新する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
productId required	string
skuId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

skuNumber	string
barcode	string
	Array of objects
	Array of objects
	Array of objects
	object or null SKUの製造原価

Responses

Request samples

Payload

Content type

application/json

{"skuNumber": "string",
"barcode": "string",
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "AUD",
"unitPrice": 0
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"cost": {"currencyCode": "AUD",
"amount": 0
}
}

Response samples

Content type

application/json

{"data": {"sku": {"object": "sku",
"skuId": "string",
"productId": "string",
"skuNumber": "string",
"barcode": "string",
"merchantId": "string",
"brandId": "string",
"skuTemplateId": "string",
"skuComponents": [{"skuPropertyId": "string",
"skuPropertyVariantId": "string"
}
],
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"referenceRetailPrices": [{"currencyCode": "AUD",
"unitPrice": 0
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"cost": {"currencyCode": "AUD",
"amount": 0
},
"backorderException": null,
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

SKUをアーカイブする

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
productId required	string
skuId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Responses

Response samples

Content type

application/json

{"data": { }
}

SKUプロパティ

SkuProperty object
SKUプロパティ情報を表します。
SKUプロパティは、SKUを構成するための部品データに当たります。
「カラー」や「サイズ」などの情報がSKUプロパティに該当します。

object	string Default: "sku_property"
skuPropertyId	string
code	string SKUプロパティのコードブランド内でユニークな値である必要があります。
merchantId	string
brandId	string
	Array of objects SKUプロパティの名称 Merchantで有効化している言語の数だけ設定されます。
	Array of objects SKUプロパティに属するSKUプロパティバリアント
status	string Default: "active" Enum: "active" "draft"
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "sku_property",
"skuPropertyId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"variants": [{"object": "sku_property_variant",
"skuPropertyVariantId": "string",
"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"status": "active"
}
],
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

SKUプロパティのリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (skuPropertyId)
direction	string Enum: "next" "previous"
skuPropertyIds	string Comma separated ids

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"skuProperties": [{"object": "sku_property",
"skuPropertyId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"variants": [{"object": "sku_property_variant",
"skuPropertyVariantId": "string",
"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"status": "active"
}
],
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

SKUプロパティを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
skuPropertyId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"skuProperty": {"object": "sku_property",
"skuPropertyId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"variants": [{"object": "sku_property_variant",
"skuPropertyVariantId": "string",
"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"status": "active"
}
],
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

SKUテンプレート

SkuTemplate object
SKUテンプレート情報を表します。
SKUテンプレートは製品のSKUを構成するためのSKUプロパティの階層構造を定義します。

object	string Default: "sku_template"
skuTemplateId	string
code	string SKUテンプレートのコードブランド内でユニークな値である必要があります。
merchantId	string
brandId	string
skuPropertyIds	Array of strings SKUテンプレートに設定されるSKUプロパティのID。指定された順番で、階層構造を定義します。例: [カラーSKUプロパティID, サイズSKUプロパティID]の場合、カラーSKUプロパティが第1階層、サイズSKUプロパティが第2階層となります。これは「カラー - サイズ」のSKUの構造を表します。
symbolSkuPropertyId	string or null シンボルSKUプロパティのID シンボルSKUプロパティを設定した場合、このSKUテンプレートを適用した製品にて、シンボルSKUプロパティに対応するSKUプロパティバリアントごとの画像を登録することが可能です。
status	string Enum: "active" "draft"
sortKey	integer
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "sku_template",
"skuTemplateId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"skuPropertyIds": ["string"
],
"symbolSkuPropertyId": "string",
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

SKUテンプレートのリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (skuTemplateId)
direction	string Enum: "next" "previous"
skuTemplateIds	string Comma separated ids

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"skuTemplates": [{"object": "sku_template",
"skuTemplateId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"skuPropertyIds": ["string"
],
"symbolSkuPropertyId": "string",
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

SKUテンプレートを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
skuTemplateId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"skuTemplate": {"object": "sku_template",
"skuTemplateId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"skuPropertyIds": ["string"
],
"symbolSkuPropertyId": "string",
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

SKUオプション

SkuOption object
SKUオプション情報を表します。
SKUオプションはSKU管理(在庫管理)はしたくないが、オプションに応じて価格を上乗せ・割引したい場合などに使用します。
メガネを例にあげると、フレームをSKU管理して、レンズの色などがSKUオプションとして管理される事例が多々ございます。

object	string Default: "sku_option"
skuOptionId	string
code	string SKUオプションのコードブランド内でユニークな値である必要があります。
merchantId	string
brandId	string
	Array of objects SKUオプションの名称 Merchantで有効化している言語の数だけ設定されます。
	Array of objects SKUオプションに属するSKUオプションバリアント
defaultVariantId	string
applyTransactionTermRateToPrice	boolean 取引条件レートを価格に適用するかどうか true: 取引条件レートを価格に適用する false: 取引条件レートを価格に適用しない
status	string Enum: "active" "inactive"
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "sku_option",
"skuOptionId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"variants": [{"object": "sku_option_variant",
"skuOptionVariantId": "string",
"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"status": "active"
}
],
"defaultVariantId": "string",
"applyTransactionTermRateToPrice": true,
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

SKUオプションのリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (skuOptionId)
direction	string Enum: "next" "previous"
skuOptionIds	string Comma separated ids

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"skuOptions": [{"object": "sku_option",
"skuOptionId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"variants": [{"object": "sku_option_variant",
"skuOptionVariantId": "string",
"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"status": "active"
}
],
"defaultVariantId": "string",
"applyTransactionTermRateToPrice": true,
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

SKUオプションを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
skuOptionId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"skuOption": {"object": "sku_option",
"skuOptionId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"variants": [{"object": "sku_option_variant",
"skuOptionVariantId": "string",
"code": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"prices": [{"transactionTermCode": "exw",
"currencyCode": "AUD",
"unitPrice": 0
}
],
"status": "active"
}
],
"defaultVariantId": "string",
"applyTransactionTermRateToPrice": true,
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

在庫アイテム

InventoryItem object
在庫アイテムを表します。
在庫アイテムは、製品のSKUに対して、在庫ラベルと在庫ロケーションを紐付けた情報で構成されます。

object	string Default: "inventory_item"
inventoryItemId	string
skuId	string
productId	string
merchantId	string
brandId	string
inventoryLabelId	string
inventoryLocationId	string
	object or null SKUの製造原価
quantity	integer
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "inventory_item",
"inventoryItemId": "string",
"skuId": "string",
"productId": "string",
"merchantId": "string",
"brandId": "string",
"inventoryLabelId": "string",
"inventoryLocationId": "string",
"cost": {"currencyCode": "AUD",
"amount": 0
},
"quantity": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

在庫アイテムのリストを更新日時に基づいて取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string 次のページまたは前のページを取得するためのカーソルです。(inventoryItemId)
direction	string Enum: "next" "previous"
updatedAtFrom	string <date-time> 更新日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtToとセットで使用する必要はありません。
updatedAtTo	string <date-time> 更新日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtFromとセットで使用する必要はありません。

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"inventoryItems": [{"object": "inventory_item",
"inventoryItemId": "string",
"skuId": "string",
"productId": "string",
"merchantId": "string",
"brandId": "string",
"inventoryLabelId": "string",
"inventoryLocationId": "string",
"cost": {"currencyCode": "AUD",
"amount": 0
},
"quantity": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

在庫アイテムを複数SKU IDで取得する

複数のSKU IDを指定して、在庫アイテムを取得します。
SKU IDは最大100件まで指定可能です。
このAPIは、将来的により柔軟な検索APIに置き換えられる可能性があります。
廃止する場合は、十分な移行期間を設けた上でご案内いたします。

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

skuIds required	Array of strings [ 1 .. 100 ] items SKU IDのリストです。最大100件まで指定可能です。最小1件以上指定する必要があります。必須フィールドのため、必ずご指定ください。
inventoryLabelId required	string 在庫ラベルのIDです。必須フィールドのため、必ずご指定ください。
inventoryLocationId required	string 在庫ロケーションのIDです。必須フィールドのため、必ずご指定ください。

Responses

Request samples

Payload

Content type

application/json

{"skuIds": ["n62y1phm9ct6rwab05ioin6xx05cu29z"
],
"inventoryLabelId": "string",
"inventoryLocationId": "string"
}

Response samples

Content type

application/json

{"data": {"inventoryItems": [{"object": "inventory_item",
"inventoryItemId": "string",
"skuId": "string",
"productId": "string",
"merchantId": "string",
"brandId": "string",
"inventoryLabelId": "string",
"inventoryLocationId": "string",
"cost": {"currencyCode": "AUD",
"amount": 0
},
"quantity": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

在庫アイテムを一括でセット(上書き)する

在庫アイテムを一括でセット(上書き)します。
現時点では、最大100件まで指定可能です。

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

required

Array of objects[ items [ 1 .. 100 ] items ]

上書き登録する在庫アイテムのリストです。
現時点では、最大100件まで指定可能です。

Responses

Request samples

Payload

Content type

application/json

{"items": [{"productId": "string",
"skuId": "string",
"inventoryLabelId": "string",
"inventoryLocationId": "string",
"quantity": 0
}
]
}

Response samples

Content type

application/json

{"data": {"inventoryItems": [{"object": "inventory_item",
"inventoryItemId": "string",
"skuId": "string",
"productId": "string",
"merchantId": "string",
"brandId": "string",
"inventoryLabelId": "string",
"inventoryLocationId": "string",
"cost": {"currencyCode": "AUD",
"amount": 0
},
"quantity": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

SKUの在庫アイテムを上書きする_SKU番号で指定

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

skuNumber	string 登録済みの有効な `SKU番号 (SKU.skuNumber)` を指定してください。
inventoryLabelId	string
inventoryLocationId	string
quantity	integer

Responses

Request samples

Payload

Content type

application/json

{"skuNumber": "string",
"inventoryLabelId": "string",
"inventoryLocationId": "string",
"quantity": 0
}

Response samples

Content type

application/json

{"data": {"inventoryItem": {"object": "inventory_item",
"inventoryItemId": "string",
"skuId": "string",
"productId": "string",
"merchantId": "string",
"brandId": "string",
"inventoryLabelId": "string",
"inventoryLocationId": "string",
"cost": {"currencyCode": "AUD",
"amount": 0
},
"quantity": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

SKUの在庫アイテムを調整する_SKU番号で指定

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

skuNumber	string 登録済みの有効な `SKU番号 (SKU.skuNumber)` を指定してください。
inventoryLabelId	string
inventoryLocationId	string
adjustmentQuantity	integer 調整する数量。正の値で増加、負の値で減少。

Responses

Request samples

Payload

Content type

application/json

{"skuNumber": "string",
"inventoryLabelId": "string",
"inventoryLocationId": "string",
"adjustmentQuantity": 0
}

Response samples

Content type

application/json

{"data": {"inventoryItem": {"object": "inventory_item",
"inventoryItemId": "string",
"skuId": "string",
"productId": "string",
"merchantId": "string",
"brandId": "string",
"inventoryLabelId": "string",
"inventoryLocationId": "string",
"cost": {"currencyCode": "AUD",
"amount": 0
},
"quantity": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

SKUの在庫アイテムを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
productId required	string
skuId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"inventoryItems": [{"object": "inventory_item",
"inventoryItemId": "string",
"skuId": "string",
"productId": "string",
"merchantId": "string",
"brandId": "string",
"inventoryLabelId": "string",
"inventoryLocationId": "string",
"cost": {"currencyCode": "AUD",
"amount": 0
},
"quantity": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

SKUの在庫アイテムをセット(上書き)する_IDで指定

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
productId required	string
skuId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

inventoryLabelId	string
inventoryLocationId	string
quantity	integer

Responses

Request samples

Payload

Content type

application/json

{"inventoryLabelId": "string",
"inventoryLocationId": "string",
"quantity": 0
}

Response samples

Content type

application/json

{"data": {"inventoryItem": {"object": "inventory_item",
"inventoryItemId": "string",
"skuId": "string",
"productId": "string",
"merchantId": "string",
"brandId": "string",
"inventoryLabelId": "string",
"inventoryLocationId": "string",
"cost": {"currencyCode": "AUD",
"amount": 0
},
"quantity": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

SKUの在庫アイテムの数量を調整する_IDで指定

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
productId required	string
skuId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

inventoryLabelId	string
inventoryLocationId	string
adjustmentQuantity	integer 調整する数量。正の値で増加、負の値で減少。

Responses

Request samples

Payload

Content type

application/json

{"inventoryLabelId": "string",
"inventoryLocationId": "string",
"adjustmentQuantity": 0
}

Response samples

Content type

application/json

{"data": {"inventoryItem": {"object": "inventory_item",
"inventoryItemId": "string",
"skuId": "string",
"productId": "string",
"merchantId": "string",
"brandId": "string",
"inventoryLabelId": "string",
"inventoryLocationId": "string",
"cost": {"currencyCode": "AUD",
"amount": 0
},
"quantity": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

製品カテゴリー

ProductCategory object

object	string Default: "product_category"
categoryId	string
merchantId	string
brandId	string
type	string Enum: "category_level_1" "category_level_2" "category_level_3" カテゴリーの階層レベル category_level_1: 大分類 category_level_2: 中分類 category_level_3: 小分類
	Array of objects カテゴリーの名称 Merchantで有効化している言語の数だけ設定されます。
parentCategoryId	string or null 親カテゴリーのID 大分類の場合はnull
status	string Default: "active" Value: "active"
sortKey	integer
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "product_category",
"categoryId": "string",
"merchantId": "string",
"brandId": "string",
"type": "category_level_1",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"parentCategoryId": "string",
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

製品カテゴリーのリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (categoryId)
direction	string Enum: "next" "previous"
categoryIds	string Comma separated ids

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"categories": [{"object": "product_category",
"categoryId": "string",
"merchantId": "string",
"brandId": "string",
"type": "category_level_1",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"parentCategoryId": "string",
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

製品カテゴリーを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
categoryId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"category": {"object": "product_category",
"categoryId": "string",
"merchantId": "string",
"brandId": "string",
"type": "category_level_1",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"parentCategoryId": "string",
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

顧客バイヤー

CustomerBuyer object
顧客バイヤー情報を表します。

object	string Default: "customer_buyer"
customerBuyerId	string
merchantId	string
brandId	string
sourceBuyerObjectType	string Enum: "buyer" "offline_buyer" バイヤーのソースオブジェクトタイプ buyer: オンラインバイヤー offline_buyer: オフラインバイヤー
businessType	string Enum: "company" "individual" 顧客バイヤーの事業形態 company: 法人 individual: 個人
code	string or null 顧客バイヤーのユニークコードを表します。ブランド内で一意のコードを設定します。
customerCode	string 顧客コードを表します。重複したコードを設定することが可能です。例えば、同一顧客グループを表現するために、複数のバイヤーに同一の顧客コードを設定することができます。
	Array of objects バイヤーの名称バイヤーで有効化している言語の数だけ設定されます。
customDisplayName	string 顧客バイヤーのカスタム表示名を表します。
countryCode	string 顧客バイヤーの所在国コード。 ISO 3166-1 alpha-2形式・大文字で表現します。例: 'JP'
transactionTermCode	string Enum: "exw" "fca" "cpt" "cip" "dap" "dpu" "ddp" "fas" "fob" "cfr" "cif" "kakeritsu_transaction" "wholesale_transaction" この顧客との取引で使用する取引条件コードを表します。マーチャントで有効化している取引条件コードの中から設定します。
	object or object 取引条件レート取引条件コードに対応する取引条件レートを設定します。
currencyCode	string Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" この顧客との取引で使用する通貨コードを表します。マーチャントで有効化している通貨コードの中から設定します。
languageCode	string Enum: "ja" "en" "zh" "es" "fr" "de" "it" "ko" "ru" "nl" "pt" DEXTREでサポートされている言語コード。
	Array of objects
	Array of objects
	Array of objects 顧客バイヤーに紐づけるカスタム属性データを表します。外部システムとの名寄せや、顧客バイヤーの特性を表現するために使用します。
tagIds	Array of strings 顧客バイヤーに紐づいているタグのIDを表します。
status	string Enum: "active" "closed"
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "customer_buyer",
"customerBuyerId": "string",
"merchantId": "string",
"brandId": "string",
"sourceBuyerObjectType": "buyer",
"businessType": "company",
"code": "string",
"customerCode": "string",
"sourceBuyerLocalizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"customDisplayName": "string",
"countryCode": "string",
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"currencyCode": "AUD",
"languageCode": "ja",
"billingAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"deliveryAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"tagIds": ["string"
],
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

顧客バイヤーのリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (customerBuyerId)
direction	string Enum: "next" "previous"
customerBuyerIds	string カンマ区切りされた顧客バイヤーIDを指定することで、該当顧客バイヤーを絞り込みます。
tagIds	string カンマ区切りされたタグIDを指定することで、該当タグが紐づいている顧客バイヤーを絞り込みます。
createdAtFrom	string <date-time> 作成日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtToとセットで使用する必要はありません。
createdAtTo	string <date-time> 作成日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtFromとセットで使用する必要はありません。
updatedAtFrom	string <date-time> 更新日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtToとセットで使用する必要はありません。
updatedAtTo	string <date-time> 更新日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtFromとセットで使用する必要はありません。

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"customerBuyers": [{"object": "customer_buyer",
"customerBuyerId": "string",
"merchantId": "string",
"brandId": "string",
"sourceBuyerObjectType": "buyer",
"businessType": "company",
"code": "string",
"customerCode": "string",
"sourceBuyerLocalizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"customDisplayName": "string",
"countryCode": "string",
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"currencyCode": "AUD",
"languageCode": "ja",
"billingAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"deliveryAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"tagIds": ["string"
],
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

顧客バイヤーを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
customerBuyerId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"customerBuyer": {"object": "customer_buyer",
"customerBuyerId": "string",
"merchantId": "string",
"brandId": "string",
"sourceBuyerObjectType": "buyer",
"businessType": "company",
"code": "string",
"customerCode": "string",
"sourceBuyerLocalizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"customDisplayName": "string",
"countryCode": "string",
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"currencyCode": "AUD",
"languageCode": "ja",
"billingAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"deliveryAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"tagIds": ["string"
],
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

顧客バイヤーを更新する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
customerBuyerId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

顧客バイヤーの更新情報

code	string
customDisplayName	string
	object or object
currencyCode	string Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" DEXTREでサポートされている通貨コード。
languageCode	string Enum: "ja" "en" "zh" "es" "fr" "de" "it" "ko" "ru" "nl" "pt" DEXTREでサポートされている言語コード。
	Array of objects
	Array of objects
	Array of objects
tagIds	Array of strings 該当顧客バイヤーに紐づけたいタグのIDをご指定ください。タグはあらかじめタグマスタで定義されている必要がございます。既にあるタグとの紐付きを削除したい場合は、更新時にtagIds配列に該当IDを含めないようにしてください。既に紐付けており、引き続き紐付けたい場合は、更新時にtagIds配列に該当IDを必ず含めてください。なお、既にあるタグとの紐付きをすべて削除したい場合は、tagIds配列に空の配列を指定してください。本フィールドはオプショナルのため、フィールド自体の指定がなかった場合はタグ関係の処理は行われません。（紐付けも削除も行われません）

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"customDisplayName": "string",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"currencyCode": "AUD",
"languageCode": "ja",
"billingAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"deliveryAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"tagIds": ["string"
]
}

Response samples

Content type

application/json

{"data": {"customerBuyer": {"object": "customer_buyer",
"customerBuyerId": "string",
"merchantId": "string",
"brandId": "string",
"sourceBuyerObjectType": "buyer",
"businessType": "company",
"code": "string",
"customerCode": "string",
"sourceBuyerLocalizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"customDisplayName": "string",
"countryCode": "string",
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"currencyCode": "AUD",
"languageCode": "ja",
"billingAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"deliveryAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"tagIds": ["string"
],
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

オフラインバイヤー

OfflineBuyer object
オフラインバイヤー情報を表します。

object	string Default: "offline_buyer"
offlineBuyerId	string
businessType	string Enum: "company" "individual"
merchantId	string
brandId	string
	Array of objects オフラインバイヤーの名称 Merchantで有効化している言語の数だけ設定されます。
countryCode	string オフラインバイヤーの所在国コード。 ISO 3166-1 alpha-2形式・大文字で表現します。例: 'JP'
emails	Array of strings
phoneNumber	string
	Array of objects
	Array of objects
primaryLanguageCode	string
status	string Enum: "active" "closed" "merged_into_buyer"
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "offline_buyer",
"offlineBuyerId": "string",
"businessType": "company",
"merchantId": "string",
"brandId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"countryCode": "string",
"emails": ["string"
],
"phoneNumber": "string",
"billingAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"deliveryAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"primaryLanguageCode": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

オフラインバイヤーのリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (offlineBuyerId)
direction	string Enum: "next" "previous"
offlineBuyerIds	string Comma separated ids
createdAtFrom	string <date-time> 作成日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtToとセットで使用する必要はありません。
createdAtTo	string <date-time> 作成日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtFromとセットで使用する必要はありません。
updatedAtFrom	string <date-time> 更新日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtToとセットで使用する必要はありません。
updatedAtTo	string <date-time> 更新日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtFromとセットで使用する必要はありません。

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"offlineBuyers": [{"object": "offline_buyer",
"offlineBuyerId": "string",
"businessType": "company",
"merchantId": "string",
"brandId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"countryCode": "string",
"emails": ["string"
],
"phoneNumber": "string",
"billingAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"deliveryAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"primaryLanguageCode": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

オフラインバイヤーを作成する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

オフラインバイヤーの作成情報 (顧客バイヤーも合わせて作成されるため、顧客バイヤーデータも含む)

code required	string 顧客バイヤーのユニークコードを指定してください。このフィールドでは重複が許可されていません。
customerCode	string 顧客バイヤーのカスタマーコードを指定してください。このフィールドでは重複が許可されています。
required	Array of objects オフラインバイヤーの表示名を指定してください。
customDisplayName	string 顧客バイヤーのカスタム表示名を指定してください。
countryCode required	string DEXTREでサポートされている国コード。 ISO 3166-1 alpha-2形式・大文字で表現します。例: 'AF' for Afghanistan 'US' for United States 'JP' for Japan 'DE' for Germany 'IN' for India 'BR' for Brazil
required	object or object
currencyCode required	string Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" DEXTREでサポートされている通貨コード。
languageCode required	string Enum: "ja" "en" "zh" "es" "fr" "de" "it" "ko" "ru" "nl" "pt" DEXTREでサポートされている言語コード。
emails required	Array of strings オフラインバイヤーのメールアドレスを指定してください。
phoneNumber	string
	Array of objects
	Array of objects
	Array of objects
tagIds	Array of strings 該当顧客バイヤーに紐づけたいタグのIDをご指定ください。タグはあらかじめタグマスタで定義されている必要がございます。

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"customerCode": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"customDisplayName": "string",
"countryCode": "string",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"currencyCode": "AUD",
"languageCode": "ja",
"emails": ["string"
],
"phoneNumber": "string",
"billingAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"deliveryAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"tagIds": ["string"
]
}

Response samples

Content type

application/json

{"data": {"customerBuyer": {"object": "customer_buyer",
"customerBuyerId": "string",
"merchantId": "string",
"brandId": "string",
"sourceBuyerObjectType": "buyer",
"businessType": "company",
"code": "string",
"customerCode": "string",
"sourceBuyerLocalizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"customDisplayName": "string",
"countryCode": "string",
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"currencyCode": "AUD",
"languageCode": "ja",
"billingAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"deliveryAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"customAttributes": [{"customAttributeId": "string",
"value": "string"
}
],
"tagIds": ["string"
],
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"offlineBuyer": {"object": "offline_buyer",
"offlineBuyerId": "string",
"businessType": "company",
"merchantId": "string",
"brandId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"countryCode": "string",
"emails": ["string"
],
"phoneNumber": "string",
"billingAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"deliveryAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"primaryLanguageCode": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

オフラインバイヤーを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
offlineBuyerId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"offlineBuyer": {"object": "offline_buyer",
"offlineBuyerId": "string",
"businessType": "company",
"merchantId": "string",
"brandId": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"countryCode": "string",
"emails": ["string"
],
"phoneNumber": "string",
"billingAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"deliveryAddresses": [{"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
}
],
"primaryLanguageCode": "string",
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

カスタム属性

CustomAttribute object
カスタム属性情報を表します。
カスタム属性は、製品やSKU、バイヤーなどに対して、カスタムな情報を追加するための機能です。
外部システムのデータとの名寄せや、その他検索条件などに使用します。

object	string Default: "custom_attribute"
customAttributeId	string
merchantId	string
brandId	string
applicableTo	string Enum: "customer_buyer" "product_and_sku" "catalog" カスタム属性の適用対象 customer_buyer: 顧客バイヤー product_and_sku: 製品とSKU catalog: カタログ
visibility	string Default: "public" Enum: "public" "private" "public_on_detail_page_only" カスタム属性の表示設定 public: 公開 private: 非公開 public_on_detail_page_only: 詳細ページでのみ公開 (主に製品をバイヤーアプリで表示する際の設定)
name	string カスタム属性の名称例: '外部システムID'
status	string Value: "active"
sortKey	integer
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "custom_attribute",
"customAttributeId": "string",
"merchantId": "string",
"brandId": "string",
"applicableTo": "customer_buyer",
"visibility": "public",
"name": "string",
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

カスタム属性のリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (customAttributeId)
direction	string Enum: "next" "previous"
customAttributeIds	string Comma separated ids

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"customAttributes": [{"object": "custom_attribute",
"customAttributeId": "string",
"merchantId": "string",
"brandId": "string",
"applicableTo": "customer_buyer",
"visibility": "public",
"name": "string",
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

カスタム属性を取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
customAttributeId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"customAttribute": {"object": "custom_attribute",
"customAttributeId": "string",
"merchantId": "string",
"brandId": "string",
"applicableTo": "customer_buyer",
"visibility": "public",
"name": "string",
"status": "active",
"sortKey": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

object	string Value: "tag" オブジェクトタイプ
tagId	string タグID
code	string タグコード
merchantId	string マーチャントID
brandId	string ブランドID
applicableEntityType	string Enum: "customer_buyer" "order" "product" "catalog" "delivery_note" "goods_return_note" "invoice" "credit_note" "payment_confirmation" タグが適用可能なエンティティタイプ
displayName	string プライマリ表示名
	Array of objects 多言語表示名
description	string タグの説明・用途
colorCode	string or null UIでの表示色 (e.g., "#FF0000")
status	string Enum: "active" "archived" タグの状態
visibleToBuyer	boolean Buyerに表示するか
systemProtected	boolean システムにより作成された保護されたタグであることを示す（削除不可）
createdAt	string <date-time> 作成日時
updatedAt	string <date-time> 更新日時

{"object": "tag",
"tagId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"applicableEntityType": "customer_buyer",
"displayName": "string",
"localizedDisplayNames": [{"languageCode": "ja",
"text": "string"
}
],
"description": "string",
"colorCode": "string",
"status": "active",
"visibleToBuyer": true,
"systemProtected": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

タグを作成する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

code required	string タグコードはブランド内で一意である必要があります。
applicableEntityType required	string Enum: "customer_buyer" "order" "product" "catalog" "delivery_note" "goods_return_note" "invoice" "credit_note" "payment_confirmation" タグが適用可能なエンティティタイプ
name required	string タグのプライマリ表示名
description	string タグの説明・用途
colorCode	string UIでの表示色 (e.g., "#FF0000")

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"applicableEntityType": "customer_buyer",
"name": "string",
"description": "string",
"colorCode": "string"
}

Response samples

Content type

application/json

{"data": {"tag": {"object": "tag",
"tagId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"applicableEntityType": "customer_buyer",
"displayName": "string",
"localizedDisplayNames": [{"languageCode": "ja",
"text": "string"
}
],
"description": "string",
"colorCode": "string",
"status": "active",
"visibleToBuyer": true,
"systemProtected": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

タグを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
tagId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"tag": {"object": "tag",
"tagId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"applicableEntityType": "customer_buyer",
"displayName": "string",
"localizedDisplayNames": [{"languageCode": "ja",
"text": "string"
}
],
"description": "string",
"colorCode": "string",
"status": "active",
"visibleToBuyer": true,
"systemProtected": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

タグを部分更新する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
tagId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

code	string
name	string
description	string
colorCode	string

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"name": "string",
"description": "string",
"colorCode": "string"
}

Response samples

Content type

application/json

{"data": {"tag": {"object": "tag",
"tagId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"applicableEntityType": "customer_buyer",
"displayName": "string",
"localizedDisplayNames": [{"languageCode": "ja",
"text": "string"
}
],
"description": "string",
"colorCode": "string",
"status": "active",
"visibleToBuyer": true,
"systemProtected": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

タグを削除する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
tagId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Responses

Response samples

Content type

application/json

{"data": { }
}

注文

Order object
注文情報を表します。
注文は「元の受注データ」と「注文内容確認書データ」とそれぞれ一対一の関係になります。

object	string Default: "order"
orderId	string
code	string
merchantId	string
brandId	string
customerBuyerId	string 顧客バイヤーのID
	object
	object or null 請求先住所情報請求先住所が存在しない場合はnullを設定します。
	object or null 納品先住所情報納品先住所が存在しない場合はnullを設定します。
transactionTermCodes	Array of strings Items Enum: "exw" "fca" "cpt" "cip" "dap" "dpu" "ddp" "fas" "fob" "cfr" "cif" "kakeritsu_transaction" "wholesale_transaction"
	Array of objects or objects
currencyCode	string Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" DEXTREでサポートされている通貨コード。
catalogId	string
	object 元の受注の金額サマリーを表します。
	object or null 注文内容確認書の金額サマリーを表します。注文内容確認書が作成されていない場合はnullを設定します。
brandComment	string ブランド側からのコメントブランド側担当者が注文内容確認書の作成・編集時に入力したコメントを表します。この項目はバイヤーにも共有されます。（バイヤーアプリ側でも表示されます。）
buyerComment	string バイヤー側からのコメントバイヤー側担当者が発注時に入力したコメントを表します。
internalNote	string 社内メモ
	Array of objects
status	string Enum: "order_confirmation_required" "order_confirmation_created" "order_confirmation_approved_by_buyer" "order_confirmation_confirmed" "order_confirmation_rejected_by_buyer" "order_canceled_by_brand" "order_canceled_by_buyer" "order_voided_and_items_returned_to_cart" 注文のステータス order_confirmation_required: 注文内容確認書の作成が必要 order_confirmation_created: 注文内容確認書が作成された order_confirmation_approved_by_buyer: バイヤーによって注文内容確認書が承認された order_confirmation_confirmed: 注文内容確認書が確定された order_confirmation_rejected_by_buyer: バイヤーによって注文内容確認書が拒否された order_canceled_by_brand: ブランドによって注文が取り消された order_canceled_by_buyer: バイヤーによって注文がキャンセルされた order_voided_and_items_returned_to_cart: 注文が無効化され、商品がバイヤーのカートに差し戻された
inventoryStatus	string or null Enum: "made_to_order" "allocated" "partially_backordered" "backordered" 在庫割り当てステータス made_to_order: 受注生産 allocated: 全アイテム在庫引き当て済み (在庫販売) partially_backordered: 一部バックオーダー、一部在庫引当済み(在庫販売) backordered: 全アイテムバックオーダー null: 在庫機能を無効にしている
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "order",
"orderId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"catalogId": "string",
"originalOrderSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"orderConfirmationSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"brandComment": "string",
"buyerComment": "string",
"internalNote": "string",
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"status": "order_confirmation_required",
"inventoryStatus": "made_to_order",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

注文のリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (orderId)
direction	string Enum: "next" "previous"
orderIds	string Comma separated ids
catalogIds	string Comma separated ids
customerBuyerIds	string Comma separated ids
status	string Enum: "order_confirmation_required" "order_confirmation_created" "order_confirmation_approved_by_buyer" "order_confirmation_confirmed" "order_confirmation_rejected_by_buyer" "order_canceled_by_brand" "order_canceled_by_buyer" "order_voided_and_items_returned_to_cart" 注文のステータス order_confirmation_required: 注文内容確認書の作成が必要 order_confirmation_created: 注文内容確認書が作成された order_confirmation_approved_by_buyer: バイヤーによって注文内容確認書が承認された order_confirmation_confirmed: 注文内容確認書が確定された order_confirmation_rejected_by_buyer: バイヤーによって注文内容確認書が拒否された order_canceled_by_brand: ブランドによって注文が取り消された order_canceled_by_buyer: バイヤーによって注文がキャンセルされた order_voided_and_items_returned_to_cart: 注文が無効化され、商品がバイヤーのカートに差し戻された
includeArchived	boolean Default: false アーカイブされた注文を含めるかどうかを指定します。デフォルトではアーカイブされた注文は含まれません。アーカイブされた注文を含める場合はtrueを指定してください。
createdAtFrom	string <date-time> 作成日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtToとセットで使用する必要はありません。
createdAtTo	string <date-time> 作成日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtFromとセットで使用する必要はありません。
updatedAtFrom	string <date-time> 更新日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtToとセットで使用する必要はありません。
updatedAtTo	string <date-time> 更新日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtFromとセットで使用する必要はありません。

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"orders": [{"object": "order",
"orderId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"catalogId": "string",
"originalOrderSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"orderConfirmationSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"brandComment": "string",
"buyerComment": "string",
"internalNote": "string",
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"status": "order_confirmation_required",
"inventoryStatus": "made_to_order",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

注文を作成する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

code	string 注文コードは、ブランド内で一意である必要があります。このフィールドは省略可能です。省略した場合は、自動的に生成されます。
customerBuyerId required	string
catalogId required	string
currencyCode required	string Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" DEXTREでサポートされている通貨コード。
	object or null
	object or null
required	Array of objects
tagIds	Array of strings 注文に関連付けるタグのIDを指定します。 tagCodesも指定されている場合、tagIdsを優先し、tagCodesは無視されます。
tagCodes	Array of strings 注文に関連付けるタグのコードを指定します。 tagIdsも指定されている場合、tagCodesを無視し、tagIdsを優先します。

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"customerBuyerId": "string",
"catalogId": "string",
"currencyCode": "AUD",
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"items": [{"productId": "string",
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"skuItems": [{"skuId": "string",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{"skuOptionVariantId": "string",
"originalPrice": 0,
"price": 0
}
]
}
],
"originalSkuPrice": 0,
"skuPrice": 0,
"originalSkuOptionTotalPrice": 0,
"skuOptionTotalPrice": 0,
"quantity": 0
}
]
}
],
"tagIds": ["string"
],
"tagCodes": ["string"
]
}

Response samples

Content type

application/json

{"data": {"order": {"object": "order",
"orderId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"catalogId": "string",
"originalOrderSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"orderConfirmationSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"brandComment": "string",
"buyerComment": "string",
"internalNote": "string",
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"status": "order_confirmation_required",
"inventoryStatus": "made_to_order",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

注文を取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
orderId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"order": {"object": "order",
"orderId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"catalogId": "string",
"originalOrderSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"orderConfirmationSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"brandComment": "string",
"buyerComment": "string",
"internalNote": "string",
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"status": "order_confirmation_required",
"inventoryStatus": "made_to_order",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

注文を部分更新する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
orderId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

code	string
	object or null
	object or null
tagIds	Array of strings 注文に関連付けるタグのIDを指定します。 tagCodesも指定されている場合、tagIdsを優先し、tagCodesは無視されます。
tagCodes	Array of strings 注文に関連付けるタグのコードを指定します。 tagIdsも指定されている場合、tagCodesを無視し、tagIdsを優先します。

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"tagIds": ["string"
],
"tagCodes": ["string"
]
}

Response samples

Content type

application/json

{"data": {"order": {"object": "order",
"orderId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"catalogId": "string",
"originalOrderSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"orderConfirmationSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"brandComment": "string",
"buyerComment": "string",
"internalNote": "string",
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"status": "order_confirmation_required",
"inventoryStatus": "made_to_order",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

注文をキャンセルする

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
orderId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

tagIds	Array of strings 注文に関連付けるタグのIDを指定します。 tagCodesも指定されている場合、tagIdsを優先し、tagCodesは無視されます。
tagCodes	Array of strings 注文に関連付けるタグのコードを指定します。 tagIdsも指定されている場合、tagCodesを無視し、tagIdsを優先します。

Responses

Request samples

Payload

Content type

application/json

{"tagIds": ["string"
],
"tagCodes": ["string"
]
}

Response samples

Content type

application/json

{"data": { }
}

注文をアーカイブする

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
orderId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Responses

Response samples

Content type

application/json

{"data": { }
}

オリジナル受注データ

OriginalOrder object
バイヤーが発注した通りのオリジナルの受注データを表します。

object	string Default: "original_order"
orderId	string
merchantId	string
brandId	string
customerBuyerId	string 顧客バイヤーのID
	object
catalogId	string
transactionTermCodes	Array of strings Items Enum: "exw" "fca" "cpt" "cip" "dap" "dpu" "ddp" "fas" "fob" "cfr" "cif" "kakeritsu_transaction" "wholesale_transaction"
	Array of objects or objects
currencyCode	string Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" DEXTREでサポートされている通貨コード。
	object
	Array of objects
	Array of objects 在庫割り当て情報です。在庫割り当て情報が存在しない場合は空配列が返されます。 1つの注文に対する在庫割り当て情報は、オリジナル受注データと注文内容確認書データで共通しており、両者に差異がある場合でも常に注文内容確認書データの内容に準拠します。そのため、特にオリジナル受注データ系APIをご利用の場合は、取り扱いや解釈にご注意ください。
status	string Enum: "pending" "finalized" "canceled" "voided"
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "original_order",
"orderId": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"catalogId": "string",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"summary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"items": [{"object": "order_product_item",
"productId": "string",
"modelNumber": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0,
"totalSkuItemsQuantity": 0,
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"skuItems": [{"object": "order_product_sku_item",
"skuItemId": "string",
"skuId": "string",
"skuNumber": "string",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{"skuOptionVariantId": "string",
"originalPrice": 0,
"price": 0
}
]
}
],
"originalSkuPrice": 0,
"skuPrice": 0,
"originalSkuOptionTotalPrice": 0,
"skuOptionTotalPrice": 0,
"totalItemPriceBeforeTax": 0,
"taxes": [{"taxId": "string",
"rate": 0,
"amount": 0
}
],
"estimatedTaxInclusiveTotalItemPrice": 0,
"quantity": 0,
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0
}
],
"buyerComment": "string"
}
],
"inventoryAllocations": [{"productId": "string",
"skuId": "string",
"status": "made_to_order",
"quantity": 0,
"sourceInventoryItemId": "string"
}
],
"status": "pending",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

オリジナル受注データのリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (orderId)
direction	string Enum: "next" "previous"
orderIds	string Comma separated ids
catalogIds	string Comma separated ids
customerBuyerIds	string Comma separated ids
status	string Enum: "pending" "finalized" "canceled" "voided"
createdAtFrom	string <date-time> 作成日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtToとセットで使用する必要はありません。
createdAtTo	string <date-time> 作成日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtFromとセットで使用する必要はありません。
updatedAtFrom	string <date-time> 更新日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtToとセットで使用する必要はありません。
updatedAtTo	string <date-time> 更新日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtFromとセットで使用する必要はありません。

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"originalOrders": [{"object": "original_order",
"orderId": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"catalogId": "string",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"summary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"items": [{"object": "order_product_item",
"productId": "string",
"modelNumber": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0,
"totalSkuItemsQuantity": 0,
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"skuItems": [{"object": "order_product_sku_item",
"skuItemId": "string",
"skuId": "string",
"skuNumber": "string",
"appliedSkuOptions": [{"skuOptionId": null,
"appliedVariants": [ ]
}
],
"originalSkuPrice": 0,
"skuPrice": 0,
"originalSkuOptionTotalPrice": 0,
"skuOptionTotalPrice": 0,
"totalItemPriceBeforeTax": 0,
"taxes": [{"taxId": null,
"rate": null,
"amount": null
}
],
"estimatedTaxInclusiveTotalItemPrice": 0,
"quantity": 0,
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0
}
],
"buyerComment": "string"
}
],
"inventoryAllocations": [{"productId": "string",
"skuId": "string",
"status": "made_to_order",
"quantity": 0,
"sourceInventoryItemId": "string"
}
],
"status": "pending",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

オリジナル受注データを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
orderId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"originalOrder": {"object": "original_order",
"orderId": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"catalogId": "string",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"summary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"items": [{"object": "order_product_item",
"productId": "string",
"modelNumber": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0,
"totalSkuItemsQuantity": 0,
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"skuItems": [{"object": "order_product_sku_item",
"skuItemId": "string",
"skuId": "string",
"skuNumber": "string",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{ }
]
}
],
"originalSkuPrice": 0,
"skuPrice": 0,
"originalSkuOptionTotalPrice": 0,
"skuOptionTotalPrice": 0,
"totalItemPriceBeforeTax": 0,
"taxes": [{"taxId": "string",
"rate": 0,
"amount": 0
}
],
"estimatedTaxInclusiveTotalItemPrice": 0,
"quantity": 0,
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0
}
],
"buyerComment": "string"
}
],
"inventoryAllocations": [{"productId": "string",
"skuId": "string",
"status": "made_to_order",
"quantity": 0,
"sourceInventoryItemId": "string"
}
],
"status": "pending",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

注文内容確認書データ

OrderConfirmation object
注文内容確認書データを表します。

object	string Default: "order_confirmation"
orderId	string
merchantId	string
brandId	string
customerBuyerId	string 顧客バイヤーのID
	object
catalogId	string
transactionTermCodes	Array of strings Items Enum: "exw" "fca" "cpt" "cip" "dap" "dpu" "ddp" "fas" "fob" "cfr" "cif" "kakeritsu_transaction" "wholesale_transaction"
	Array of objects or objects
currencyCode	string Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" DEXTREでサポートされている通貨コード。
	object
	Array of objects
	Array of objects 在庫割り当て情報です。在庫割り当て情報が存在しない場合は空配列が返されます。 1つの注文に対する在庫割り当て情報は、オリジナル受注データと注文内容確認書データで共通しており、両者に差異がある場合でも常に注文内容確認書データの内容に準拠します。そのため、特にオリジナル受注データ系APIをご利用の場合は、取り扱いや解釈にご注意ください。
status	string Enum: "pending" "approved" "confirmed" "rejected" "canceled" "voided" 注文内容確認書のステータス pending: 注文内容確認書が作成された直後の状態 approved: 注文内容確認書がバイヤーにより承認された状態。まだ未確定。 confirmed: 注文内容確認書がブランドにより確定された状態 (注文が確定した状態) rejected: バイヤーにより注文内容確認書が拒否された状態 canceled: キャンセル (注文がキャンセルになった状態) voided: 無効状態
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "order_confirmation",
"orderId": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"catalogId": "string",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"summary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"items": [{"object": "order_product_item",
"productId": "string",
"modelNumber": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0,
"totalSkuItemsQuantity": 0,
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"skuItems": [{"object": "order_product_sku_item",
"skuItemId": "string",
"skuId": "string",
"skuNumber": "string",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{"skuOptionVariantId": "string",
"originalPrice": 0,
"price": 0
}
]
}
],
"originalSkuPrice": 0,
"skuPrice": 0,
"originalSkuOptionTotalPrice": 0,
"skuOptionTotalPrice": 0,
"totalItemPriceBeforeTax": 0,
"taxes": [{"taxId": "string",
"rate": 0,
"amount": 0
}
],
"estimatedTaxInclusiveTotalItemPrice": 0,
"quantity": 0,
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0
}
],
"buyerComment": "string"
}
],
"inventoryAllocations": [{"productId": "string",
"skuId": "string",
"status": "made_to_order",
"quantity": 0,
"sourceInventoryItemId": "string"
}
],
"status": "pending",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

注文内容確認書の一覧を取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (orderId)
direction	string Enum: "next" "previous"
orderIds	string Comma separated ids
catalogIds	string Comma separated ids
customerBuyerIds	string Comma separated ids
status	string Enum: "pending" "approved" "confirmed" "rejected" "canceled" "voided" 注文内容確認書のステータス pending: 注文内容確認書が作成された直後の状態 approved: 注文内容確認書がバイヤーにより承認された状態。まだ未確定。 confirmed: 注文内容確認書がブランドにより確定された状態 (注文が確定した状態) rejected: バイヤーにより注文内容確認書が拒否された状態 canceled: キャンセル (注文がキャンセルになった状態) voided: 無効状態
createdAtFrom	string <date-time> 作成日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtToとセットで使用する必要はありません。
createdAtTo	string <date-time> 作成日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもcreatedAtFromとセットで使用する必要はありません。
updatedAtFrom	string <date-time> 更新日時での絞り込みを行う場合は、開始日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtToとセットで使用する必要はありません。
updatedAtTo	string <date-time> 更新日時での絞り込みを行う場合は、終了日時をISO 8601 format (eg. 2021-01-15T00:00:00Z)で指定してください。このパラメータは独立して使用可能です。必ずしもupdatedAtFromとセットで使用する必要はありません。

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"orderConfirmations": [{"object": "order_confirmation",
"orderId": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"catalogId": "string",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"summary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"items": [{"object": "order_product_item",
"productId": "string",
"modelNumber": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0,
"totalSkuItemsQuantity": 0,
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"skuItems": [{"object": "order_product_sku_item",
"skuItemId": "string",
"skuId": "string",
"skuNumber": "string",
"appliedSkuOptions": [{"skuOptionId": null,
"appliedVariants": [ ]
}
],
"originalSkuPrice": 0,
"skuPrice": 0,
"originalSkuOptionTotalPrice": 0,
"skuOptionTotalPrice": 0,
"totalItemPriceBeforeTax": 0,
"taxes": [{"taxId": null,
"rate": null,
"amount": null
}
],
"estimatedTaxInclusiveTotalItemPrice": 0,
"quantity": 0,
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0
}
],
"buyerComment": "string"
}
],
"inventoryAllocations": [{"productId": "string",
"skuId": "string",
"status": "made_to_order",
"quantity": 0,
"sourceInventoryItemId": "string"
}
],
"status": "pending",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

注文内容確認書を作成する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

orderId required	string 注文内容確認書を作成する注文のIDを指定します。注文のステータスがorder_confirmation_requiredの場合のみ、注文内容確認書を作成することができます。
required	Array of objects
sendBuyerNotificationEmail	boolean 注文内容確認書を作成する際に、対象バイヤーに通知メールを送信するかどうかを指定します。デフォルトではfalseとなり、通知メールを送信しません。
tagIds	Array of strings 注文に関連付けるタグのIDを指定します。 tagCodesも指定されている場合、tagIdsを優先し、tagCodesは無視されます。
tagCodes	Array of strings 注文に関連付けるタグのコードを指定します。 tagIdsも指定されている場合、tagCodesを無視し、tagIdsを優先します。

Responses

Request samples

Payload

Content type

application/json

{"orderId": "string",
"items": [{"productId": "string",
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"skuItems": [{"skuId": "string",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{"skuOptionVariantId": "string",
"originalPrice": 0,
"price": 0
}
]
}
],
"originalSkuPrice": 0,
"skuPrice": 0,
"originalSkuOptionTotalPrice": 0,
"skuOptionTotalPrice": 0,
"quantity": 0
}
]
}
],
"sendBuyerNotificationEmail": true,
"tagIds": ["string"
],
"tagCodes": ["string"
]
}

Response samples

Content type

application/json

{"data": {"order": {"object": "order",
"orderId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"catalogId": "string",
"originalOrderSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"orderConfirmationSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"brandComment": "string",
"buyerComment": "string",
"internalNote": "string",
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"status": "order_confirmation_required",
"inventoryStatus": "made_to_order",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"orderConfirmation": {"object": "order_confirmation",
"orderId": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"catalogId": "string",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"summary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"items": [{"object": "order_product_item",
"productId": "string",
"modelNumber": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0,
"totalSkuItemsQuantity": 0,
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"skuItems": [{"object": "order_product_sku_item",
"skuItemId": "string",
"skuId": "string",
"skuNumber": "string",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{ }
]
}
],
"originalSkuPrice": 0,
"skuPrice": 0,
"originalSkuOptionTotalPrice": 0,
"skuOptionTotalPrice": 0,
"totalItemPriceBeforeTax": 0,
"taxes": [{"taxId": "string",
"rate": 0,
"amount": 0
}
],
"estimatedTaxInclusiveTotalItemPrice": 0,
"quantity": 0,
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0
}
],
"buyerComment": "string"
}
],
"inventoryAllocations": [{"productId": "string",
"skuId": "string",
"status": "made_to_order",
"quantity": 0,
"sourceInventoryItemId": "string"
}
],
"status": "pending",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

注文内容確認書を取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
orderId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

Content type

application/json

{"data": {"orderConfirmation": {"object": "order_confirmation",
"orderId": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"catalogId": "string",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"summary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"items": [{"object": "order_product_item",
"productId": "string",
"modelNumber": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0,
"totalSkuItemsQuantity": 0,
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"skuItems": [{"object": "order_product_sku_item",
"skuItemId": "string",
"skuId": "string",
"skuNumber": "string",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{ }
]
}
],
"originalSkuPrice": 0,
"skuPrice": 0,
"originalSkuOptionTotalPrice": 0,
"skuOptionTotalPrice": 0,
"totalItemPriceBeforeTax": 0,
"taxes": [{"taxId": "string",
"rate": 0,
"amount": 0
}
],
"estimatedTaxInclusiveTotalItemPrice": 0,
"quantity": 0,
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0
}
],
"buyerComment": "string"
}
],
"inventoryAllocations": [{"productId": "string",
"skuId": "string",
"status": "made_to_order",
"quantity": 0,
"sourceInventoryItemId": "string"
}
],
"status": "pending",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

注文内容確認書を更新する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
orderId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

required	Array of objects
sendBuyerNotificationEmail	boolean 注文内容確認書を更新する際に、対象バイヤーに通知メールを送信するかどうかを指定します。デフォルトではfalseとなり、通知メールを送信しません。 trueの場合は、注文内容確認書を更新する際に、対象バイヤーに通知メールを送信します。 falseの場合は、注文内容確認書を更新する際に、対象バイヤーに通知メールを送信しません。
tagIds	Array of strings 注文に関連付けるタグのIDを指定します。 tagCodesも指定されている場合、tagIdsを優先し、tagCodesは無視されます。
tagCodes	Array of strings 注文に関連付けるタグのコードを指定します。 tagIdsも指定されている場合、tagCodesを無視し、tagIdsを優先します。

Responses

Request samples

Payload

Content type

application/json

{"items": [{"productId": "string",
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"skuItems": [{"skuId": "string",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{"skuOptionVariantId": "string",
"originalPrice": 0,
"price": 0
}
]
}
],
"originalSkuPrice": 0,
"skuPrice": 0,
"originalSkuOptionTotalPrice": 0,
"skuOptionTotalPrice": 0,
"quantity": 0
}
]
}
],
"sendBuyerNotificationEmail": true,
"tagIds": ["string"
],
"tagCodes": ["string"
]
}

Response samples

Content type

application/json

{"data": {"order": {"object": "order",
"orderId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"catalogId": "string",
"originalOrderSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"orderConfirmationSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"brandComment": "string",
"buyerComment": "string",
"internalNote": "string",
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"status": "order_confirmation_required",
"inventoryStatus": "made_to_order",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"orderConfirmation": {"object": "order_confirmation",
"orderId": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"catalogId": "string",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"summary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"items": [{"object": "order_product_item",
"productId": "string",
"modelNumber": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0,
"totalSkuItemsQuantity": 0,
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"skuItems": [{"object": "order_product_sku_item",
"skuItemId": "string",
"skuId": "string",
"skuNumber": "string",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{ }
]
}
],
"originalSkuPrice": 0,
"skuPrice": 0,
"originalSkuOptionTotalPrice": 0,
"skuOptionTotalPrice": 0,
"totalItemPriceBeforeTax": 0,
"taxes": [{"taxId": "string",
"rate": 0,
"amount": 0
}
],
"estimatedTaxInclusiveTotalItemPrice": 0,
"quantity": 0,
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0
}
],
"buyerComment": "string"
}
],
"inventoryAllocations": [{"productId": "string",
"skuId": "string",
"status": "made_to_order",
"quantity": 0,
"sourceInventoryItemId": "string"
}
],
"status": "pending",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

注文内容確認書を削除する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
orderId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Responses

Response samples

Content type

application/json

{"data": { }
}

注文内容確認書を確定する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
orderId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json

notifyBuyerByEmail	boolean 注文内容確認書を確定する際に、対象バイヤーに通知メールを送信するかどうかを指定します。 trueの場合は、対象バイヤーに通知メールを送信します。 falseの場合は、対象バイヤーに通知メールを送信しません。未指定の場合は、対象バイヤーに通知メールを送信しません。
tagIds	Array of strings 注文に関連付けるタグのIDを指定します。 tagCodesも指定されている場合、tagIdsを優先し、tagCodesは無視されます。
tagCodes	Array of strings 注文に関連付けるタグのコードを指定します。 tagIdsも指定されている場合、tagCodesを無視し、tagIdsを優先します。

Responses

Request samples

Payload

Content type

application/json

{"notifyBuyerByEmail": true,
"tagIds": ["string"
],
"tagCodes": ["string"
]
}

Response samples

Content type

application/json

{"data": {"order": {"object": "order",
"orderId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"catalogId": "string",
"originalOrderSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"orderConfirmationSummary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"brandComment": "string",
"buyerComment": "string",
"internalNote": "string",
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"status": "order_confirmation_required",
"inventoryStatus": "made_to_order",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"orderConfirmation": {"object": "order_confirmation",
"orderId": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"customerBuyer": {"code": "string",
"customerCode": "string"
},
"catalogId": "string",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"currencyCode": "AUD",
"summary": {"itemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"orderSubtotalAmount": 0,
"orderTaxAmount": 0,
"orderTotalAmount": 0
},
"items": [{"object": "order_product_item",
"productId": "string",
"modelNumber": "string",
"localizedNames": [{"languageCode": "ja",
"text": "string"
}
],
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0,
"totalSkuItemsQuantity": 0,
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"skuItems": [{"object": "order_product_sku_item",
"skuItemId": "string",
"skuId": "string",
"skuNumber": "string",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{ }
]
}
],
"originalSkuPrice": 0,
"skuPrice": 0,
"originalSkuOptionTotalPrice": 0,
"skuOptionTotalPrice": 0,
"totalItemPriceBeforeTax": 0,
"taxes": [{"taxId": "string",
"rate": 0,
"amount": 0
}
],
"estimatedTaxInclusiveTotalItemPrice": 0,
"quantity": 0,
"subtotalAmount": 0,
"estimatedTaxAmount": 0,
"estimatedTotalAmount": 0
}
],
"buyerComment": "string"
}
],
"inventoryAllocations": [{"productId": "string",
"skuId": "string",
"status": "made_to_order",
"quantity": 0,
"sourceInventoryItemId": "string"
}
],
"status": "pending",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

納品書

DeliveryNote object

object	string Default: "delivery_note"
deliveryNoteId	string
code	string
merchantId	string
brandId	string
customerBuyerId	string
dataSource	string Enum: "unfulfilled_sku_item" "paid_unfulfilled_sku_item" "order_confirmation" "partner_inventory_item" "direct_entry"
pdfLongText	string
pdfShortText	string
brandNote	string
currencyCode	string Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" DEXTREでサポートされている通貨コード。
transactionTermCodes	Array of strings Items Enum: "exw" "fca" "cpt" "cip" "dap" "dpu" "ddp" "fas" "fob" "cfr" "cif" "kakeritsu_transaction" "wholesale_transaction"
	Array of objects or objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
subtotalAmount	number
totalTaxAmount	number
totalAmount	number subtotalAmount + totalTaxAmount
	object or null
isEligibleForInvoicing	boolean 請求書作成可能対象かどうか (請求書のデータソースとして使用できるかどうか) true: 請求対象 false: 請求対象外
invoiceStatus	string Enum: "not_invoiced" "invoiced"
invoiceIds	Array of strings
	Array of objects
deliveryDate	string or null <date-time>
status	string Default: "open" Enum: "open" "completed"
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "delivery_note",
"deliveryNoteId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"dataSource": "unfulfilled_sku_item",
"pdfLongText": "string",
"pdfShortText": "string",
"brandNote": "string",
"currencyCode": "AUD",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"skuLineItems": [{"lineItemId": "string",
"contextualSkuItemId": "string",
"skuId": "string",
"productId": "string",
"skuNumber": "string",
"modelNumber": "string",
"deliveryDate": {"type": "date_range",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{"skuOptionVariantId": "string",
"unitOriginalPrice": 0,
"unitPrice": 0
}
]
}
],
"unitBaseOriginalPrice": 0,
"unitBasePrice": 0,
"unitSkuOptionsOriginalPrice": 0,
"unitSkuOptionsPrice": 0,
"unitFinalPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"customLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"unitPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"shippingFeeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"otherChargeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"subtotalAmount": 0,
"totalTaxAmount": 0,
"totalAmount": 0,
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"isEligibleForInvoicing": true,
"invoiceStatus": "not_invoiced",
"invoiceIds": ["string"
],
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"deliveryDate": "2019-08-24T14:15:22Z",
"status": "open",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

納品書のリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (deliveryNoteId)
direction	string Enum: "next" "previous"
deliveryNoteIds	string Comma separated ids

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"deliveryNotes": [{"object": "delivery_note",
"deliveryNoteId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"dataSource": "unfulfilled_sku_item",
"pdfLongText": "string",
"pdfShortText": "string",
"brandNote": "string",
"currencyCode": "AUD",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"skuLineItems": [{"lineItemId": "string",
"contextualSkuItemId": "string",
"skuId": "string",
"productId": "string",
"skuNumber": "string",
"modelNumber": "string",
"deliveryDate": {"type": "date_range",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{"skuOptionVariantId": null,
"unitOriginalPrice": null,
"unitPrice": null
}
]
}
],
"unitBaseOriginalPrice": 0,
"unitBasePrice": 0,
"unitSkuOptionsOriginalPrice": 0,
"unitSkuOptionsPrice": 0,
"unitFinalPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"customLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"unitPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"shippingFeeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"otherChargeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"subtotalAmount": 0,
"totalTaxAmount": 0,
"totalAmount": 0,
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"isEligibleForInvoicing": true,
"invoiceStatus": "not_invoiced",
"invoiceIds": ["string"
],
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"deliveryDate": "2019-08-24T14:15:22Z",
"status": "open",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

納品書を作成する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

code	string 伝票番号
customerBuyerId required	string 顧客バイヤーID
dataSource required	string Value: "direct_entry"
pdfLongText	string
pdfShortText	string
brandNote	string
currencyCode required	string Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" DEXTREでサポートされている通貨コード。
	object or null
	Array of objects
	Array of objects
	Array of objects
	Array of objects
isInvoicingAllowed	boolean この納品書を請求可能にするかどうか (省略した場合は true)
deliveryDate	string or null <date-time>
tagIds	Array of strings 納品書に関連付けるタグのIDを指定します。 tagCodesも指定されている場合、tagIdsを優先し、tagCodesは無視されます。
tagCodes	Array of strings 納品書に関連付けるタグのコードを指定します。 tagIdsも指定されている場合、tagCodesを無視し、tagIdsを優先します。

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"customerBuyerId": "string",
"dataSource": "direct_entry",
"pdfLongText": "string",
"pdfShortText": "string",
"brandNote": "string",
"currencyCode": "AUD",
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"skuLineItems": [{"productId": "string",
"skuId": "string",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"unitBaseOriginalPrice": 0,
"unitBasePrice": 0,
"quantity": 0
}
],
"customLineItems": [{"name": "string",
"description": "string",
"unitPrice": 0,
"quantity": 0,
"taxes": [{"taxId": "string"
}
]
}
],
"shippingFeeLineItems": [{"name": "string",
"description": "string",
"unitPrice": 0,
"taxes": [{"taxId": "string"
}
]
}
],
"otherChargeLineItems": [{"name": "string",
"description": "string",
"unitPrice": 0,
"taxes": [{"taxId": "string"
}
]
}
],
"isInvoicingAllowed": true,
"deliveryDate": "2019-08-24T14:15:22Z",
"tagIds": ["string"
],
"tagCodes": ["string"
]
}

Response samples

201
400
401
403
429

Content type

application/json

{"data": {"deliveryNote": {"object": "delivery_note",
"deliveryNoteId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"dataSource": "unfulfilled_sku_item",
"pdfLongText": "string",
"pdfShortText": "string",
"brandNote": "string",
"currencyCode": "AUD",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"skuLineItems": [{"lineItemId": "string",
"contextualSkuItemId": "string",
"skuId": "string",
"productId": "string",
"skuNumber": "string",
"modelNumber": "string",
"deliveryDate": {"type": "date_range",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{"skuOptionVariantId": "string",
"unitOriginalPrice": 0,
"unitPrice": 0
}
]
}
],
"unitBaseOriginalPrice": 0,
"unitBasePrice": 0,
"unitSkuOptionsOriginalPrice": 0,
"unitSkuOptionsPrice": 0,
"unitFinalPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"customLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"unitPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"shippingFeeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"otherChargeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"subtotalAmount": 0,
"totalTaxAmount": 0,
"totalAmount": 0,
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"isEligibleForInvoicing": true,
"invoiceStatus": "not_invoiced",
"invoiceIds": ["string"
],
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"deliveryDate": "2019-08-24T14:15:22Z",
"status": "open",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

納品書を取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
deliveryNoteId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"data": {"deliveryNote": {"object": "delivery_note",
"deliveryNoteId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"dataSource": "unfulfilled_sku_item",
"pdfLongText": "string",
"pdfShortText": "string",
"brandNote": "string",
"currencyCode": "AUD",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"skuLineItems": [{"lineItemId": "string",
"contextualSkuItemId": "string",
"skuId": "string",
"productId": "string",
"skuNumber": "string",
"modelNumber": "string",
"deliveryDate": {"type": "date_range",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{"skuOptionVariantId": "string",
"unitOriginalPrice": 0,
"unitPrice": 0
}
]
}
],
"unitBaseOriginalPrice": 0,
"unitBasePrice": 0,
"unitSkuOptionsOriginalPrice": 0,
"unitSkuOptionsPrice": 0,
"unitFinalPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"customLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"unitPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"shippingFeeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"otherChargeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"subtotalAmount": 0,
"totalTaxAmount": 0,
"totalAmount": 0,
"buyerDeliveryAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"isEligibleForInvoicing": true,
"invoiceStatus": "not_invoiced",
"invoiceIds": ["string"
],
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"deliveryDate": "2019-08-24T14:15:22Z",
"status": "open",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

納品書を削除する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
deliveryNoteId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"data": { }
}

返品伝票

GoodsReturnNote object

object	string Default: "goods_return_note"
goodsReturnNoteId	string
code	string
merchantId	string
brandId	string
customerBuyerId	string
dataSource	string Enum: "delivery_note" "custom_entry"
sourceDeliveryNoteId	string or null
reason	string
currencyCode	string Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" DEXTREでサポートされている通貨コード。
skuItemsSubtotalAmount	number
customItemsSubtotalAmount	number
shippingFeesSubtotalAmount	number
otherChargesSubtotalAmount	number
subtotalAmount	number
taxAmount	number
totalAmount	number
pdfShortText	string
documentDate	string or null <date-time>
createdAt	string <date-time> リソースの作成日時。 ISO 8601形式のUTC日時で表現されます。例: 2024-04-18T04:50:40Z
updatedAt	string <date-time> リソースの更新日時。 ISO 8601形式のUTC日時で表現されます。例: 2025-01-10T09:50:40Z

{"object": "goods_return_note",
"goodsReturnNoteId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"dataSource": "delivery_note",
"sourceDeliveryNoteId": "string",
"reason": "string",
"currencyCode": "AUD",
"skuItemsSubtotalAmount": 0,
"customItemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"subtotalAmount": 0,
"taxAmount": 0,
"totalAmount": 0,
"pdfShortText": "string",
"documentDate": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

返品伝票のリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (goodsReturnNoteId)
direction	string Enum: "next" "previous"
goodsReturnNoteIds	string Comma separated ids

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"goodsReturnNotes": [{"object": "goods_return_note",
"goodsReturnNoteId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"dataSource": "delivery_note",
"sourceDeliveryNoteId": "string",
"reason": "string",
"currencyCode": "AUD",
"skuItemsSubtotalAmount": 0,
"customItemsSubtotalAmount": 0,
"shippingFeesSubtotalAmount": 0,
"otherChargesSubtotalAmount": 0,
"subtotalAmount": 0,
"taxAmount": 0,
"totalAmount": 0,
"pdfShortText": "string",
"documentDate": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

請求書

Invoice object
請求書情報を表します。

object	string Default: "invoice"
invoiceId	string
code	string
merchantId	string
brandId	string
customerBuyerId	string
dataSource	string Enum: "delivery_note" "order_confirmation" "deposit_invoice" "direct_entry"
pdfLongText	string
pdfShortText	string
brandNote	string
currencyCode	string Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" DEXTREでサポートされている通貨コード。
transactionTermCodes	Array of strings Items Enum: "exw" "fca" "cpt" "cip" "dap" "dpu" "ddp" "fas" "fob" "cfr" "cif" "kakeritsu_transaction" "wholesale_transaction"
	Array of objects or objects
sourceOrderIds	Array of strings
sourceDeliveryNoteIds	Array of strings
depositInvoiceId	string or null
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	object or null
	object or null
invoiceTotalAmount	number
	object or null
	Array of objects
status	string Enum: "draft" "issued"
invoiceDueAt	string or null <date-time>
invoiceDate	string or null <date-time>
createdAt	string <date-time>
updatedAt	string <date-time>

{"object": "invoice",
"invoiceId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"dataSource": "delivery_note",
"pdfLongText": "string",
"pdfShortText": "string",
"brandNote": "string",
"currencyCode": "AUD",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"sourceOrderIds": ["string"
],
"sourceDeliveryNoteIds": ["string"
],
"depositInvoiceId": "string",
"skuLineItems": [{"lineItemId": "string",
"contextualSkuItemId": "string",
"skuId": "string",
"productId": "string",
"skuNumber": "string",
"modelNumber": "string",
"deliveryDate": {"type": "date_range",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{"skuOptionVariantId": "string",
"unitOriginalPrice": 0,
"unitPrice": 0
}
]
}
],
"unitBaseOriginalPrice": 0,
"unitBasePrice": 0,
"unitSkuOptionsOriginalPrice": 0,
"unitSkuOptionsPrice": 0,
"unitFinalPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"customLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"unitPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"shippingFeeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"otherChargeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"appliedCreditNotes": [{"creditNoteId": "string",
"totalAmount": 0
}
],
"appliedGoodsReturnNotes": [{"goodsReturnNoteId": "string",
"totalAmount": 0
}
],
"appliedBillingBalance": {"billingBalanceId": "string",
"appliedAmount": 0
},
"sellerBorne": {"bankTransferFeeAmount": 0,
"taxes": [{"taxId": "string",
"taxableAmount": 0,
"taxAmount": 0
}
],
"totalTaxAmount": 0,
"totalBorneAmount": 0
},
"invoiceTotalAmount": 0,
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"status": "draft",
"invoiceDueAt": "2019-08-24T14:15:22Z",
"invoiceDate": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

請求書のリストを取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

query Parameters

limit	integer [ 1 .. 100 ] Default: 20
cursor	string Cursor to fetch next or previous page (invoiceId)
direction	string Enum: "next" "previous"
invoiceIds	string Comma separated ids

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"invoices": [{"object": "invoice",
"invoiceId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"dataSource": "delivery_note",
"pdfLongText": "string",
"pdfShortText": "string",
"brandNote": "string",
"currencyCode": "AUD",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"sourceOrderIds": ["string"
],
"sourceDeliveryNoteIds": ["string"
],
"depositInvoiceId": "string",
"skuLineItems": [{"lineItemId": "string",
"contextualSkuItemId": "string",
"skuId": "string",
"productId": "string",
"skuNumber": "string",
"modelNumber": "string",
"deliveryDate": {"type": "date_range",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{"skuOptionVariantId": null,
"unitOriginalPrice": null,
"unitPrice": null
}
]
}
],
"unitBaseOriginalPrice": 0,
"unitBasePrice": 0,
"unitSkuOptionsOriginalPrice": 0,
"unitSkuOptionsPrice": 0,
"unitFinalPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"customLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"unitPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"shippingFeeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"otherChargeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"appliedCreditNotes": [{"creditNoteId": "string",
"totalAmount": 0
}
],
"appliedGoodsReturnNotes": [{"goodsReturnNoteId": "string",
"totalAmount": 0
}
],
"appliedBillingBalance": {"billingBalanceId": "string",
"appliedAmount": 0
},
"sellerBorne": {"bankTransferFeeAmount": 0,
"taxes": [{"taxId": "string",
"taxableAmount": 0,
"taxAmount": 0
}
],
"totalTaxAmount": 0,
"totalBorneAmount": 0
},
"invoiceTotalAmount": 0,
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"status": "draft",
"invoiceDueAt": "2019-08-24T14:15:22Z",
"invoiceDate": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}

請求書を作成する

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

code	string 伝票番号
customerBuyerId required	string 顧客バイヤーID
dataSource required	string Value: "direct_entry"
pdfLongText	string
pdfShortText	string
brandNote	string
currencyCode required	string Enum: "AUD" "CAD" "CNY" "DKK" "HKD" "INR" "IDR" "JPY" "KRW" "MYR" "NOK" "PHP" "RUB" "SGD" "VND" "SEK" "CHF" "THB" "GBP" "USD" "TWD" "EUR" "BRL" DEXTREでサポートされている通貨コード。
	object or null
	Array of objects
	Array of objects
	Array of objects
	Array of objects
invoiceDueAt	string or null <date-time>
invoiceDate	string or null <date-time>
tagIds	Array of strings 請求書に関連付けるタグのIDを指定します。 tagCodesも指定されている場合、tagIdsを優先し、tagCodesは無視されます。
tagCodes	Array of strings 請求書に関連付けるタグのコードを指定します。 tagIdsも指定されている場合、tagCodesを無視し、tagIdsを優先します。

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"customerBuyerId": "string",
"dataSource": "direct_entry",
"pdfLongText": "string",
"pdfShortText": "string",
"brandNote": "string",
"currencyCode": "AUD",
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"skuLineItems": [{"productId": "string",
"skuId": "string",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"unitBaseOriginalPrice": 0,
"unitBasePrice": 0,
"quantity": 0
}
],
"customLineItems": [{"name": "string",
"description": "string",
"unitPrice": 0,
"quantity": 0,
"taxes": [{"taxId": "string"
}
]
}
],
"shippingFeeLineItems": [{"name": "string",
"description": "string",
"unitPrice": 0,
"taxes": [{"taxId": "string"
}
]
}
],
"otherChargeLineItems": [{"name": "string",
"description": "string",
"unitPrice": 0,
"taxes": [{"taxId": "string"
}
]
}
],
"invoiceDueAt": "2019-08-24T14:15:22Z",
"invoiceDate": "2019-08-24T14:15:22Z",
"tagIds": ["string"
],
"tagCodes": ["string"
]
}

Response samples

201
400
401
403
429

Content type

application/json

{"data": {"invoice": {"object": "invoice",
"invoiceId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"dataSource": "delivery_note",
"pdfLongText": "string",
"pdfShortText": "string",
"brandNote": "string",
"currencyCode": "AUD",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"sourceOrderIds": ["string"
],
"sourceDeliveryNoteIds": ["string"
],
"depositInvoiceId": "string",
"skuLineItems": [{"lineItemId": "string",
"contextualSkuItemId": "string",
"skuId": "string",
"productId": "string",
"skuNumber": "string",
"modelNumber": "string",
"deliveryDate": {"type": "date_range",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{"skuOptionVariantId": "string",
"unitOriginalPrice": 0,
"unitPrice": 0
}
]
}
],
"unitBaseOriginalPrice": 0,
"unitBasePrice": 0,
"unitSkuOptionsOriginalPrice": 0,
"unitSkuOptionsPrice": 0,
"unitFinalPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"customLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"unitPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"shippingFeeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"otherChargeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"appliedCreditNotes": [{"creditNoteId": "string",
"totalAmount": 0
}
],
"appliedGoodsReturnNotes": [{"goodsReturnNoteId": "string",
"totalAmount": 0
}
],
"appliedBillingBalance": {"billingBalanceId": "string",
"appliedAmount": 0
},
"sellerBorne": {"bankTransferFeeAmount": 0,
"taxes": [{"taxId": "string",
"taxableAmount": 0,
"taxAmount": 0
}
],
"totalTaxAmount": 0,
"totalBorneAmount": 0
},
"invoiceTotalAmount": 0,
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"status": "draft",
"invoiceDueAt": "2019-08-24T14:15:22Z",
"invoiceDate": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

請求書を取得する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
invoiceId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"data": {"invoice": {"object": "invoice",
"invoiceId": "string",
"code": "string",
"merchantId": "string",
"brandId": "string",
"customerBuyerId": "string",
"dataSource": "delivery_note",
"pdfLongText": "string",
"pdfShortText": "string",
"brandNote": "string",
"currencyCode": "AUD",
"transactionTermCodes": ["exw"
],
"transactionTermRates": [{"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
}
],
"sourceOrderIds": ["string"
],
"sourceDeliveryNoteIds": ["string"
],
"depositInvoiceId": "string",
"skuLineItems": [{"lineItemId": "string",
"contextualSkuItemId": "string",
"skuId": "string",
"productId": "string",
"skuNumber": "string",
"modelNumber": "string",
"deliveryDate": {"type": "date_range",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"transactionTermCode": "exw",
"transactionTermRate": {"transactionTermCode": "exw",
"rateApplicationMethod": "discount",
"rate": 1
},
"priceType": "manual_price",
"appliedSkuOptions": [{"skuOptionId": "string",
"appliedVariants": [{"skuOptionVariantId": "string",
"unitOriginalPrice": 0,
"unitPrice": 0
}
]
}
],
"unitBaseOriginalPrice": 0,
"unitBasePrice": 0,
"unitSkuOptionsOriginalPrice": 0,
"unitSkuOptionsPrice": 0,
"unitFinalPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"customLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"unitPrice": 0,
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"quantity": 0,
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"shippingFeeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"otherChargeLineItems": [{"lineItemId": "string",
"name": "string",
"description": "string",
"taxes": [{"taxId": "string",
"taxRate": 0,
"estimatedTaxableAmount": 0,
"estimatedTaxAmount": 0
}
],
"lineSubtotalAmount": 0,
"estimatedLineTaxAmount": 0
}
],
"appliedCreditNotes": [{"creditNoteId": "string",
"totalAmount": 0
}
],
"appliedGoodsReturnNotes": [{"goodsReturnNoteId": "string",
"totalAmount": 0
}
],
"appliedBillingBalance": {"billingBalanceId": "string",
"appliedAmount": 0
},
"sellerBorne": {"bankTransferFeeAmount": 0,
"taxes": [{"taxId": "string",
"taxableAmount": 0,
"taxAmount": 0
}
],
"totalTaxAmount": 0,
"totalBorneAmount": 0
},
"invoiceTotalAmount": 0,
"buyerBillingAddress": {"object": "address",
"code": "string",
"name": "string",
"countryCode": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"email": "string",
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"taxIdentificationNumber": "string"
},
"tags": [{"tagId": "string",
"code": "string",
"name": "string",
"description": "string"
}
],
"status": "draft",
"invoiceDueAt": "2019-08-24T14:15:22Z",
"invoiceDate": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

請求書を削除する

Authorizations:

ApiKeyAuth

path Parameters

brandId required	string
invoiceId required	string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"data": { }
}

クレジットノート

クレジットノートに関するAPIエンドポイント

入金確認伝票

入金確認伝票に関するAPIエンドポイント

伝票番号採番ルール

DocumentNumberingRule object
伝票番号の採番ルールを表します。

object	string Default: "document_numbering_rule" リソース種別を示す定数です。
ruleId	string 伝票番号採番ルールの一意なID。
merchantId	string ルールが属するマーチャントのID。
brandId	string ルールが属するブランドのID。
documentType	string Enum: "order" "delivery_note" "goods_return_note" "invoice" "credit_note" "payment_confirmation" "export_document" 伝票番号採番ルールを適用する伝票種別。
fixedPrefix	string 伝票番号の先頭に付与する固定文字列。空文字を許容します。
fixedSuffix	string 伝票番号の末尾に付与する固定文字列。空文字を許容します。
	object or object 動的プレフィックスの構成方法。
timeZone	string Enum: "Asia/Tokyo" "UTC" 動的プレフィックスの日時解決で使用するタイムゾーン。
minDigits	integer >= 1 番号部分の最小桁数。不足分はゼロパディングされます。
status	string Enum: "active" "inactive" 伝票番号採番ルールのステータス。
createdAt	string <date-time> ルールの作成日時 (ISO 8601 UTC)。
updatedAt	string <date-time> ルールの最終更新日時 (ISO 8601 UTC)。

{"object": "document_numbering_rule",
"ruleId": "string",
"merchantId": "string",
"brandId": "string",
"documentType": "order",
"fixedPrefix": "string",
"fixedSuffix": "string",
"dynamicPrefixKind": {"type": "NONE"
},
"timeZone": "Asia/Tokyo",
"minDigits": 1,
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

伝票番号採番ルールを検索する

伝票種別ごとに適用されている採番ルールを検索します。
結果はカーソルベースでページングされます。

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

limit	integer [ 1 .. 100 ] Default: 20 1リクエストで取得する件数。最大100件。
cursor	string 次ページまたは前ページ取得に使用するカーソル。
direction	string Default: "next" Enum: "next" "previous" カーソルの進行方向。
documentTypes required	Array of strings non-empty Items Enum: "order" "delivery_note" "goods_return_note" "invoice" "credit_note" "payment_confirmation" "export_document" 検索対象の伝票種別リスト。

Responses

Request samples

Payload

Content type

application/json

{"limit": 20,
"cursor": "string",
"direction": "next",
"documentTypes": ["order"
]
}

Response samples

Content type

application/json

{"pagination": {"nextCursor": "string",
"previousCursor": "string"
},
"data": {"rules": [{"object": "document_numbering_rule",
"ruleId": "string",
"merchantId": "string",
"brandId": "string",
"documentType": "order",
"fixedPrefix": "string",
"fixedSuffix": "string",
"dynamicPrefixKind": {"type": "NONE"
},
"timeZone": "Asia/Tokyo",
"minDigits": 1,
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"error": {"statusCode": 0,
"messages": ["string"
]
}
}

伝票番号採番ルールを設定または更新する

指定した伝票種別に対する採番ルールを新規作成または更新します。
同一documentTypeに対しては常に最新のルールが上書きされます。

Authorizations:

ApiKeyAuth

path Parameters

brandId

required

string

header Parameters

X-Merchant-API-Key required	string Examples: sk_live_... - 発行したAPIキーを指定してください。
X-Merchant-API-Version	string Default: latest Enum: "latest" "v1" "beta" Examples: latest - バージョンを指定してください。なお、betaを指定した場合は、常に最新版が適用されます。バージョンを指定しない場合は、最新版が適用されます。現状は、latestとv1とbetaは同じバージョンです。
Content-Type required	string Default: application/json

Request Body schema: application/json
required

documentType required	string Enum: "order" "delivery_note" "goods_return_note" "invoice" "credit_note" "payment_confirmation" "export_document" 伝票番号採番ルールを適用する伝票種別。
fixedPrefix	string 固定プレフィックス。空文字可。
fixedSuffix	string 固定サフィックス。空文字可。
	object or object
timeZone	string Enum: "Asia/Tokyo" "UTC" 動的プレフィックスの日時解決で使用するタイムゾーン。
minDigits	integer >= 1 番号部分の最小桁数。

Responses

Request samples

Payload

Content type

application/json

{"documentType": "order",
"fixedPrefix": "string",
"fixedSuffix": "string",
"dynamicPrefixKind": {"type": "NONE"
},
"timeZone": "Asia/Tokyo",
"minDigits": 1
}

Response samples

Content type

application/json

{"data": {"rule": {"object": "document_numbering_rule",
"ruleId": "string",
"merchantId": "string",
"brandId": "string",
"documentType": "order",
"fixedPrefix": "string",
"fixedSuffix": "string",
"dynamicPrefixKind": {"type": "NONE"
},
"timeZone": "Asia/Tokyo",
"minDigits": 1,
"status": "active",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"error": {"statusCode": 0,
"messages": ["string"
]
}
}

DEXTRE Merchant API (1.0.0)

DEXTRE Merchant APIのご利用について

認証・認可

APIリクエスト制限

Errors

ドキュメント更新予定

基本的な概念について

マーチャント

ブランド

製品について

SKUテンプレートとは

補足資料

マーチャント

マーチャント(メーカー)を取得する

Authorizations:

header Parameters

Responses

Response samples

税

税のリストを取得する

Authorizations:

query Parameters

header Parameters

Responses

Request samples

Response samples

税を取得する

Authorizations:

path Parameters

header Parameters

Responses

Response samples

在庫ラベル

在庫ラベルの一覧を取得する

Authorizations:

query Parameters

header Parameters

Responses

Response samples

在庫ラベルを取得する

Authorizations:

path Parameters

header Parameters

Responses

Response samples

在庫ロケーション

在庫ロケーションのリストを取得する

Authorizations:

query Parameters

header Parameters

Responses

Response samples

在庫ロケーションを取得する

Authorizations:

path Parameters

header Parameters

Responses

Response samples

在庫受注ポリシー

在庫受注ポリシーのリストを取得する

Authorizations:

query Parameters

header Parameters

Responses

Response samples

在庫受注ポリシーを取得する

Authorizations:

path Parameters

header Parameters

Responses

Response samples

ブランド

ブランドのリストを取得する

Authorizations:

query Parameters

header Parameters

Responses

Response samples

ブランドを取得する

Authorizations:

Request Body schema: application/json
required

Request Body schema: application/json
required