商品情報関連
・商品情報取得API
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| access_token | アクセストークン | - | - | - |
| brand_code | システム商品コード | systemCode | システム商品コード | systemCode |
| ubrand_code | 独自商品コード | customCode | 独自商品コード | customCode |
| category_code | カテゴリーコード | categoryCode | カテゴリーコード | categoryCode |
| last_update_from | ※最終更新日（from） | lastUpdateFrom | 最終更新日時(From) | lastUpdateFrom |
| last_update_to | ※最終更新日（to） | lastUpdateTo | 最終更新日時(To) | lastUpdateTo |
| display_page | 表示ページ | page | ページ | page |
| limit_per_page | 表示件数 | limit | 検索上限（max 1000） | limit |
| sort_order | ソート順 | sortOrder | ソート順 | sortOrder |
| response_format | レスポンス形式 | - | - | - |
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| result_data | ルート（ノード） | - | - | - |
| status_code | ステータスコード | - | - | - |
| message | エラーメッセージ | - | - | - |
| total_count | 検索結果の商品件数 | searchedCount | 検索結果 件数 | searchedCount |
| dispay_record_from | 商品情報の開始行数 | - | - | - |
| dispay_record_to | 商品情報の終了行数 | - | - | - |
| product_list | 商品情報（ノード） | products | 商品情報 検索結果 | products |
| product | 商品情報（ノード） | products | 商品情報 検索結果 | products |
| created_date | 商品登録日時 | customCreatedAt | 商品の登録日時（更新可能で、表示用などに利用） | products.customCreatedAt |
| modified_date | 商品更新日時 | updatedAt | 商品の更新日時 (2024.05.17追加) | products.updatedAt |
| product_id | 商品ID | uid | 商品UID | products.uid |
| brand_code | システム商品コード | systemCode | システム商品コード | products.systemCode |
| ubrand_code | 独自商品コード | customCode | 商品の独自コード | products.customCode |
| is_display | 商品表示可否 | display | 公開するか否か | products.display |
| is_member_only | 会員専用設定 | isMemberOnly | 会員用商品の設定 | products.isMemberOnly |
| displayable_member_groups | 表示可能な会員グループ名 | - | - | - |
| basic_category | 基本カテゴリー（ノード） | isMainCategory | 商品メインカテゴリーフラグ | products.categories.isMainCategory |
| category_code | カテゴリー識別コード | categoryCode | 任意の識別コード | products.categories.categoryCode |
| category_path | カテゴリーパス | - | - | - |
| categories | カテゴリー（ノード） | categories | 商品カテゴリ情報 | products.categories |
| category | カテゴリー（ノード） | - | - | - |
| category_code | カテゴリー識別コード | categoryCode | 任意の識別コード | products.categories.categoryCode |
| category_path | カテゴリーパス | - | - | - |
| product_name | 商品名 | productName | 商品名 | products.productName |
| weight | 重量 | weight | 重量 | products.weight |
| price | 販売価格 | sellPrice | 販売価格 | products.sellPrice |
| consumption_tax_rate | 消費税率 | taxRate | 販売価格の税率 | products.taxRate |
| is_reduced_tax_rate_brand | 軽減税率対象 | - | - | - |
| point | ポイント | reserve | ポイント | products.reserve |
| member_group_prices | 会員グループ別価格（ノード） | memberGroupPrices | 会員グループ別価格 (2024.09.11追加) | products.memberGroupPrices |
| member_group_prices | 会員グループ別価格（ノード） | - | - | - |
| group_id | 会員グループID | accessGroup | 会員グループID | products.categories.accessGroup |
| group_name | 会員グループ名 | groupName | 会員グループ名 | products.memberGroupPrices.groupName |
| price | 会員グループ別価格 | price | 会員グループ別価格 | products.memberGroupPrices.price |
| point | 会員グループ別ポイント | point | 会員グループポイント付与値 | products.memberGroupPrices.point |
| point_type | ポイントの種別 | pointRate | 会員グループポイント付与率 | products.memberGroupPrices.pointRate |
| fixed_price | 定価 | consumerPrice | 定価 | products.consumerPrice |
| purchase_price | 仕入価格 | buyPrice | 仕入価格 | products.buyPrice |
| jancode | JANコード | janCode | JANコード | products.janCode |
| vendor | 製造元 | maker | 製造元 | products.maker |
| origin | 原産地 | madeIn | 原産地 | products.madeIn |
| is_display_origin | 原産地表示フラグ | etcType | 下記情報を | で連結して持つ | products.etcType |
| stock | 数量 | quantity | 在庫数 | products.quantity |
| is_diplay_stock | 数量表示フラグ | etcType | 下記情報を | で連結して持つ | products.etcType |
| minimum_quantity | 最小注文限度数 | etcType | 下記情報を | で連結して持つ | products.etcType |
| maximum_quantity | 最大注文限度数 | etcType | 下記情報を | で連結して持つ | products.etcType |
| collections | 陳列位置 | displayPosition | ショップでの表示位置 | products.displayPosition |
| individual_shipping | 送料個別設定 | deliveryMethodId | 配送方法ID | products.deliveryMethodId |
| is_publish_date_from | 掲載開始日指定フラグ | isSellStart | 掲載期間の開始日時設定 | products.isSellStart |
| publish_date_from | 掲載開始日 | sellStartDateTime | 掲載開始日時 | products.sellStartDateTime |
| is_publish_date_to | 掲載終了日指定フラグ | isSellEnd | 掲載期間の終了日時設定 | products.isSellEnd |
| publish_date_to | 掲載終了日 | sellEndDateTime | 掲載終了日時 | products.sellEndDateTime |
| is_display_out_of_publish_period | 掲載期間外表示可否 | isDisplayOutOfSellPeriod | 掲載期間外の表示可否 | products.isDisplayOutOfSellPeriod |
| is_discount_rate | 割引使用フラグ | discountRate | 商品の割引率 | products.discountRate |
| discount_rate | 割引率 | discountRate | 商品の割引率 | products.discountRate |
| discount_term | 割引期間 | discountPeriod | 商品の割引期間 | products.discountPeriod |
| item_group | 商品グループ | productGroupName | 商品グループ名 | products.productGroupName |
| search_keyword | 商品検索語 | searchKeyword | 検索用に変換した検索語 | products.searchKeyword |
| note | 商品別特殊表示 | addCode | 商品別特殊表示 | products.addCode |
| option | オプション（ノード） | perVariations | バリエーション別価格情報 | products.memberGroupPrices.perVariations |
| option_name1 | オプション名1 | - | - | - |
| option_name2 | オプション名2 | - | - | - |
| option_name1_items | オプションアイテム1（ノード） | perVariations | バリエーション別価格情報 | products.memberGroupPrices.perVariations |
| item | オプションアイテム1（ノード） | - | - | - |
| item_id | 選択肢ID | variation1ItemId | バリエーション1項目ID | products.memberGroupPrices.perVariations.variation1ItemId |
| item_name | 選択項目名 | variation1ItemName | バリエーション1項目名 | products.memberGroupPrices.perVariations.variation1ItemName |
| default | 初期選択 | variation1Default | バリエーション1の初期表示ID | products.variation1Default |
| option_name2_items | オプションアイテム2（ノード） | perVariations | バリエーション別価格情報 | products.memberGroupPrices.perVariations |
| item | オプションアイテム2（ノード） | - | - | - |
| item_id | 選択肢ID | variation2ItemId | バリエーション2項目ID | products.memberGroupPrices.perVariations.variation2ItemId |
| item_name | 選択項目名 | variation2ItemName | バリエーション2項目名 | products.memberGroupPrices.perVariations.variation2ItemName |
| default | 初期選択 | variation2Default | バリエーション2の初期表示ID | products.variation2Default |
| select_options | オプション選択（ノード） | perVariations | バリエーション別価格情報 | products.memberGroupPrices.perVariations |
| select_option | オプション選択（ノード） | - | - | - |
| option_id | ID | - | - | - |
| option_ubrand_code | オプション独自コード | variationCustomCode | カスタムオプションコード | products.variations.variationCustomCode |
| price | 販売価格 | price | 販売価格 | products.variations.price |
| stock | 在庫数 | quantity | 数量 | products.variations.quantity |
| jancodek | JANコード | janCode | JANコード | products.variations.janCode |
| member_group_price | 会員グループ別価格（ノード） | memberGroupPrices | 会員グループ別価格 (2024.09.11追加) | products.memberGroupPrices |
| member_group_price | 会員グループ別価格（ノード） | - | - | - |
| group_id | 会員グループID | groupId | 会員グループID | products.memberGroupPrices.groupId |
| group_name | 会員グループ名 | groupName | 会員グループ名 | products.memberGroupPrices.groupName |
| price | 販売価格 | price | 会員グループ別価格 | products.memberGroupPrices.price |
| image_url | オプション画像URL | url | 画像URL | products.subImages.url |
| thumbnail_image_url | オプション画像サムネイルURL | - | - | - |
| option_group | オプショングループ（ノード） | option | オプション情報 | products.option |
| group_code | オプショングループコード | optionCode | オプションID | products.option.optionCode |
| group_name | オプショングループ名 | optionTitle | オプション名 | products.option.optionTitle |
| group_item | オプショングループアイテム（ノード） | option | オプション情報 | products.option |
| option_id | オプションID | optionCode | オプションID | products.option.optionCode |
| option_name | オプション名 | optionValue0~19 | 詳細オプション1~20の項目 | products.option.optionValue0~19 |
| is_required | 必須 | optionSelect | 詳細オプション1〜10の必須設定 | products.option.optionSelect |
| item | アイテム（ノード） | - | - | - |
| item_id | アイテムID | optionValue0~19 | 詳細オプション1~20の項目 | products.option.optionValue0~19 |
| item_name | アイテム名 | optionValue0~19 | 詳細オプション1~20の項目 | products.option.optionValue0~19 |
| price_type | 固定・料率 | - | - | - |
| price | 金額 | optionValue0~19 | 詳細オプション1~20の項目 | products.option.optionValue0~19 |
| default | 初期表示 | optionDefault | 詳細オプション1〜10のデフォルト値のインデックス | products.option.optionDefault |
| name_option_group | 名入れグループ（ノード） | insertNameGroup | 名入れグループ情報 | products.insertNameGroup |
| group_id | 名入れグループID | groupUID | 名入れグループID | products.insertNameGroup.groupUID |
| group_label | 名入れグループ名 | groupName | 名入れグループ名 | products.insertNameGroup.groupName |
| group_discription | 名入れグループ説明文 | groupDescription | 名入れグループの説明文 | products.insertNameGroup.groupDescription |
| group_item | 名入れ項目（ノード） | InsertNameSettings | 名入れ項目設定情報 | products.insertNameGroup.InsertNameSettings |
| item_id | アイテムID | - | - | - |
| admin_item_name | 管理者用項目名 | adminItemName | 名入れ入力項目の管理用項目名 | products.insertNameGroup.InsertNameSettings.adminItemName |
| display_item_name | 表示用項目名 | itemName | 名入れ入力項目の表示用項目名 本項目が未設定（空）の場合は管理用項目名をショップ画面に表示する。 | products.insertNameGroup.InsertNameSettings.itemName |
| is_required | 選択・必須 | isRequired | 名入れ | products.insertNameGroup.InsertNameSettings.isRequired |
| validation | 入力値制限（ノード） | - | - | - |
| is_alphabet | 半角アルファベット | isAlphabetOk | 名入れ入力項目の半角英字の入力設定 | products.insertNameGroup.InsertNameSettings.isAlphabetOk |
| is_number | 半角数字 | isNumberOk | 名入れ入力項目の半角数字の入力設定 | products.insertNameGroup.InsertNameSettings.isNumberOk |
| is_symbol | 半角記号 | isSymbolOk | 名入れ入力項目の半角記号の入力設定 | products.insertNameGroup.InsertNameSettings.isSymbolOk |
| is_double_byte | 全角文字 | isDoubleByteCharacterOk | 名入れ入力項目のマルチバイト文字の入力設定 | products.insertNameGroup.InsertNameSettings.isDoubleByteCharacterOk |
| input_size_setting | 入力項目設定（ノード） | - | - | - |
| row_maxlength | 一行の文字数 | rowMaxLength | 名入れ入力項目の１行に入力可能な文字数の設定 | products.insertNameGroup.InsertNameSettings.rowMaxLength |
| maxrow | 行数 | displayRows | 名入れ入力項目の入力可能な行数の設定 | products.insertNameGroup.InsertNameSettings.displayRows |
| maxlength | 最大文字数 | inputMaxLength | 名入れ入力項目の入力可能文字数の設定 | products.insertNameGroup.InsertNameSettings.inputMaxLength |
| product_page_url | 商品ページURL | - | - | - |
| zoom_image_url | 拡大画像URL | maxImageUrl | 拡大画像URL | products.maxImageUrl |
| image_url | 普通画像URL | minImageUrl | 普通画像URL | products.minImageUrl |
| thumbnail_image_url | 縮小画像URL | tinyImageUrl | 縮小画像URL | products.tinyImageUrl |
| mobile_image_url | モバイル画像URL | mobileImageUrl | モバイル画像URL | products.mobileImageUrl |
| sub_image1_url | 追加商品画像1 | subImage1Url | 追加商品画像1URL | products.subImage1Url |
| is_display_mobile_sub_image1 | 追加商品画像モバイル表示1 | subImageMbCk1 | モバイル用追加商品画像1を作成するフラグ | products.subImageMbCk1 |
| sub_image1_content | 画像説明文1 | subContent1 | 追加商品画像説明文1 | products.subContent1 |
| sub_image2_url | 追加商品画像2 | subImage2Url | 追加商品画像2URL | products.subImage2Url |
| is_display_mobile_sub_image2 | 追加商品画像モバイル表示2 | subImageMbCk2 | モバイル用追加商品画像2を作成するフラグ | products.subImageMbCk2 |
| sub_image2_content | 画像説明文2 | subContent2 | 追加商品画像説明文2 | products.subContent2 |
| sub_image3_url | 追加商品画像3 | subImage3Url | 追加商品画像3URL | products.subImage3Url |
| is_display_mobile_sub_image3 | 追加商品画像モバイル表示3 | subImageMbCk3 | モバイル用追加商品画像3を作成するフラグ | products.subImageMbCk3 |
| sub_image3_content | 画像説明文3 | subContent3 | 追加商品画像説明文3 | products.subContent3 |
| sub_image_layout | レイアウト指定 | imageLayout | 追加商品画像の表示パターン | products.imageLayout |
| main_content | PC用メイン商品説明文 | pcContent | PCでの説明文 | products.pcContent |
| main_content2 | PC用追加商品説明文 | pcAddContent | PCでの追加説明 | products.pcAddContent |
| mobile_content | モバイル商品説明 | mobileContent | スマホでの説明文 | products.mobileContent |
| smartphone_content1 | スマホ商品説明1 | mobileContent | スマホでの説明文 | products.mobileContent |
| smartphone_content2 | スマホ商品説明2 | mobileAddContent | スマホでの追加説明 | products.mobileAddContent |
| is_display_mobile_content | スマホ商品説明1にモバイル表示 | - | - | - |
| product_list_content | 商品カテゴリー用商品説明文 | categoryContent | 商品カテゴリーページ用商品説明文 | products.categoryContent |
| is_display_product_list_content | 商品カテゴリー用商品説明文表示可否 | - | - | - |
| order_page_note | 決済画面備考欄 | orderMessage | 決済時備考 | products.orderMessage |
| is_restock_notification | 再入荷お知らせ | isRestockMail | 再入荷お知らせメール受付設定 | products.isRestockMail |
| google_shopping | Googleショッピングデータノード（ノード） | - | - | - |
| condition | 商品状態フラグ | condition | 新品・中古品 | products.condition |
| title | データ用商品名 | searchProductName | 検索用に変換した商品名 | products.searchProductName |
| description | データ用詳細内容 | searchContent | 検索用に変換した商品詳細内容 | products.searchContent |
| option_layout_type | オプションの表示形式 | variationShowType | バリエーションの表示方法 | products.variationShowType |
| isbn_code | ISBNコード | isbn | Googleショッピング情報：ISBN（国際標準図書番号） | products.isbn |
| brand | ブランド名 | partnerProduct | Googleプロダクトサーチ用ブランド名 | products.partnerProduct |
| mnp | MPN(メーカー型番) | mpn | Googleショッピング情報：製品番号 | products.mpn |
| google_product_category | Googleショッピングカテゴリー | googleCategory | Googleプロダクトサーチ用カテゴリ名 | products.googleCategory |
| gender | 性別 | gender | Googleショッピング情報：性別 | products.gender |
| age_group | 年齢層 | ageGroup | Googleショッピング情報：年齢層 | products.ageGroup |
| color | 色 | color | Googleショッピング情報：色 | products.color |
| size | サイズ | size | Googleショッピング情報：サイズ | products.size |
| material | 素材 | material | Googleショッピング情報：素材 | products.material |
| pattern | 柄 | design | Googleショッピング情報：柄 | products.design |
| item_group_id | 商品グループID | skuGroup | Googleショッピング情報：商品グループ | products.skuGroup |
| adwords_grouping | アドワーズ用グループ | adwordsGroup | Googleアドワーズ情報：アドワーズグループ | products.adwordsGroup |
| adwords_labels | アドワーズ用ラベル | adwordsLabel | Googleアドワーズ情報：表示ラベル | products.adwordsLabel |
| settlement_group_name | 決済グループ名 | - | - | - |
| catalog_order_code | カタログ注文番号 | catalogCode | カタログコード | products.catalogCode |
| reservation_sale | 予約商品（ノード） | - | - | - |
| is_reservation_sale | 予約商品 | isReservationSale | 予約商品設定 | products.isReservationSale |
| release_date | 発売日 | reservationSaleDate | 発売日 | products.reservationSaleDate |
| release_date_note | 発売日備考 | reservationSaleDateNote | 発売日備考 | products.reservationSaleDateNote |
| is_onsale_after_released | 発売後通常商品化 | isRegularAfterSold | 予約商品を発売後に通常商品にする設定 | products.isRegularAfterSold |
| shipping_due_date | 出荷予定日 | arrivalDate | 出荷予定日 | products.arrivalDate |
| reservation_sale_note | 予約商品備考 | reservationSaleNote | 予約商品備考 | products.reservation_sale_note |
| kakakucom | 価格.com掲載商品（ノード） | - | - | - |
| is_publish | [価格.com]価格.com掲載登録 | - | - | - |
| product_id | [価格.com]ProductID | - | - | - |
| product_name | [価格.com]価格.comの製品名・型番 | - | - | - |
| is_set_jancode | [価格.com]JANコード自動紐付け | - | - | - |
| prompt_delivery | [価格.com]在庫・発送 | - | - | - |
| is_econly | [価格.com]店頭 | - | - | - |
| is_set_image_url | [価格.com]画像URL | - | - | - |
| comment | [価格.com]一言コメント | - | - | - |
| is_warranty | [価格.com]延長保証 | - | - | - |
| carriage_name | [価格.com]送料区分名 | - | - | - |
・商品情報登録API
| 旧API CSV | 新API Field | |||
|---|---|---|---|---|
| Field名 | CSV項目名 | Field名 | 項目名 | 階層 |
| - | 商品特定コード指定 | - | - | - |
| - | 更新時間フラグ | - | - | - |
| - | システム商品コード | - | - | - |
| - | 独自商品コード | customCode | 独自商品コード | productBasicInfo.customCode |
| - | カテゴリー識別コード | - | - | - |
| - | カテゴリーパス | - | - | - |
| - | 商品名 | productName | 商品名 | productBasicInfo.productName |
| - | 重量 | weight | 重量 | productBasicInfo.weight |
| - | 販売価格 | sellPrice | 販売価格 | productBasicInfo.sellPrice |
| - | 定価 | consumerPrice | 定価 | productBasicInfo.sellPrice |
| - | ポイント | reserve | ポイント | productBasicInfo.reserve |
| - | 仕入価格 | buyPrice | 仕入価格 | productBasicInfo.buyPrice |
| - | 製造元 | maker | 製造元 | productBasicInfo.maker |
| - | 原産地 | madeIn | 原産地 | productBasicInfo.madeIn |
| - | 原産地表示フラグ | showMadeIn | 原産地の表示 | productBasicInfo.showMadeIn |
| - | 数量 | stockInfo | 数量情報 | productBasicInfo.stockInfo |
| - | 数量表示フラグ | showStock | 在庫数の表示 | productBasicInfo.showStock |
| - | 最小注文限度数 | minOrder | 最小注文限度 | productBasicInfo.minOrder |
| - | 最大注文限度数 | maxOrder | 最大注文限度 | productBasicInfo.maxOrder |
| - | 陳列位置 | displayPosition | ショップでの表示場所 | productBasicInfo.displayPosition |
| - | 送料個別設定 | deliveryRegdate | 配送方法 | productBasicInfo.deliveryRegdate |
| - | 掲載開始日指定フラグ | - | - | - |
| - | 掲載開始日 | sellStartDatetime | 掲載期間（開始） | productBasicInfo.sellStartDatetime |
| - | 掲載終了日指定フラグ | - | - | - |
| - | 掲載終了日 | sellEndDatetime | 掲載期間（終了） | productBasicInfo.sellEndDatetime |
| - | 掲載期間外表示可否 | isDisplayOutOfSellPeriod | 掲載期間外表示可否 | productBasicInfo.isDisplayOutOfSellPeriod |
| - | 割引使用フラグ | - | - | - |
| - | 割引率 | discountRate | 割引率 | productBasicInfo.discountRate |
| - | 割引期間 |
discountPeriodUnlimited discountStart discountEnd |
割引期間が無制限 割引期間（開始） 割引期間（終了） |
productBasicInfo.discountPeriodUnlimited productBasicInfo.discountStart productBasicInfo.discountEnd |
| - | 商品グループ | productGroupCode | 商品グループ | productBasicInfo.productGroupCode |
| - | 商品検索語 | keyword | 商品検索語 | productBasicInfo.keyword |
| - | 商品別特殊表示 | specialDisplay | 商品別特殊表示 | productBasicInfo.specialDisplay |
| - | オプション1名称 | variation1Name | バリエーション1名 | productBasicInfo.variation1Name |
| - | オプション2名称 | variation2Name | バリエーション2名 | productBasicInfo.variation2Name |
| - | オプショングループ | optionCode | オプショングループコード | productBasicInfo.optionCode |
| - | 拡大画像名 | mainImage | 商品のメイン画像 | productBasicInfo.mainImage |
| - | 普通画像名 | mainImage | 商品のメイン画像 | productBasicInfo.mainImage |
| - | 縮小画像名 | subImages | 商品のサブ画像 | productBasicInfo.subImages |
| - | 追加商品画像1 | - | - | - |
| - | 画像説明文1 | - | - | - |
| - | 追加商品画像2 | - | - | - |
| - | 画像説明文2 | - | - | - |
| - | 追加商品画像3 | - | - | - |
| - | 画像説明文3 | - | - | - |
| - | レイアウト指定 | - | - | - |
| - | 商品説明 | productDesc | 商品説明 | productBasicInfo.productDesc |
| - | JANコード | janCode | JANコード | productBasicInfo.janCode |
| - | 商品表示可否 | display | 公開ステータス | productBasicInfo.display |
| - | 商品状態フラグ | condition | 商品の状態 | productBasicInfo.condition |
| - | データ用商品名 | productName | 商品名 | productBasicInfo.productGoogleShopping.productName |
| - | データ用詳細内容 | content | 詳細内容 | productBasicInfo.productGoogleShopping.content |
| - | オプションの表示形式 |
pcFormatCode mobileFormatCode |
バリエーションの表示形式（PC） バリエーションの表示形式（スマホ） |
productBasicInfo.pcFormatCode productBasicInfo.mobileFormatCode |
| - | ISBNコード | isbn | ISBNコード | productBasicInfo.productGoogleShopping.isbn |
| - | ブランド名 | brandName | ブランド名 | productBasicInfo.productGoogleShopping.brandName |
| - | MPN(メーカー型番) | mpn | MPN（メーカー型番） | productBasicInfo.productGoogleShopping.mpn |
| - | Googleショッピングカテゴリー | category | Google商品カテゴリ | productBasicInfo.productGoogleShopping.category |
| - | 性別 | sex | 性別 | productBasicInfo.productGoogleShopping.sex |
| - | 年齢層 | ageGroup | 年齢層 | productBasicInfo.productGoogleShopping.ageGroup |
| - | 色 | color | 色 | productBasicInfo.productGoogleShopping.color |
| - | サイズ | size | サイズ | productBasicInfo.productGoogleShopping.size |
| - | 素材 | material | 素材 | productBasicInfo.productGoogleShopping.material |
| - | 柄 | design | 柄 | productBasicInfo.productGoogleShopping.design |
| - | 商品グループID | productGroup | 商品グループ | productBasicInfo.productGoogleShopping.productGroup |
| - | アドワーズ用グループ | adwordsGroup | 広告グループ | productBasicInfo.productGoogleShopping.adwordsGroup |
| - | アドワーズ用ラベル | adwordsLabel | カスタムラベル | productBasicInfo.productGoogleShopping.adwordsLabel |
| - | 商品ページURL | - | - | - |
| - | 商品カテゴリー用商品説明文 | - | - | - |
| - | 商品カテゴリー用商品説明文表示可否 | - | - | - |
| - | 備考欄表示テキスト指定 | orderMessage | 備考欄表示テキスト設定 | productBasicInfo.orderMessage |
| - | スマホ商品説明1 | mobile | スマホでの商品説明 | productBasicInfo.productDesc.mobile |
| - | スマホ商品説明2 | mobile | スマホでの商品説明 | productBasicInfo.productDesc.mobile |
| - | 再入荷お知らせ | isRestockMail | 再入荷お知らせ | productBasicInfo.isRestockMail |
| - | 決済グループ | settlementGroupId | 決済グループ | productBasicInfo.settlementGroupId |
| - | PC用追加商品説明文 | pc | PCでの商品説明 | productBasicInfo.productDesc.pc |
| - | 名入れグループ | insertNameGroupUid | 名入れ | productBasicInfo.insertNameGroupUid |
| - | 消費税率 | taxRate | 税率 | productBasicInfo.taxRate |
| - | 軽減税率対象 | - | - | - |
| - | ブラウザータイトル | title | title | productBasicInfo.title |
| - | メタタグ：Description | description | description | productBasicInfo.description |
| - | 決済画面用商品詳細 | orderContent | 決済画面用商品詳細 | productBasicInfo.orderContent |
| - | 会員専用設定 | isMemberOnly | 会員専用可否 | productBasicInfo.isMemberOnly |
| - | 会員グループ別設定 | memberGroupIdDisplayForProduct | 会員専用表示対象の会員グループID | productBasicInfo.memberGroupIdDisplayForProduct |
| - | カタログ注文番号 | catalogCode | カタログ注文番号 | productBasicInfo.catalogCode |
| - | 予約商品 | reservationSaleInfo | 予約商品関連情報 | productBasicInfo.reservationSaleInfo |
| - | 発売日 | reservationSaledate | 発売日 | productBasicInfo.reservationSaleInfo.reservationSaledate |
| - | 発売日備考 | reservationSaledateNote | 発売日備考 | productBasicInfo.reservationSaleInfo.reservationSaledateNote |
| - | 発売後通常商品化 | isRegularAfterSold | 発売日以降は通常商品にする | productBasicInfo.reservationSaleInfo.isRegularAfterSold |
| - | 出荷予定日 | arrivalDate | 出荷予定日 | productBasicInfo.reservationSaleInfo.arrivalDate |
| - | 予約商品備考 | reservationSaleNote | 予約商品備考 | productBasicInfo.reservationSaleInfo.reservationSaleNote |
| 商品一括登録（価格コムプラン用） | ||||
| - | [価格.com]価格.com掲載登録 | |||
| - | [価格.com]ProductID | - | - | - |
| - | [価格.com]価格.comの製品名・型番 | - | - | - |
| - | [価格.com]JANコード自動紐付け | - | - | - |
| - | [価格.com]在庫・発送 | - | - | - |
| - | [価格.com]店頭 | - | - | - |
| - | [価格.com]画像URL | |||
| - | [価格.com]一言コメント | - | - | - |
| - | [価格.com]延長保証 | - | - | - |
| - | [価格.com]送料区分名 | - | - | - |
| カテゴリー一括登録 | ||||
| - | 操作コード | - | - | - |
| - | カテゴリー識別コード | categoryCode | カテゴリコード | categories.categoryCode |
| - | カテゴリー名 | categoryName | カテゴリ名 | categories.categoryName |
| - | 親カテゴリーパス | parent | 親カテゴリのカテゴリ名 | categories.parent |
| - | ブラウザータイトル | browserTitle | ブラウザータイトル | categories.seoInfo.browserTitle |
| - | メタタグ : Description | description | メタタグ：Description | categories.seoInfo.description |
| オプション一括登録 | ||||
| - | 商品特定コード指定 | - | - | - |
| - | オプション特定コード指定 | - | - | - |
| - | システム商品コード | - | - | - |
| - | 独自商品コード | - | - | - |
| - | 商品名 | - | - | - |
| - | 商品カテゴリーパス | - | - | - |
| - | オプション独自コード | - | - | - |
| - | オプション1項目 | - | - | - |
| - | オプション2項目 | - | - | - |
| - | 販売価格 | - | - | - |
| - | 数量 | - | - | - |
| - | JANコード | - | - | - |
| 会員グループ別価格一括登録 | ||||
| - | 販売価格特定コード指定 | - | - | - |
| - | 商品特定コード指定 | - | - | - |
| - | ポイント特定コード指定 | - | - | - |
| - | オプション特定コード指定 | - | - | - |
| - | 会員グループID | - | - | - |
| - | システム商品コード | - | - | - |
| - | 独自商品コード | - | - | - |
| - | 販売価格 | - | - | - |
| - | ポイント | - | - | - |
| - | オプション独自コード | - | - | - |
| - | オプション1項目 | - | - | - |
| - | オプション2項目 | - | - | - |
| - | 販売価格（オプション） | - | - | - |
・商品情報更新API
| 旧API CSV | 新API Field | |||
|---|---|---|---|---|
| Field名 | CSV項目名 | Field名 | 項目名 | 階層 |
| - | 商品特定コード指定 | productKeyType | 商品を特定するキーの種別 | productKeyType |
| - | 更新時間フラグ | - | - | - |
| - | システム商品コード | systemCode | システム商品コード | systemCode |
| - | 独自商品コード | customCode customCode |
独自商品コード 独自商品コード |
productBasicInfo.customCode customCode |
| - | カテゴリー識別コード | - | - | - |
| - | カテゴリーパス | - | - | - |
| - | 商品名 | productName | 商品名 | productBasicInfo.productName |
| - | 重量 | weight | 重量 | detailInfo.weight |
| - | 販売価格 | sellPrice | 販売価格 | basketInfo.sellPrice |
| - | 定価 | consumerPrice | 定価 | basketInfo.consumerPrice |
| - | ポイント | reserve | ポイント | promotionInfo.reserve |
| - | 仕入価格 | buyPrice | 仕入価格 | basketInfo.buyPrice |
| - | 製造元 | maker | 製造元 | detailInfo.maker |
| - | 原産地 | madeIn | 原産地 | detailInfo.madeIn |
| - | 原産地表示フラグ | showMadeIn | 原産地の表示 | viewInfo.showMadeIn |
| - | 数量 | stockInfo | 数量情報 | stockInfo |
| - | 数量表示フラグ | showStock | 在庫数の表示 | viewInfo.showStock |
| - | 最小注文限度数 | minOrder | 最小注文限度 | stockInfo.minOrder |
| - | 最大注文限度数 | maxOrder | 最大注文限度 | stockInfo.maxOrder |
| - | 陳列位置 | displayPosition | ショップでの表示場所 | viewInfo.displayPosition |
| - | 送料個別設定 | deliveryRegdate | 配送方法 | basketInfo.deliveryRegdate |
| - | 掲載開始日指定フラグ | - | - | - |
| - | 掲載開始日 | sellStartDatetime | 掲載期間（開始） | promotionInfo.sellStartDatetime |
| - | 掲載終了日指定フラグ | - | - | - |
| - | 掲載終了日 | sellEndDatetime | 掲載期間（終了） | promotionInfo.sellEndDatetime |
| - | 掲載期間外表示可否 | isDisplayOutOfSellPeriod | 掲載期間外表示可否 | promotionInfo.isDisplayOutOfSellPeriod |
| - | 割引使用フラグ | - | - | - |
| - | 割引率 | discountRate | 割引率 割引しない場合は0指定で問題ない。 |
promotionInfo.discountRate |
| - | 割引期間 | discountPeriodUnlimited discountStart discountEnd |
割引期間が無制限 割引期間（開始） 割引期間（終了） |
promotionInfo.discountPeriodUnlimited promotionInfo.discountStart promotionInfo.discountEnd |
| - | 商品グループ | productGroupCode | 商品グループ | enhancement.productGroupCode |
| - | 商品検索語 | keyword | 商品検索語 検索用語が複数ある場合は「,」で区切る。 |
viewInfo.keyword |
| - | 商品別特殊表示 | specialDisplay | 商品別特殊表示 | detailInfo.specialDisplay |
| - | オプション1名称 | variation1Name | バリエーション1名 | variationInfo.variation1Name |
| - | オプション2名称 | variation2Name | バリエーション2名 | variationInfo.variation2Name |
| - | オプショングループ | optionCode | オプショングループコード | variationInfo.optionCode |
| - | 拡大画像名 | mainImage | 商品のメイン画像 | imageInfo.mainImage |
| - | 普通画像名 | mainImage | 商品のメイン画像 | imageInfo.mainImage |
| - | 縮小画像名 | subImages | 商品のサブ画像 | imageInfo.subImages |
| - | 追加商品画像1 | - | - | - |
| - | 画像説明文1 | - | - | - |
| - | 追加商品画像2 | - | - | - |
| - | 画像説明文2 | - | - | - |
| - | 追加商品画像3 | - | - | - |
| - | 画像説明文3 | - | - | - |
| - | レイアウト指定 | - | - | - |
| - | 商品説明 | productDesc | 商品説明 | productBasicInfo.productDesc |
| - | JANコード | janCode | JANコード | variationInfo.variationDetails.janCode |
| - | 商品表示可否 | display | 公開ステータス | productBasicInfo.display |
| - | 商品状態フラグ | condition | 商品の状態 | detailInfo.condition |
| - | データ用商品名 | - | - | - |
| - | データ用詳細内容 | - | - | - |
| - | オプションの表示形式 | pcFormatCode mobileFormatCode |
バリエーションの表示形式（PC） バリエーションの表示形式（スマホ） |
variationInfo.pcFormatCode variationInfo.mobileFormatCode |
| - | ISBNコード | isbn | ISBNコード | enhancement.productGoogleShopping.isbn |
| - | ブランド名 | brandName | ブランド名 | enhancement.productGoogleShopping.brandName |
| - | MPN(メーカー型番) | mpn | MPN（メーカー型番） | enhancement.productGoogleShopping.mpn |
| - | Googleショッピングカテゴリー | category | Google商品カテゴリ | enhancement.productGoogleShopping.category |
| - | 性別 | sex | 性別 | enhancement.productGoogleShopping.sex |
| - | 年齢層 | ageGroup | 年齢層 | enhancement.productGoogleShopping.ageGroup |
| - | 色 | color | 色 複数指定する場合は「,」で区切る。 |
enhancement.productGoogleShopping.color |
| - | サイズ | size | サイズ 複数指定する場合は「,」で区切る。 |
enhancement.productGoogleShopping.size |
| - | 素材 | material | 素材 複数指定する場合は「,」で区切る。 |
enhancement.productGoogleShopping.material |
| - | 柄 | design | 柄 複数指定する場合は「,」で区切る。 |
enhancement.productGoogleShopping.design |
| - | 商品グループID | productGroup | 商品グループ | enhancement.productGoogleShopping.productGroup |
| - | アドワーズ用グループ | adwordsGroup | 広告グループ | enhancement.productGoogleShopping.adwordsGroup |
| - | アドワーズ用ラベル | adwordsLabel | カスタムラベル | enhancement.productGoogleShopping.adwordsLabel |
| - | 商品ページURL | - | - | - |
| - | 商品カテゴリー用商品説明文 | - | - | - |
| - | 商品カテゴリー用商品説明文表示可否 | - | - | - |
| - | 備考欄表示テキスト指定 | orderMessage | 備考欄表示テキスト設定 | detailInfo.orderMessage |
| - | スマホ商品説明1 | productDesc | 商品説明 | productBasicInfo.productDesc |
| - | スマホ商品説明2 | productDesc | 商品説明 | productBasicInfo.productDesc |
| - | 再入荷お知らせ | isRestockMail | 再入荷お知らせ true : あり false : 無し |
enhancement.isRestockMail |
| - | 決済グループ | settlementGroupId | 決済グループ | enhancement.settlementGroupId |
| - | PC用追加商品説明文 | - | - | - |
| - | 名入れグループ | insertNameGroupUid | 名入れ | enhancement.insertNameGroupUid |
| - | 消費税率 | taxRate | 税率 | basketInfo.taxRate |
| - | 軽減税率対象 | - | - | - |
| - | ブラウザータイトル | title | title | seoInfo.title |
| - | メタタグ：Description | description | description | seoInfo.description |
| - | 決済画面用商品詳細 | orderContent | 決済画面用商品詳細 | detailInfo.orderContent |
| - | 会員専用設定 | isMemberOnly | 会員専用可否 | optionalFeature.isMemberOnly |
| - | 会員グループ別設定 | memberGroupIdDisplayForProduct | 会員専用表示対象の会員グループID | optionalFeature.memberGroupIdDisplayForProduct |
| - | カタログ注文番号 | catalogCode | カタログ注文番号 | optionalFeature.catalogCode |
| - | 予約商品 | reservationSaleInfo | 予約商品関連情報 | optionalFeature.reservationSaleInfo |
| - | 発売日 | reservationSaledate | 発売日 | optionalFeature.reservationSaleInfo.reservationSaledate |
| - | 発売日備考 | reservationSaledateNote | 発売日備考 | optionalFeature.reservationSaleInfo.reservationSaledateNote |
| - | 発売後通常商品化 | isRegularAfterSold | 発売日以降は通常商品にする | optionalFeature.reservationSaleInfo.isRegularAfterSold |
| - | 出荷予定日 | arrivalDate | 出荷予定日 | optionalFeature.reservationSaleInfo.arrivalDate |
| - | 予約商品備考 | reservationSaleNote | 予約商品備考 | optionalFeature.reservationSaleInfo.reservationSaleNote |
| 価格.com連携 | ||||
| - | [価格.com]価格.com掲載登録 | - | - | - |
| - | [価格.com]ProductID | - | - | - |
| - | [価格.com]価格.comの製品名・型番 | - | - | - |
| - | [価格.com]JANコード自動紐付け | - | - | - |
| - | [価格.com]在庫・発送 | - | - | - |
| - | [価格.com]店頭 | - | - | - |
| - | [価格.com]画像URL | - | - | - |
| - | [価格.com]一言コメント | - | - | - |
| - | [価格.com]延長保証 | - | - | - |
| - | [価格.com]送料区分名 | - | - | - |
| カテゴリー一括登録 | ||||
| - | 操作コード | - | - | - |
| - | カテゴリー識別コード | productBasicInfo | 基本情報 | productBasicInfo |
| - | カテゴリー名 | customCode | 独自商品コード | customCode |
| - | 親カテゴリーパス | - | - | - |
| - | ブラウザータイトル | sellPrice | 販売価格 | basketInfo.sellPrice |
| - | メタタグ : Description | taxRate | 税率 | basketInfo.taxRate |
| オプション一括登録 | ||||
| - | 商品特定コード指定 | productKeyType | 商品を特定するキーの種別 | productKeyType |
| - | オプション特定コード指定 | variationKeyType | バリエーションを特定するキーの種別 | optionalFeature.memberGroupPrices.perVariations.variationKeyType |
| - | システム商品コード | systemCode | システム商品コード | systemCode |
| - | 独自商品コード | customCode | 独自商品コード | customCode |
| - | 商品名 | productName | 商品名 | productBasicInfo.productName |
| - | 商品カテゴリーパス | - | - | - |
| - | オプション独自コード | variationCustomCode | バリエーション独自コード | |
| - | オプション1項目 | variation1ItemName | バリエーション1項目名 | variationInfo.variationDetails.variation1ItemName |
| - | オプション2項目 | variation2ItemName | バリエーション2項目名 | variationInfo.variationDetails.variation2ItemName |
| - | 販売価格 | price | 販売価格 | optionalFeature.repeatSaleProducts.price |
| - | 数量 | stockInfo | 数量情報 | stockInfo |
| - | JANコード | janCode | JANコード | detailInfo.janCode |
| 会員グループ別価格一括登録 | ||||
| - | 販売価格特定コード指定 | - | - | - |
| - | 商品特定コード指定 | productKeyType | 商品を特定するキーの種別 | productKeyType |
| - | ポイント特定コード指定 | point | 会員グループポイント | optionalFeature.memberGroupPrices.point |
| - | オプション特定コード指定 | variationKeyType | バリエーションを特定するキーの種別 | optionalFeature.memberGroupPrices.perVariations.variationKeyType |
| - | 会員グループID | groupId | 会員グループID | optionalFeature.memberGroupPrices.groupId |
| - | システム商品コード | systemCode | システム商品コード | systemCode |
| - | 独自商品コード | customCode | 独自商品コード | customCode |
| - | 販売価格 | price | 会員グループ別価格 | optionalFeature.memberGroupPrices.price |
| - | ポイント | point | 会員グループポイント | optionalFeature.memberGroupPrices.point |
| - | オプション独自コード | perVariations | バリエーション別価格情報 | optionalFeature.memberGroupPrices.perVariations |
| - | オプション1項目 | variation1ItemName | バリエーション1項目名 | optionalFeature.memberGroupPrices.perVariations.variation1ItemName |
| - | オプション2項目 | variation2ItemName | バリエーション2項目名 | optionalFeature.memberGroupPrices.perVariations.variation2ItemName |
| - | 販売価格（オプション） | price | バリエーション別価格 | optionalFeature.memberGroupPrices.perVariations.price |
注文関連
・注文取得API
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| cmd | - | - | - | |
| ordernum | displayOrderNumber | 表示注文番号 | displayOrderNumber | |
| start | startOrderDate | 注文日 検索開始日時 | startOrderDate | |
| end | endOrderDate | 注文日 検索終了日時 | endOrderDate | |
| canceled | excludeCanceled | キャンセル済み注文を除外するかどうか | excludeCanceled | |
| ordernum_list | displayOrderNumberList | 表示注文番号（リスト） ※100件以下 |
displayOrderNumberList | |
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| orders | 注文群 | orders | 注文情報 | orders |
| order | 注文 | orders | 注文情報 | orders |
| ordernum | 注文番号 | displayOrderNumber | 表示注文番号 | orders.displayOrderNumber |
| status | 状態 | paymentStatusCode | 決済状態コード | orders.paymentStatusCode |
| repeatsalenum | 定期購入回数 | orderSubscriptionBaseId | 定期購入ID | orders.orderSubscriptionBaseId |
| date | 注文日 | orderDate | 注文日時 | orders.orderDate |
| paymethod | 支払方法 | payMethod | 決済方法 | orders.payMethod |
| payment_status | 入金状況 | paymentStatusCode | 決済状態コード | orders.paymentStatusCode |
| ordermemo | 詳細注文情報内メモ | message | 注文備考 | orders.message |
| tax_type ※外税時のみ |
消費税フラグ | taxCalculationType | 消費税の計算タイプ | orders.taxCalculationType |
| orderdetail | 注文詳細 | message | 注文備考 | orders.message |
| commodities | 注文明細群 | basketInfos | 商品情報 | orders.deliveryInfos.basketInfos |
| commodity | 注文明細 | - | - | - |
| name | 商品名 | productName | 商品名 | orders.deliveryInfos.basketInfos.productName |
| brandcode | システム商品コード | productCode | システム商品コード | orders.deliveryInfos.productName |
| orgcode | 独自商品コード | productCustomCode | 独自商品コード | orders.deliveryInfos.basketInfos.productCustomCode |
| orgoptioncode | 独自オプションコード | variationCustomCode optionCode |
バリエーション独自コード オプショングループコード |
orders.deliveryInfos.basketInfos.variationCustomCode orders.deliveryInfos.basketInfos.optionCode |
| option | オプション情報 | optionCode | オプショングループコード | orders.deliveryInfos.basketInfos.optionCode |
| jancode | JANコード | janCode | orders.deliveryInfos.basketInfos.janCode | |
| dcrate | 割引率 | discountRate | 割引率 | orders.deliveryInfos.basketInfos.discountRate |
| price | 販売価格 | price | 商品価格 | orders.deliveryInfos.basketInfos.price |
| amount | 注文個数 | amount | 商品数量 | orders.deliveryInfos.basketInfos.amount |
| point | 各種ポイント付与率 | grantedShopPoint | 商品ポイント | orders.deliveryInfos.basketInfos.grantedShopPoint |
| consumption_tax_rate | 消費税率 | taxRate | 税率 |
orders.priceInfoPerTaxRate.taxRate orders.discountPerTax.taxRate orders.deliveryInfos.basketInfos.taxRate |
| nameoption | 名入れオプション | productNameOptions | orders.deliveryInfos.basketInfos.productNameOptions | |
| label1 | 名入れ項目名1 | label1 | orders.deliveryInfos.basketInfos.productNameOptions.label1 | |
| comment1 | 名入れ入力内容1 | comment1 | orders.deliveryInfos.basketInfos.productNameOptions.comment1 | |
| label2 | 名入れ項目名2 | label2 | orders.deliveryInfos.basketInfos.productNameOptions.label2 | |
| comment2 | 名入れ入力内容2 | comment2 | orders.deliveryInfos.basketInfos.productNameOptions.comment2 | |
| label3 | 名入れ項目名3 | label3 | orders.deliveryInfos.basketInfos.productNameOptions.label3 | |
| comment3 | 名入れ入力内容3 | comment3 | orders.deliveryInfos.basketInfos.productNameOptions.comment3 | |
| label4 | 名入れ項目名4 | label4 | orders.deliveryInfos.basketInfos.productNameOptions.label4 | |
| comment4 | 名入れ入力内容4 | comment4 | orders.deliveryInfos.basketInfos.productNameOptions.comment4 | |
| label5 | 名入れ項目名5 | label5 | orders.deliveryInfos.basketInfos.productNameOptions.label5 | |
| comment5 | 名入れ入力内容5 | comment5 | orders.deliveryInfos.basketInfos.productNameOptions.comment5 | |
| label6 | 名入れ項目名6 | label6 | orders.deliveryInfos.basketInfos.productNameOptions.label6 | |
| comment6 | 名入れ入力内容6 | comment6 | orders.deliveryInfos.basketInfos.productNameOptions.comment6 | |
| label7 | 名入れ項目名7 | label7 | orders.deliveryInfos.basketInfos.productNameOptions.label7 | |
| comment7 | 名入れ入力内容7 | comment7 | orders.deliveryInfos.basketInfos.productNameOptions.comment7 | |
| label8 | 名入れ項目名8 | label8 | orders.deliveryInfos.basketInfos.productNameOptions.label8 | |
| comment8 | 名入れ入力内容8 | comment8 | orders.deliveryInfos.basketInfos.productNameOptions.comment8 | |
| label9 | 名入れ項目名9 | label9 | orders.deliveryInfos.basketInfos.productNameOptions.label9 | |
| comment9 | 名入れ入力内容9 | comment9 | orders.deliveryInfos.basketInfos.productNameOptions.comment9 | |
| label10 | 名入れ項目名10 | label10 | orders.deliveryInfos.basketInfos.productNameOptions.label10 | |
| comment10 | 名入れ入力内容10 | comment10 | orders.deliveryInfos.basketInfos.productNameOptions.comment10 | |
| amount | 数量 | amount | orders.deliveryInfos.basketInfos.amount orders.deliveryInfos.basketInfos.productNameOptions.amount |
|
| couponname | クーポン名 | couponName | クーポン名 (2024.03.25追加) | orders.couponInfo.couponName |
| couponcode | クーポンコード | couponCode | クーポンコード (2024.03.25追加) | orders.couponInfo.couponCode |
| coupon | クーポン割引額 | couponDiscount | クーポン割引額 (2024.03.25追加) | orders.couponInfo.couponDiscount |
| bulk | まとめ買い割引額 | bulkPurchaseDiscount | まとめ買い割引額 (2024.05.23追加) | orders.bulkPurchaseDiscount |
| carriage | 送料 | shippingCharge | 配送料金 | orders.deliveryInfos.shippingCharge |
| commission | 決済手数料 | paymentFee | 決済手数料 | orders.paymentFee |
| point | memberGroupPoint | 会員グループ別追加ポイント数 | orders.memberGroupPoint | |
| dcprice | cashDiscountAmount | 会員グループの割引額 | orders.cashDiscountAmount | |
| usepoint | 利用ポイント | reserve | 注文者の使用ポイント | orders.reserve |
| correction | 修正額 | revisedPrice | 注文金額の修正額 (2024.05.23追加) | orders.revisedPrice |
| orderprice | 注文合計額 | sumPriceOrg | 注文合計金額（注文合計金額修正前の合計金額） | orders.revisedPrice |
| sumprice | 支払金額 | sumPrice | 注文合計金額 | orders.sumPrice |
| price_per_tax_rate_list | 税率毎の合計金額群 | - | - | - |
| price_per_tax_rate tax_rate | 各税率の合計金額値 | - | - | - |
| tax_per_tax_rate_list | 税率毎の消費税額群 | priceInfoPerTaxRate | 税率ごとの価格や税額の情報 | orders.priceInfoPerTaxRate |
| tax_per_tax_rate tax_rate | 各税率の合計消費税額値 | priceInfoPerTaxRate | 税率ごとの価格や税額の情報 | orders.priceInfoPerTaxRate |
| buyer | 注文者情報群 |
senderCompany senderCompanyKana senderCompanyDept senderName senderNameKana senderPost senderPrefecture senderAddress senderAddress2 senderTel senderEmergencyTel senderEmail delFlag ipAddress |
注文者法人名 注文者法人かな名 注文者法人部署名 注文者名 注文者かな名 注文者郵便番号 注文者住所(都道府県) 注文者住所(市区町村・番地など) 注文者住所(それ以降) 注文者電話番号 注文者緊急連絡先 注文者Email 注文不可視フラグ N：デフォルト値 Y：不可視 deprecated R：在庫復旧済み 注文者のIPアドレス |
orders.senderCompany orders.senderCompanyKana orders.senderCompanyDept orders.senderName orders.senderNameKana orders.senderPost orders.senderPrefecture orders.senderAddress orders.senderAddress2 orders.senderTel orders.senderEmergencyTel orders.senderEmail orders.delFlag orders.ipAddress |
| id | 注文者ID | memberId | 会員ID 4~12桁の英数 | orders.memberId |
| office_name | 会社名 | receiverCompany | 受取人法人名 | orders.deliveryInfos.receiverCompany |
| office_name_kana | 会社名（フリガナ） | receiverCompanyKana | 受取人法人かな名 | orders.deliveryInfos.receiverCompanyKana |
| department | 部署名 | receiverCompanyDept | 受取人部署名 | orders.deliveryInfos.receiverCompanyDept |
| name | 名前 | receiverName | 受取人名 | orders.deliveryInfos.receiverName |
| kana | フリガナ | receiverNameKana | 受取人名（カタカナ） | orders.deliveryInfos.receiverNameKana |
| tel | 電話番号 | receiverTel | 受取人電話番号 | orders.deliveryInfos.receiverTel |
| tel2 | 電話番号2 | receiverTel | 受取人電話番号 | orders.deliveryInfos.receiverTel |
| メールアドレス | senderEmail | 注文者Email | orders.senderEmail | |
| zip | 郵便番号 | receiverPost | 受取人郵便番号 | orders.deliveryInfos.receiverPost |
| address | 住所 | receiverAddress receiverAddress2 |
受取人住所(市区町村・番地など) 受取人住所(それ以降) |
orders.deliveryInfos.receiverAddress orders.deliveryInfos.receiverAddress2 |
| area | 都道府県 | receiverPrefecture | 受取人住所(都道府県) | orders.deliveryInfos.receiverPrefecture |
| city | 市区町村 | receiverAddress | 受取人住所(市区町村・番地など) | orders.deliveryInfos.receiverAddress |
| street | それ以降の住所 | receiverAddress2 | 受取人住所(それ以降) | orders.deliveryInfos.receiverAddress2 |
| membergroup | 会員グループ群 | - | - | - |
| id | 会員グループコード | - | - | - |
| name | 会員グループ名 | - | - | - |
| deliveries | 配送先群 | deliveryId | 配送先ID | orders.deliveryInfos.deliveryId |
| delivery | 配送先 | - | - | - |
| office_name | 会社名 | receiverCompany | 受取人法人名 | orders.deliveryInfos.receiverCompany |
| office_name_kana | 会社名（フリガナ） | receiverCompanyKana | 受取人法人かな名 | orders.deliveryInfos.receiverCompanyKana |
| department | 部署名 | receiverCompanyDept | 受取人部署名 | orders.deliveryInfos.receiverCompanyDept |
| name | 名前 | receiverName | 受取人名 | orders.deliveryInfos.receiverName |
| kana | フリガナ | receiverNameKana | 受取人名（カタカナ） | orders.deliveryInfos.kana |
| tel | 電話番号 | receiverTel | 受取人電話番号 | orders.deliveryInfos.receiverTel |
| zip | 郵便番号 | receiverPost | 受取人郵便番号 | orders.deliveryInfos.receiverPost |
| area | 都道府県 | receiverPrefecture | 受取人住所(都道府県) | orders.deliveryInfos.receiverPrefecture |
| address | 住所 | receiverAddress receiverAddress2 |
受取人住所(市区町村・番地など) 受取人住所(それ以降) |
orders.deliveryInfos.receiverAddress orders.deliveryInfos.receiverAddress2 |
| city | 市区町村 | receiverAddress | 受取人住所(市区町村・番地など) | orders.deliveryInfos.receiverAddress |
| street | それ以降の住所 | receiverAddress2 | 受取人住所(それ以降) | orders.deliveryInfos.receiverAddress2 |
| deliverydate | 配送希望日 | desiredDeliveryDate | 配送希望日 | orders.deliveryInfos.desiredDeliveryDate |
| deliverytime | 配送希望時間 | desiredDeliveryTimezone | 配送希望時間帯 | orders.deliveryInfos.desiredDeliveryTimezone |
| commodities | 明細群 | - | - | - |
| commodity | 明細 | - | - | - |
| name | 商品名 | productName | 商品名 | orders.deliveryInfos.basketInfos.productName |
| option | オプション名 | variationName | バリエーション情報 バリエーションおよびオプショングループの選択項目 |
orders.deliveryInfos.basketInfos.variationName |
| brandcode | システム商品コード | productCode | システム商品コード | orders.deliveryInfos.basketInfos.productCode |
| orgcode | 独自商品コード | productCustomCode | 独自商品コード | orders.deliveryInfos.basketInfos.productCustomCode |
| orgoptioncode | 独自オプションコード | optionCode | オプショングループコード | orders.deliveryInfos.basketInfos.optionCode |
| price | 販売価格 | price | 商品価格 | orders.deliveryInfos.basketInfos.price |
| point | ポイント | grantedShopPoint | 商品ポイント | orders.deliveryInfos.basketInfos.grantedShopPoint |
| amount | 注文個数 | amount | 商品数量 | orders.deliveryInfos.basketInfos.amount |
| consumption_tax_rate | 消費税率 | tax | 消費税 | orders.priceInfoPerTaxRate.tax |
| consumption_tax | 商品毎の消費税額 | - | - | - |
| nameoption | 名入れオプション | productNameOptions | orders.deliveryInfos.basketInfos.productNameOptions | |
| label1 | 名入れ項目名1 | |||
| label1 | 名入れ項目名1 | label1 | orders.deliveryInfos.basketInfos.productNameOptions.label1 | |
| comment1 | 名入れ入力内容1 | comment1 | orders.deliveryInfos.basketInfos.productNameOptions.comment1 | |
| label2 | 名入れ項目名2 | label2 | orders.deliveryInfos.basketInfos.productNameOptions.label2 | |
| comment2 | 名入れ入力内容2 | comment2 | orders.deliveryInfos.basketInfos.productNameOptions.comment2 | |
| label3 | 名入れ項目名3 | label3 | orders.deliveryInfos.basketInfos.productNameOptions.label3 | |
| comment3 | 名入れ入力内容3 | comment3 | orders.deliveryInfos.basketInfos.productNameOptions.comment3 | |
| label4 | 名入れ項目名4 | label4 | orders.deliveryInfos.basketInfos.productNameOptions.label4 | |
| comment4 | 名入れ入力内容4 | comment4 | orders.deliveryInfos.basketInfos.productNameOptions.comment4 | |
| label5 | 名入れ項目名5 | label5 | orders.deliveryInfos.basketInfos.productNameOptions.label5 | |
| comment5 | 名入れ入力内容5 | comment5 | orders.deliveryInfos.basketInfos.productNameOptions.comment5 | |
| label6 | 名入れ項目名6 | label6 | orders.deliveryInfos.basketInfos.productNameOptions.label6 | |
| comment6 | 名入れ入力内容6 | comment6 | orders.deliveryInfos.basketInfos.productNameOptions.comment6 | |
| label7 | 名入れ項目名7 | label7 | orders.deliveryInfos.basketInfos.productNameOptions.label7 | |
| comment7 | 名入れ入力内容7 | comment7 | orders.deliveryInfos.basketInfos.productNameOptions.comment7 | |
| label8 | 名入れ項目名8 | label8 | orders.deliveryInfos.basketInfos.productNameOptions.label8 | |
| comment8 | 名入れ入力内容8 | comment8 | orders.deliveryInfos.basketInfos.productNameOptions.comment8 | |
| label9 | 名入れ項目名9 | label9 | orders.deliveryInfos.basketInfos.productNameOptions.label9 | |
| comment9 | 名入れ入力内容9 | comment9 | orders.deliveryInfos.basketInfos.productNameOptions.comment9 | |
| label10 | 名入れ項目名10 | label10 | orders.deliveryInfos.basketInfos.productNameOptions.label10 | |
| comment10 | 名入れ入力内容10 | comment10 | orders.deliveryInfos.basketInfos.productNameOptions.comment10 | |
| amount | 数量 | amount | orders.deliveryInfos.basketInfos.productNameOptions.amount | |
| delivery_id | deliveryId | 配送先ID | orders.deliveryInfos.deliveryId | |
| delivery_status | 配送ステータス | tax | 消費税 | orders.priceInfoPerTaxRate.tax |
| scheduled_shipping_date | 出荷予定日 | estimatedShipmentDate | 出荷予定日 | orders.deliveryInfos.estimatedShipmentDate |
| shipping_date | 配送完了日時 | deliveryDate | 配送完了日 | orders.deliveryInfos.deliveryDate |
| delivery_order | 出荷指示 | wmsStatus | 出荷指示ステータス | orders.deliveryInfos.wmsStatus |
| carrier | 配送業者コード | deliveryCompanyCode | 配送会社コード | orders.deliveryInfos.deliveryCompanyCode |
| daliverynum | 配送伝票番号 | slipNumber | 配送伝票番号 | orders.deliveryInfos.slipNumber |
| carriage | 配送方法 | deliveryMethodIds | 配送方法ID | orders.deliveryInfos.deliveryMethodIds |
| notes | 配送備考項目群 | deliveryMessage | 配送備考 | orders.deliveryInfos.deliveryMessage |
| note | 配送備考情報項目 | deliveryMessage | 配送備考 | orders.deliveryInfos.deliveryMessage |
| notes | 記載事項情報項目群 | deliveryMessage | 配送備考 | orders.deliveryInfos.deliveryMessage |
| note | 記載事項情報項目 | deliveryMessage | 配送備考 | orders.deliveryInfos.deliveryMessage |
| combined_paymethod | 併用の支払方法 | - | - | - |
| combined_price | 併用の支払での金額 | - | - | - |
・注文登録API
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| id | ショップID | id | Response識別用のID | input.input.id |
| auth_code | 認証コード | - | - | - |
| order | 注文情報 | orderProduct | 注文する商品情報 | input.orderRequests.orderProduct |
| no | 項番 | - | - | - |
| paymethod | 決済方法 | paymethod | 決済方法 | input.orderRequests.paymentInfo.paymethod |
| bankinfo | 銀行振込先情報 | BANK | 銀行振込 | input.orderRequests.paymentInfo.paymethod.BANK |
| payment_token | 決済トークン | paymentToken | 決済トークン | input.orderRequests.paymentInfo.paymentToken |
| credit_card_corp | クレジットカード会社名 | creditCardCorp | クレジットカード会社名 | input.orderRequests.paymentInfo.creditCardCorp |
| repay_method | 代金引換配送時決済方法 | repayMethod | 代引き時の決済方法 | input.orderRequests.paymentInfo.repayMethod |
| member_id | 会員ID | memberId | 会員ID | input.orderRequests.paymentInfo.memberId |
| tax | 消費税額合計 | totalTax | 消費税合計 | input.orderRequests.paymentInfo.totalTax |
| tax_type | 消費税フラグ | taxType | 消費税タイプ | input.orderRequests.paymentInfo.taxType |
| tax_calculation_method | 消費税計算方法 | taxCalculationMethod | 消費税計算方法 | input.orderRequests.paymentInfo.taxCalculationMethod |
| delivery_fee | 配送手数料合計 | deliveryFee | 配送⼿数料合計 | input.orderRequests.deliveryRequestInfo.deliveryFee |
| payment_fee | 決済手数料 | paymentFee | 決済⼿数料 | input.orderRequests.paymentInfo.paymentFee |
| correction_amount | 修正額 | correctionAmount | 項目外の値引き・付随費用 | input.orderRequests.paymentInfo.correctionAmount |
| usepoint | ポイント利用額 | usePoint | ポイント利用額 | input.orderRequests.paymentInfo.usePoint |
| price | 請求金額 | price | 請求金額 | input.orderRequests.paymentInfo.price |
| 0percent_tax_price | 消費税0%対象請求金額 | - | - | - |
| 8percent_tax_price | 消費税8%対象請求金額 | - | - | - |
| 10percent_tax_price | 消費税10%対象請求金額 | - | - | - |
| tax_rate8 | 消費税8% | - | - | - |
| tax_rate10 | 消費税10% | - | - | - |
| name | 注文者のお名前 | name | 注文者の名前 | input.orderRequests.customerInfo.name |
| kana | 注文者のお名前フリガナ | nameKana | 注文者の名前（カナ） | input.orderRequests.customerInfo.nameKana |
| office_name | 注文者の会社名 | officeName | 注文者の会社名 | input.orderRequests.customerInfo.officeName |
| office_name_kana | 注文者の会社名フリガナ | officeNameKana | 注文者の会社名（カナ） | input.orderRequests.customerInfo.officeNameKana |
| department | 注文者の部署名 | department | 注文者の部署名 | input.orderRequests.customerInfo.department |
| 注文者のメールアドレス | 注文者のメールアドレス | input.orderRequests.customerInfo.email | ||
| zip | 注文者の郵便番号 | post | 注文者の郵便番号 | input.orderRequests.customerInfo.post |
| prefecture | 注文者の都道府県 | prefectureCode | 注文者の都道府県コード | input.orderRequests.customerInfo.prefectureCode |
| city | 注文者の市区町村 | address | 注文者の市区町村 | input.orderRequests.customerInfo.address |
| other_address | 注文者のそれ以降の住所 | address2 | 注文者の以降の住所 | input.orderRequests.customerInfo.address2 |
| tel | 注文者の電話番号 | telephone | 注文者の電話番号 | input.orderRequests.customerInfo.telephone |
| delivery_name | お届け先のお名前 | receiverName | お届け先の名前 | input.orderRequests.deliveryRequestInfo.receiverName |
| delivery_kana | お届け先のお名前フリガナ | receiverNameKana | お届け先の名前（カナ） | input.orderRequests.deliveryRequestInfo.receiverNameKana |
| delivery_office_name | お届け先の会社名 | receiverCompany | お届け先の会社名 | input.orderRequests.deliveryRequestInfo.receiverCompany |
| delivery_office_name_kana | お届け先の会社名フリガナ | receiverCompanyKana | お届け先の会社名（カナ） | input.orderRequests.deliveryRequestInfo.receiverCompanyKana/td> |
| delivery_department | お届け先の部署名 | receiverCompanyDept | お届け先の部署名 | input.orderRequests.deliveryRequestInfo.receiverCompanyDept |
| delivery_zip | お届け先の郵便番号 | receiverPost | お届け先の郵便番号 | input.orderRequests.deliveryRequestInfo.receiverPost |
| delivery_prefecture | お届け先の都道府県 | receiverPrefectureCode | お届け先の都道府県コード | input.orderRequests.deliveryRequestInfo.receiverPrefectureCode |
| delivery_city | お届け先の市区町村 | receiverAddress | お届け先の市区町村 | input.orderRequests.deliveryRequestInfo.receiverAddress |
| delivery_other_address | お届け先のそれ以降の住所 | receiverAddress2 | お届け先の以降の住所 | input.orderRequests.deliveryRequestInfo.receiverAddress2 |
| delivery_tel | お届け先の電話番号 | receiverTel | お届け先の電話番号 | input.orderRequests.deliveryRequestInfo.receiverTel |
| delivery_method | 配送方法 | deliveryMethod | 配送方法名称 | input.orderRequests.deliveryRequestInfo.deliveryMethod |
| delivery_hope_date | 配送希望日 | desiredDeliveryDate | 配達希望日 | input.orderRequests.deliveryRequestInfo.desiredDeliveryDate |
| delivery_hope_time | 配送希望時間帯 | desiredDeliveryTimezone | 配達希望時間帯 | input.orderRequests.deliveryRequestInfo.desiredDeliveryTimezone |
| order_message | 連絡事項 | otherMessage | 注文者からの連絡事項 | input.orderRequests.customerInfo.otherMessage |
| add_order_message | 追加連絡事項 | - | - | - |
| title | 追加項目名 | - | - | - |
| content | 追加項目内容 | - | - | - |
| ordermemo | 管理者メモ | orderMemo | 管理者メモ | input.orderRequests.orderMemo |
| cycle_base_date | 定期購入商品の初回お届け日 | cycleBaseDate | 定期購⼊商品の初回お届け⽇ | input.orderRequests.cycleInfo.cycleBaseDate |
| cycle_type | お届けサイクルタイプ | cycleType | お届けサイクルタイプ | input.orderRequests.cycleInfo.cycleType |
| cycle_option | お届けサイクルオプション | cycleDate cycleWeekOfMonth cycleDayOfWeek cycleIntervalDays cycleIntervalMonths |
お届けする日付 お届けする週 お届けする曜日 お届けする間隔（日） お届けする間隔（月） |
input.orderRequests.cycleInfo.cycleDate input.orderRequests.cycleInfo.cycleWeekOfMonth input.orderRequests.cycleInfo.cycleDayOfWeek input.orderRequests.cycleInfo.cycleIntervalDays input.orderRequests.cycleInfo.cycleIntervalMonths |
| credit_card_registered | 通常商品用カード登録フラグ | saveCreditCard | カード保存フラグ | input.orderRequests.paymentInfo.saveCreditCard |
| credit_card_registered | 登録済みカードの利用フラグ | saveCreditCard | カード保存フラグ | input.orderRequests.paymentInfo.saveCreditCard |
| credit_card_id | 登録済みカード登録連番 | useSavedCreditCard | 保存クレジットカード | input.orderRequests.paymentInfo.useSavedCreditCard |
| order_brand | 注文商品 | orderProduct | 注文する商品情報 | input.orderRequests.orderProduct |
| brandcode | システム商品コード | systemCode | システム商品コード | input.orderRequests.orderProduct.systemCode |
| option1_item_id | オプション1項目ID | variation1ItemId | バリエーション1項⽬ID | input.orderRequests.orderProduct.variation1ItemId |
| option2_item_id | オプション2項目ID | variation2ItemId | バリエーション2項⽬ID | input.orderRequests.orderProduct.variation2ItemId |
| option_group | オプショングループノード | optionGroup | オプショングループ | input.orderRequests.orderProduct.optionGroup |
| option_id | オプションID | optionId | オプションID | input.orderRequests.orderProduct.optionGroup.optionId |
| item_id | アイテムID | itemId | アイテムID | input.orderRequests.orderProduct.optionGroup.itemId |
| specify_amount | 追加金額 | productPrice | 商品の販売価格 | input.orderRequests.orderProduct.productPrice! |
| brand_name | 商品名 | productName | 商品名 | input.orderRequests.orderProduct.productNameOption |
| brand_price | 販売価格 | productPrice | 商品の販売価格 | input.orderRequests.orderProduct.productPrice! |
| order_amount | 数量 | orderAmount | 数量 | input.orderRequests.orderProduct.orderAmount |
| add_point | 付与ポイント | addPoint | 付与ポイント 付与ポイントを指定する場合は、会員IDが必須となります。 |
input.orderRequests.orderProduct.addPoint |
| tax_rate | 消費税率 | taxRate | 消費税率 | input.orderRequests.orderProduct.taxRate |
| reduced_tax_rate | 軽減税率区分 | reducedTaxRate | 軽減税率区分 | input.orderRequests.orderProduct.reducedTaxRate |
| repeat_sale_brand | 定期購入商品フラグ | repeatSaleProduct | 定期購⼊商品フラグ | input.orderRequests.orderProduct.repeatSaleProduct |
| brand_name_option | 名入れ | productNameOption | 名入れ (2024.08.29追加) |
input.orderRequests.orderProduct.productNameOption |
| brand_name_option1 | 名入れ項目1 | productNameOption1 | 名入れ内容1 | input.orderRequests.orderProduct.productNameOption.productNameOption1 |
| brand_name_option2 | 名入れ項目2 | productNameOption2 | 名入れ内容2 | input.orderRequests.orderProduct.productNameOption.productNameOption2 |
| brand_name_option3 | 名入れ項目3 | productNameOption3 | 名入れ内容3 | input.orderRequests.orderProduct.productNameOption.productNameOption3 |
| brand_name_option4 | 名入れ項目4 | productNameOption4 | 名入れ内容4 | input.orderRequests.orderProduct.productNameOption.productNameOption4 |
| brand_name_option5 | 名入れ項目5 | productNameOption5 | 名入れ内容5 | input.orderRequests.orderProduct.productNameOption.productNameOption5 |
| brand_name_option6 | 名入れ項目6 | productNameOption6 | 名入れ内容6 | input.orderRequests.orderProduct.productNameOption.productNameOption6 |
| brand_name_option7 | 名入れ項目7 | productNameOption7 | 名入れ内容7 | input.orderRequests.orderProduct.productNameOption.productNameOption7 |
| brand_name_option8 | 名入れ項目8 | productNameOption8 | 名入れ内容8 | input.orderRequests.orderProduct.productNameOption.productNameOption8 |
| brand_name_option9 | 名入れ項目9 | productNameOption9 | 名入れ内容9 | input.orderRequests.orderProduct.productNameOption.productNameOption9 |
| brand_name_option10 | 名入れ項目10 | productNameOption10 | 名入れ内容10 | input.orderRequests.orderProduct.productNameOption.productNameOption10 |
| coupon_code | クーポンコード | couponCode | クーポンコード | input.orderRequests.couponCode |
| coupon_discount_price | クーポン割引額 | couponDiscountPrice | クーポン割引額 | input.orderRequests.couponDiscountPrice |
| is_plural_delivery | ギフト配送フラグ | isGiftOrder | ギフト注文フラグ | input.orderRequests.isGiftOrder |
| plural_delivery | ギフト配送 | - | - | - |
| delivery_id | 配送先ID | deliveryId | 配送先ID | input.orderRequests.deliveryRequestInfo.deliveryId |
| delivery_name | お届け先のお名前 | receiverName | お届け先の名前 | input.orderRequests.deliveryRequestInfo.receiverName |
| delivery_kana | お届け先のお名前フリガナ | receiverNameKana | お届け先の名前（カナ） | input.orderRequests.deliveryRequestInfo.receiverNameKana |
| delivery_office_name | お届け先の会社名 | receiverCompany | お届け先の会社名 | input.orderRequests.deliveryRequestInfo.receiverCompany |
| delivery_office_name_kana | お届け先の会社名フリガナ | receiverCompanyKana | お届け先の会社名（カナ） | input.orderRequests.deliveryRequestInfo.receiverCompanyKana |
| delivery_department | お届け先の部署名 | receiverCompanyDept | お届け先の部署名 | input.orderRequests.deliveryRequestInfo.receiverCompanyDept |
| delivery_zip | お届け先の郵便番号 | receiverPost | お届け先の郵便番号 | input.orderRequests.deliveryRequestInfo.receiverPost |
| delivery_prefecture | お届け先の都道府県 | receiverPrefectureCode | お届け先の都道府県コード | input.orderRequests.deliveryRequestInfo.receiverPrefectureCode |
| delivery_city | お届け先の市区町村 | receiverAddress | お届け先の市区町村 | input.orderRequests.deliveryRequestInfo.receiverAddress |
| delivery_other_address | お届け先のそれ以降の住所 | receiverAddress2 | お届け先の以降の住所 | input.orderRequests.deliveryRequestInfo.receiverAddress2 |
| delivery_tel | お届け先の電話番号 | receiverTel | お届け先の電話番号 | input.orderRequests.deliveryRequestInfo.receiverTel |
| delivery_method | 配送方法 | deliveryMethod | 配送方法名称 | input.orderRequests.deliveryRequestInfo.deliveryMethod |
| deli_price | 配送手数料 | deliveryFee | 配送⼿数料合計 | input.orderRequests.deliveryRequestInfo.deliveryFee |
| delivery_hope_date | 配送希望日 | desiredDeliveryDate | 配達希望日 | input.orderRequests.deliveryRequestInfo.desiredDeliveryDate |
| delivery_hope_time | 配送希望時間帯 | desiredDeliveryTimezone | 配達希望時間帯 | input.orderRequests.deliveryRequestInfo.desiredDeliveryTimezone |
| delivery_message | 連絡事項（配送備考） | otherMessage | 注文者からの連絡事項 | input.orderRequests.customerInfo.otherMessage |
| delivery_memo | 管理者メモ （ギフト配送用） | otherMessage | 注文者からの連絡事項 | input.orderRequests.customerInfo.otherMessage |
| order_brand | 注文商品 | orderProduct | 注文する商品情報 | input.orderRequests.orderProduct |
| brandcode | システム商品コード | systemCode | システム商品コード | input.orderRequests.orderProduct.systemCode |
| option1_item_id | オプション1項目ID | variation1ItemId | バリエーション1項⽬ID | input.orderRequests.orderProduct.variation1ItemId |
| option2_item_id | オプション2項目ID | variation2ItemId | バリエーション2項⽬ID | input.orderRequests.orderProduct.variation2ItemId |
| option_group | オプショングループノード | optionGroup | オプショングループ | input.orderRequests.orderProduct.optionGroup |
| option_id | オプションID | optionId | オプションID | input.orderRequests.orderProduct.optionGroup.optionId |
| item_id | アイテムID | itemId | アイテムID | input.orderRequests.orderProduct.optionGroup.itemId |
| specify_amount | 追加金額 | specifyAmount | 追加⾦額 | input.orderRequests.orderProduct.optionGroup.pecifyAmount |
| brand_name | 商品名 | productName | 商品名 | input.orderRequests.orderProduct.productNameOption |
| brand_price | 販売価格 | productPrice | 商品の販売価格 | input.orderRequests.orderProduct.productPrice |
| order_amount | 数量 | orderAmount | 数量 | input.orderRequests.orderProduct.orderAmount |
| add_point | 付与ポイント | addPoint | 付与ポイント 付与ポイントを指定する場合は、会員IDが必須となります。 |
input.orderRequests.orderProduct.addPoint |
| tax_rate | 消費税率 | taxRate | 消費税率 | input.orderRequests.orderProduct.taxRate |
| reduced_tax_rate | 軽減税率区分 | reducedTaxRate | 軽減税率区分 | input.orderRequests.orderProduct.reducedTaxRate |
| brand_name_option | 名入れ | productNameOption | 名入れ (2024.08.29追加) |
input.orderRequests.orderProduct.productNameOption |
| brand_name_option1 | 名入れ項目1 | productNameOption1 | 名入れ内容1 | input.orderRequests.orderProduct.productNameOption.productNameOption1 |
| brand_name_option2 | 名入れ項目2 | productNameOption2 | 名入れ内容2 | input.orderRequests.orderProduct.productNameOption.productNameOption2 |
| brand_name_option3 | 名入れ項目3 | productNameOption3 | 名入れ内容3 | input.orderRequests.orderProduct.productNameOption.productNameOption3 |
| brand_name_option4 | 名入れ項目4 | productNameOption4 | 名入れ内容4 | input.orderRequests.orderProduct.productNameOption.productNameOption4 |
| brand_name_option5 | 名入れ項目5 | productNameOption5 | 名入れ内容5 | input.orderRequests.orderProduct.productNameOption.productNameOption5 |
| brand_name_option6 | 名入れ項目6 | productNameOption6 | 名入れ内容6 | input.orderRequests.orderProduct.productNameOption.productNameOption6 |
| brand_name_option7 | 名入れ項目7 | productNameOption7 | 名入れ内容7 | input.orderRequests.orderProduct.productNameOption.productNameOption7 |
| brand_name_option8 | 名入れ項目8 | productNameOption8 | 名入れ内容8 | input.orderRequests.orderProduct.productNameOption.productNameOption8 |
| brand_name_option9 | 名入れ項目9 | productNameOption9 | 名入れ内容9 | input.orderRequests.orderProduct.productNameOption.productNameOption9 |
| brand_name_option10 | 名入れ項目10 | productNameOption10 | 名入れ内容10 | input.orderRequests.orderProduct.productNameOption.productNameOption10 |
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| no | 項番 | - | - | - |
| ordernum | 注文番号 | displayOrderNumber | 注文番号 | orderResults.displayOrderNumber |
| error_message | エラーメッセージ | errorMessage | エラーメッセージ | orderResults.errorMessage |
| no | 項番 | - | - | - |
| error_message | エラーメッセージ | errorMessage | エラーメッセージ | orderResults.errorMessage |
・注文状態変更API
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| cmd | APIの動作指定 | - | - | - |
| ordernum | 注文番号 | displayOrderNumber | 注文番号 | updateOrderAttributes.displayOrderNumber |
| deliveryid | 配送先ID | deliveryId | 配送先ID | updateOrderAttributes.deliveryRequestInfos.deliveryId |
| status | 注文キャンセル | - | - | - |
| result | キャンセル理由 | consoleMemo | 対応メモ | updateOrderAttributes.deliveryRequestInfos.consoleMemo |
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| response | レスポンス内容 | - | - | - |
| ordernum | 注文番号 | displayOrderNumber | 注文番号 | updateOrderAttributeResults.displayOrderNumber |
| code | レスポンスコード | - | - | - |
| message | エラーメッセージ | message | エラーメッセージ | updateOrderAttributeResults.message |
・配送状態変更API
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| cmd | APIの動作指定 | - | - | - |
| ordernum | 注文番号 | displayOrderNumber | 注文番号 | updateOrderDeliveryStatusRequests.displayOrderNumber |
| deliveryid | 配送先ID | deliveryId | 配送先ID | updateOrderDeliveryStatusRequests.deliveryId |
| status | 配送ステータス変更 | deliveryStatus | 配送ステータス | updateOrderDeliveryStatusRequests.deliveryStatus |
| carrier | 配送業者コード | - | - | - |
| deliverynum | 配送伝票番号 | - | - | - |
| send_mail | メール送信 | - | - | - |
| result | キャンセル理由 | - | - | - |
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| response | レスポンス内容 | updateOrderDeliveryStatusResults | updateOrderAttributeResults | |
| ordernum | 注文番号 | displayOrderNumber | 注文番号 | updateOrderAttributeResults.displayOrderNumber |
| code | レスポンスコード | - | - | - |
| message | エラーメッセージ | message | エラーメッセージ | updateOrderAttributeResults.message |
・更新通知機能
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| [SHOPID] | ショップID | shop_id | ショップID | shop_id |
| [ORDERNUM] | 注文番号 | order_num | 注文番号 | order_num |
| [CMD] | 通知種別 | cmd | 処理種別 | cmd |
シングルサインオンAPI
・ユーザー認証API
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| response_type | レスポンスタイプ(OIDC準拠) | response_type | レスポンスタイプ(OIDC準拠) | response_typ |
| client_id | クライアントID | client_id | クライアントID | client_id |
| redirect_uri | リダイレクト先URL | redirect_uri | ログイン後のリダイレクト先URL | redirect_uri |
| scope | makeshopのリソースにアクセスする範囲を指定する。openid固定。 | - | - | - |
| state | CSRF防止用の文字列 | state | CSRF防止用の文字列 | state |
| nonce | リプレイアタック防止用の文字列 | nonce | リプレイアタック防止用の文字列 | nonce |
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| code | 認可コード | code | 認可コード | code |
| state | CSRF防止用の文字列 | state | CSRF防止用の文字列 | state |
・アクセストークン発行API
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| grant_type | グラントタイプ(OIDC準拠) | grant_type | グラントタイプ(OIDC準拠) | grant_type |
| client_id | クライアントID | client_id | クライアントID | client_id |
| client_secret | クライアントパスワード | - | - | - |
| code | 認可コード | code | 認可コード | code |
| redirect_uri | リダイレクト先URL | redirect_uri | ログイン後のリダイレクト先URL | redirect_uri |
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| access_token | アクセストークン | access_token | 一時トークン | access_token |
| token_type | トークンタイプ(OIDC準拠) | token_type | トークンタイプ(OIDC準拠) | token_type |
| expires_in | アクセストークンが失効するまでの秒数 | expires_in | 一時トークンの有効期限 | expires_in |
| scope | APIの利用権限 | scope | APIの利用権限 | scope |
| id_token | 会員認証イベントに関する情報 | id_token | nonce検証用トークン | id_token |
・IDトークン ヘッダ部
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| typ | オブジェクト形式 | - | - | - |
| alg | JWS署名の暗号アルゴリズム | - | - | - |
・IDトークン ペイロード部（クレーム・セット）
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| iss | 発行者 | - | - | - |
| sub | 会員のSubject識別子 | - | - | - |
| aud | クライアントID | - | - | - |
| exp | IDトークンの有効期限 | - | - | - |
| iat | IDトークンが発行された時刻 | - | - | - |
| nonce | リプレイアタック防止用の文字列 | - | - | - |
| at_hash | アクセストークンのハッシュ値 | - | - | - |
・会員ID取得API
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| access_token | アクセストークン | - | - | - |
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| sub | 会員のSubject識別子 | - | - | - |
| member_id | ログインした会員ID | sub | 会員ID | sub |
・ログアウト連携API
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| id_token_hint | 以前発行したIDトークン | id_token_hint | トークン取得APIで発行したIDトークン | id_token_hint |
| post_logout_redirect_uri | ログアウト後のリダイレクト先URL | post_logout_redirect_uri | ログアウト後のリダイレクト先URL | post_logout_redirect_uri |
| state | CSRF防止用の文字列 | state | CSRF防止用の文字列 | state |
| 旧API Field | 新API Field | |||
|---|---|---|---|---|
| Field名 | 項目名 | Field名 | 項目名 | 階層 |
| state | - | - | - | |