概要

本ガイドでは、DEXTRE Merchant APIを利用した「カタログ」作成のリクエスト例を示します。

環境例を前提としたサンプルになりますので、自社環境に合わせて適宜ご調整ください。

APIドキュメント

https://docs.dextre.app/merchant-api/#tag/catalog/operation/createCatalog

利用にあたっての前提・準備

• マーチャント(メーカー)環境にて、ブランドが登録されていることを確認してください。
  • 存在しない場合はご登録ください。

環境例

• マーチャント(メーカー)で有効化しているコア設定
  • 言語
    • 日本語(ja)
    • 英語(en)

リクエスト例 (curl)

curl -X POST '<https://api.dextre.app/v1/merchant/brands/{ブランドのID(brandId)}/catalogs>' \\
-H 'X-Merchant-API-Version: 使用するAPIのバージョン(betaなど)' \\
-H 'X-Merchant-API-Key: マーチャントごとに発行された専用APIキー(sk_live_...)' \\
-d '{"code":"ブランド内で一意なコード","localizedNames":[{"languageCode":"ja","text":"カタログ名"},{"languageCode":"en","text":"Catalog Name"}],"status":"open"}'

リクエストボディ例(必須フィールドのみ指定した場合)

{
	"code": "ブランド内で一意なコード",
	"localizedNames": [
		{
			"languageCode": "ja",
			"text": "カタログ名"
		},
		{
			"languageCode": "en",
			"text": "Catalog Name"
		}
	],
	"status": "open"
}

localizedNamesについて

マーチャントで有効化されている言語の数だけ、要素を追加してください。

languageCodeには、マーチャントで有効化されている言語のコードを指定してください。

配列内でlanguageCodeの重複を起こさないようにご注意ください。

"localizedNames": [
 {
	 "languageCode": "ja",
	 "text": "カタログの名称"
 },
 {
	 "languageCode": "en",
	 "text": "Catalog Name"
 }
]