닫기

  • Product

  • Category

  • Personal

    non-print

    API Index

    Introduction

    Cafe24 API

    cafe24のショップAPIは、cafe24のショップと連動してサービスを提供するアプリストアパートナー、サードパーティソリューション提供者などに提供するAPIです。

    cafe24のAPIはRESTfulなアーキテクチャーで、OAuth2.0基盤の認証システムと標準HTTP Request Method、リソースの予測ができるエンドポイントURL、HTTPコード基盤のエラーメッセージを提供します。

    API Diagram

    リソース間の関係を表したダイアグラムを通して、Cafe24 APIの全体的な構造を確認することができます。

    Request/Response Format

    • API要求と応答はJSON Formatに対応します。

    • 個人情報保護のため、cafe24のAPIはHTTPSプロトコルのみ対応します。

    • Dates属性は ISO_8601 Formatで提供します。 : YYYY-MM-DDTHH:MM:SS+09:00

    要求例題(検索)
    要求例題(登録/修正)
    正常応答例題 
    {
  "resource": {
      "key": "value",
      "key": "value"
   }
}
    エラー応答例題 
    {
  "error": {
      "code": "error code",
      "message": "error message",
      "more_info": {
      }
  }
}

    Method

    リソース別にCreate、Read、Update、Deleteを提供し、標準HTTP Methodを使ってAPIを使用することができます。

    • POST : リソースを生成(Create)します。

    • GET : リソースの情報を検索(Read)します。

    • PUT : リソースを修正(Update)します。

    • DELETE : リソースを削除(Delete)します。

    Front API Intro

    Front APIは公開されている情報(商品表示情報)またはショップの顧客が本人の情報を検索したり投稿を作成したりする場合に適合しています。Front APIはAdmin APIに比べて一部の情報は制限されています。

    使用例 
    https://{mallid}.cafe24api.com/api/v2/sampleapi

    API Status Code

    Code 発生事例 エラーの解決方法
    200 GET成功、PUT成功、DELETE成功時
    201 POST成功時
    207 多重要求登録時、ステータスが客体別に異なる場合 エラーの状況を客体別に確認し、状況によって対応します。
    400 サーバーが要求を理解できない
    1) Content-Typeの指定が間違っている
    2) application/typeがjsonではない     		要求時に「Content-Type」がapplication/jsonになっているか確認します。
    400 要求API URLにハングルまたは記号をエンコードせずにそのまま使った場合 要求API URLにハングルまたは記号をURLエンコードしたか確認します。
    401 1) Access Token がない状況で呼び出した場合
    2) Access Tokenが有効ではない場合
    3) Access Tokenが満了した場合
    4) 不明なクライアントの場合    		 有効な手続きを踏んで発行されたAccess Tokenを使っているか確認します。
    401 Front APIの使用時にclient_idを入力していない場合 有効なクライアントIDを使っているか確認します。
    403 1) Access Tokenはあるが、Scopeに対する権限がない
    2) FrontAPIで見る権限がない場合    		 APIを呼び出す権限があるか、APIのScopeまたはショップの設定を確認します。
    403 httpsプロトコルではない場合 API要求時にhttpsで要求したか確認します。
    403 新バージョンの商品管理を使うショップではない場合 新バージョンの商品管理にショップを更新しないと使用できません。
    403 (Admin API呼び出し時)ショップでそのアプリが削除された場合 ショップにアプリがインストールされているか確認し、アプリを再インストールします。
    403 (Front API呼び出し時)ショップでそのアプリが削除された場合 ショップにアプリがインストールされているか確認し、アプリを再インストールします。
    404 1) API URLを間違って呼び出した場合
    2) リソースが見つからない場合
    3) {#id}がない場合    		 エンドポイントURLにエラーがないか、API文書を参考に確認します。
    409 同じリソースで同じ内容を更新する場合 編集するデータをリクエストしてください。
    422 検索/処理を要求した時、値が決まっているスペックと違う場合
    1) 必須パラメーター抜け
    2) 決まっているスペックと違う場合    		 API文書を参考に必須パラメーターが入力されていないか、有効でない値が入力されているか確認します。
    429 クライアントのAPI要求がBucketを超過した場合 API最大許容要求件数を超過しないようにしばらくしてからもう一度要求します。
    500 内部サーバーエラー、不明なエラー 一時的にエラーが発生しました。しばらくしてからもう一度お試しください。
    503 現在のサーバーがダウンした場合 開発者センターにお問い合わせください。
    503 サーバーがダウンした場合。APIが使用できない 開発者センターにお問い合わせください。
    504 要求時間を超過した場合(Timeout) 一時的にエラーが発生し、応答が遅れています。しばらくしてからもう一度お試しください。

    How to use GET API

    cafe24のAPIはデータを検索する多様な方法を提供しています。

    次はAPIの検索時に多様なパラメーターを使って多様な方法でデータを呼び出す方法を説明しています。

    1. 検索条件の追加

    検索を行う際、エンドポイントにパラメーターを追加すると検索条件を追加することができます。

    複数の条件に一致する結果を見つけたい場合、「&」を使用して検索条件を追加することができます。

    APIで対応している場合、タイムゾーンを使用して日付･時間の検索も可能です。

    検索条件の追加 
    例) 特定のブランドの商品の中で、商品の販売価格が1,000円以上の商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?brand_code=B000000A&price_min=1000

例) 商品登録日の範囲を指定して商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?created_start_date=2018-01-03&created_end_date=2018-02-03

例) 商品修正日の範囲を指定して商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?updated_start_date=2018-01-03T14:01:26+09:00&updated_end_date=2018-02-03T14:01:26+09:00

    2. カンマ(，)を使用した複数の値の検索

    APIで対応している場合、カンマ(，)を使用して複数の値を同時に検索することができます。 (ただし、入力する項目の数は100件以下に調整してください。)

    カンマ(，)で追加した検索条件はOR条件となり、条件を満たすすべての値が検索されます。

    カンマ(，)を使用した複数の値の検索 
    例) 特定の商品番号を指定して商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13

例) 特定の商品番号と商品コードを指定して商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13&product_code=P000000X,P000000W

    3. 越境ECショップ情報の検索

    特定の越境ECショップ番号を明示することで、該当するショップの情報を検索することができます｡

    越境ECショップ番号を明示しない場合は基本ショップの情報が検索されます。

    越境ECショップ情報の検索 
    例) 特定の越境ECショップの商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?shop_no=2

    4. 詳細検索と単独(1件)検索

    リソースのIDを明示することで詳細検索を行うことができます。

    詳細検索では1件のリソースのみを対象に検索を行うことが可能ですが、リスト検索より多くの項目が返されます。

    詳細検索と単独(1件)検索 
    例) 特定の商品番号を指定して商品の詳細検索を行う場合
GET https://{mallid}.cafe24api.com/api/v2/admin/products/128


例) 特定の商品番号を指定して商品の単独(1件)検索を行う場合
GET https://{mallid}.cafe24api.com/api/v2/admin/products?product_no=128

    5. Pagination

    検索結果が多い場合、指定された「limit」のデフォルト値に基づいて結果が返されます。

    「limit」パラメーターを利用して検索件数を増やすことが可能ですが、値が各APIに定義されている上限(最大値)を超えることはできません。

    「limit」を利用する際の最大値ですべてのデータを検索できない場合、「offset」パラメーターで問題を解決することができます。

    Pagination 
    例) 100点の商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/admin/products?limit=100


例) 201番目から300番目までの商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/admin/products?limit=100&offset=200

    6. 特定項目の検索

    「fields」パラメーターを利用すると、特定の項目のみを検索することができます

    特定項目の検索 
    例) 「商品名」と「商品番号」項目のみを検索する場合
GET https://{mallid}.cafe24api.com/api/v2/admin/products?fields=product_name,product_no

    7. サブリソースの検索

    APIで対応している場合、「embed」パラメーターを利用することでサブリソースのデータを一緒に検索することができます。

    サブリソースの検索 
    例) 商品を検索する際において「品目」と「在庫」のデータを一緒に検索する場合
GET https://{mallid}.cafe24api.com/api/v2/admin/products/570?embed=variants,inventories

    API Limit

    cafe24のAPIは「Leaky Bucket」アルゴリズムで動きます。Leaky Bucketアルゴリズムは性能を高めるために非正常的に多いAPI要求のみ制限し、日常的なAPI要求は特に制限なく使えます。

    cafe24のAPIはAPI要求をBucketに蓄積しておきます。Bucketはショップ当たり「呼び出し件数制限」を超過するとAPI呼び出しが制限されます。Bucketは1秒に2回ずつ減少し、減少した分だけ再度API呼び出しができます。

    • アプリが1秒に2回ずつAPIを呼び出す場合は特に制限なくAPI呼び出しを使い続けることができます。

    • 瞬間的に1秒以内に「呼び出し件数制限」以上のコールが発生する場合は、429エラー(Too Many Request)を返還します。

    • Bucket限度内の呼び出しであっても、該当のショップにて同一IPによる1秒あたり10回以上の呼び出しが発生した場合、異常な呼び出しとみなされることがあります。

    Headerに「X-Api-Call-Limit」を確認すると429 エラーを避けることができます。ショップのAPI呼び出し件数とBucketの余裕分を確認することができます。

    X-Api-Call-Limit : 1/40

    Versioning

    Version 2024-03-01 (latest) 以前のバージョンと互換性のない変更事項に対して、日付形式でバージョンを提供します。

    custom headers "X-Cafe24-Api-Version"を利用して希望のバージョンを指定することができ、バージョンを指定せずAPIにリクエストする場合は、アプリのバージョンで動作します。

    アプリのバージョンは、以下の方法で確認及び変更することができます。

    • 管理コンソールにログイン > Apps > アプリ管理 > 開発関連情報 > 認証情報のバージョン管理

    バージョンの満了期間は、最新バージョンがリリースされた時点から最大１年となります。

    該当のバージョンの満了後は、満了日の時点でリリース日が最も古いバージョンで動作します。

    例示コード(要求)

    Product

    Categories products

    「Categories products」は、あるカテゴリに属する商品の表示順、固定機能の使用有無、表示エリアなどを照会/変更できるリレーショナル(関係)リソースです。

    Endpoints 
    GET /api/v2/categories/{category_no}/products
GET /api/v2/categories/{category_no}/products/count

    Categories products properties

    Attribute Description
    shop_no

    ショップ番号
    product_no

    商品番号

    商品固有の一連番号。ショップ内で商品番号は重複しない。
    product_name

    商品名
    manufacturer_name

    メーカー
    origin_place_value

    原産国
    retail_price

    商品の定価
    price

    販売価格
    interest_free_period

    分割払い(手数料無料)期間
    eng_product_name

    商品名(英語)
    custom_product_code

    独自商品コード
    point_amount

    ポイント
    brand_name

    ブランド名
    model_name

    モデル名
    price_excluding_tax

    商品販売価格
    tax

    税額
    product_code

    商品コード
    simple_description

    商品簡略説明
    summary_description

    商品要約説明
    supplier_name

    供給会社名
    made_date

    製造日
    review_count

    商品レビュー数
    expiration_date

    有効期間
    coupon_discounted_price

    クーポン適用価格
    trend_name

    トレンド名
    shipping_scope

    配送情報
    shipping_fee_type

    送料タイプ

    T:送料無料
    R:固定送料を使用
    M:購入金額によって課金
    D:購入金額別送料を使用
    W:商品の重量別送料を使用
    C:商品の数量別送料を使用
    N:商品の数量に比例して送料を課金
    shipping_rates

    範囲別送料
    shipping_fee

    送料
    discount_price

    割引販売価格
    optimum_discount_price

    割引適用価格
    shipping_method

    配送方法
    promotion_period

    割引期間
    color

    カラー
    translated_additional_description

    商品追加説明の翻訳情報
    stock_quantity

    在庫数量
    question_count

    商品に関する問い合わせの数
    product_article_count

    自由掲示板

    Retrieve a list of products by category

    GET /api/v2/categories/{category_no}/products

    GET

    特定のカテゴリーに割り当てられた商品をリストで照会することができます。
    商品は同時に複数のカテゴリーに割り当てることができます。
    商品番号、表示順、販売可否などを照会することができます。

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    mobile

    モバイル設定値で照会するか否か

    T:使用する
    F:使用しない

    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    display_group
    Required

    Min : [1]~Max : [3]

    商品カテゴリの詳細

    1: 一般商品
    2: おすすめ商品
    3: 新着商品

    limit

    Min : [1]~Max : [200]

    検索結果の最大件数

    DEFAULT 100

    offset

    Max : [8000]

    検索結果の開始位置

    DEFAULT 0

    Retrieve a count of products by category

    GET /api/v2/categories/{category_no}/products/count

    GET

    特定のカテゴリに割り当てられた商品の数を照会することができます。

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    display_group
    Required

    Min : [1]~Max : [3]

    商品カテゴリの詳細

    1: 一般商品
    2: おすすめ商品
    3: 新着商品

    Retrieve a count of products by category
    Request Copy
    Response Copy

    Mains products

    「Mains products」は、商品のメイン表示順に関するメインカテゴリのリレーショナル(関係)リソースです。

    Endpoints 
    GET /api/v2/mains/{display_group}/products

    Mains products properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    product_no

    商品番号
    product_name

    商品名
    manufacturer_name

    メーカー
    origin_place_value

    原産国
    retail_price

    商品の定価
    price

    販売価格
    interest_free_period

    分割払い(手数料無料)期間
    eng_product_name

    商品名(英語)
    custom_product_code

    独自商品コード
    point_amount

    ポイント
    brand_name

    ブランド名
    model_name

    モデル名
    price_excluding_tax

    商品販売価格
    tax

    税額
    product_code

    商品コード
    simple_description

    商品簡略説明
    summary_description

    商品要約説明
    supplier_name

    供給会社名
    made_date

    製造日
    review_count

    商品レビュー数
    expiration_date

    有効期間
    coupon_discounted_price

    クーポン適用価格
    trend_name

    トレンド名
    shipping_scope

    配送情報
    shipping_fee_type

    送料タイプ

    T:送料無料
    R:固定送料を使用
    M:購入金額によって課金
    D:購入金額別送料を使用
    W:商品の重量別送料を使用
    C:商品の数量別送料を使用
    N:商品の数量に比例して送料を課金
    shipping_rates

    範囲別送料
    shipping_fee

    送料
    discount_price

    割引販売価格
    optimum_discount_price

    割引適用価格
    shipping_method

    配送方法
    promotion_period

    割引期間
    color

    カラー
    translated_additional_description

    商品追加説明の翻訳情報
    stock_quantity

    在庫数量
    question_count

    商品に関する問い合わせの数
    product_article_count

    自由掲示板

    Retrieve a list of products in main category

    GET /api/v2/mains/{display_group}/products

    GET

    特定のメイン分類に割り当てられた商品をリストで照会することができます。
    商品番号、商品名、固定可否などを照会することができます。
    商品は同時に複数のメイン分類に割り当てられます。

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    mobile

    モバイル設定値で照会するか否か

    T:使用する
    F:使用しない

    shop_no

    ショップ番号

    DEFAULT 1

    display_group
    Required

    メインカテゴリ番号

    limit

    Min : [1]~Max : [200]

    検索結果の最大件数

    DEFAULT 100

    offset

    Max : [8000]

    検索結果の開始位置

    DEFAULT 0

    Products



    商品(Products)はショップで販売されるものやサービスを意味します。商品は多様な色やサイズのオプションによって品目に分けられます。

    商品は下記のようなResourceを下位Resourceとして持っています。
    ● 品目(Variants)
    ● 商品メモ(Memos)
    ● SEO(SEO)
    ● 商品照会数(Hits)

    Endpoints 
    GET /api/v2/products
GET /api/v2/products/count
GET /api/v2/products/{product_no}

    Products properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    product_no

    商品番号

    商品固有の一連番号。ショップ内で商品番号は重複しない。
    product_code

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    商品コード

    システムにより商品に付与されたコード。ショップ内で商品コードは重複しない。
    custom_product_code

    Max Length : [40]

    独自商品コード

    ユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。
    product_name

    Max Length : [250]

    商品名

    商品の名前。商品名は商品を区分する一番基礎的な情報で、検索情報になる。HTMLを使って入力できる。
    eng_product_name

    Max Length : [250]

    商品名(英語)

    商品の英語名。海外配送などに使用可能
    model_name

    Max Length : [100]

    モデル名

    商品のモデル名
    price_excluding_tax

    商品価格(税別)
    price

    商品販売価格

    商品の販売価格。クーポン及び特典を適用する前の価格
    商品登録時にはマルチショップに同じ価格で登録するが、ショップ別に異なる価格を入力したい場合は商品修正を通じて異なる価格を入力することができる。
    ※ 販売価格 = [ 原価 + (原価 * 売上総利益率) + 追加金額 ]
    retail_price

    商品の定価

    市場で販売される消費者価格。ショップの価格をアピールする比較の目的で使う。
    display

    表示ステータス

    商品をショップに表示するかどうかを設定。商品をショップに表示すると設定した商品カテゴリとトップページに表示される。商品がショップに表示されないとショップの画面に表示されないためアクセスができず、商品を購入することもできない。

    T:表示する
    F:表示しない
    selling

    販売ステータス

    商品をショップで販売するかどうかを設定。商品が表示されている状況で販売を中止する場合、ショップに商品は表示されるが「在庫切れ」と表示されるため、商品を購入することができない。商品のステータスが「表示しない」の場合、ステータスが「販売」であっても商品にアクセスできないため、購入できない。

    T:販売する
    F:販売しない
    product_used_month

    Max : [2147483647]

    中古品の使用月数
    summary_description

    Max Length : [255]

    商品要約説明

    商品に対する要約情報。商品表示画面に表示できる説明。HTMLを使って入力できる。
    [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定']で表示されるように設定可能
    product_tag

    商品検索キーワード

    検索または分類のために商品に入力する検索キーワード情報(ハッシュタグ)
    tax_calculation

    税金の計算タイプ

    A：自動計算
    M：手動計算
    price_content

    Max Length : [20]

    販売価格の代替メッセージ

    商品の価格の代わりに表示されるメッセージ。在庫切れや商品が一時的に販売できない場合に使用
    buy_limit_by_product

    購入制限の個別設定の有無

    T: 使用する
    F: 使用しない
    buy_limit_type

    購入制限

    商品を購入することができる会員情報の表示

    N : 会員のみ購入可能 + 購入ボタン非表示
    M : 会員のみ購入可能 + 購入ボタン表示
    F : 購入制限なし
    O : 指定された会員のみ購入可能 + 購入ボタン非表示
    D : 指定された会員のみ購入可能 + 購入ボタン表示
    buy_group_list

    購入できる会員ランク
    buy_member_id_list

    購入可能な会員ID
    repurchase_restriction

    再購入制限

    T : 再購入不可
    F : 制限しない
    single_purchase_restriction

    単独購入制限

    T : 単独購入不可
    F : 制限しない
    buy_unit_type

    購入単位のタイプ

    商品の購入単位を1個以上に設定した場合、その購入単位を品目単位にするか、商品単位にするかの設定

    P:商品基準
    O:品目基準
    buy_unit

    購入単位

    購入できる最小限の単位表示
    例)購入注文単位が3個の場合、3個、6個、9個単位で購入可能
    order_quantity_limit_type

    注文数量の制限基準

    商品の注文数量を制限する場合、制限基準を品目単位にするか、商品単位にするかの設定

    P:商品基準
    O:品目基準
    minimum_quantity

    Max : [2147483647]

    最小注文数量

    注文可能な最小限の注文数量。注文数量未満は購入できない。
    maximum_quantity

    Max : [2147483647]

    最大注文数量

    注文可能な最大限の注文数量。注文数量を超過して購入することはできない。

    最大受注数量が「制限なし」の場合は「0」と表示されます。
    points_by_product

    ポイントの個別設定を使用するかどうか

    F : 基本設定使用
    T : 個別設定
    points_setting_by_payment

    決済方法別にポイントを設定するかどうか

    B : 基本ポイント設定を使用
    C : 決済方法によるポイント
    points_amount

    ポイント設定情報
    adult_certification

    年齢認証

    年齢認証（確認）が必要な商品かどうかの有無。年齢認証が必要な商品を購入するためには本人認証（確認）をしなければならない。

    T:使用する
    F:使用しない
    detail_image

    詳細画像

    商品詳細画面に表示される商品画像
    list_image

    一覧画像

    商品カテゴリ画面、トップページ、商品検索画面に表示される商品の一覧画像
    tiny_image

    縮小一覧画像

    最近チェックした商品領域に表示される商品の一覧画像
    small_image

    縮小画像

    商品詳細画面の下部に表示される商品の一覧画像
    use_naverpay

    Naver Payの使用有無

    T:使用する
    F:使用しない
    naverpay_type

    Naver Pay販売タイプ

    C : Naver Pay + ショップ 同時販売 商品
    O : Naver Pay 専用商品
    manufacturer_code

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    メーカーコード

    メーカーを登録すると自動生成されるコードで、商品に特定メーカーを指定する時に使用

    入力しない場合は独自製作(M0000000)使用
    trend_code

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    トレンドコード

    トレンドを登録すると自動生成されるコードで、商品に特定トレンドを指定する時に使う。

    入力しない場合は基本トレンド(T0000000)使用
    brand_code

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    ブランドコード

    ブランドを登録すると自動生成されるコードで、商品に特定ブランドを指定する場合に使う。

    入力しない場合は独自ブランド(B0000000)使用
    made_date

    製造日

    商品を製造した製造日
    expiration_date

    Array Max : [2]

    有効期間

    商品を正常に使える期間。商品券やチケットのような無形商品、食品や化粧品のような有形商品の有効期間を表示

    主に商品券やチケットのような無形商品に使われ、その無形商品の有効期間を表示。
    origin_classification

    原産国 国内/国外/その他

    F:国内
    T:海外
    E:その他
    origin_place_no

    原産国番号

    List all Origin APIで原産国を検索して原産国番号を入力
    origin_classificationがF(国内)の場合、海外の有無(foreign)が「F」の原産国のみ入力可能
    origin_classificationがT(海外)の場合、海外の有無(foreign)が「T」の原産国のみ入力可能
    origin_place_value

    Max Length : [30]

    原産国のその他の情報

    原産国が「その他(1800)」の場合、原産国として入力可能な情報
    made_in_code

    国名(原産国)コード
    icon_show_period

    アイコンの表示期間

    商品に設定したアイコンが表示される期間
    icon

    Array Max : [5]

    アイコン

    商品に表示されるアイコン。商品販売をアピールするための目的で使用可能
    product_material

    商品素材

    商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。
    list_icon

    おすすめ / 在庫切れ / 新着商品アイコン表示の設定

    おすすめ、在庫切れ、新着商品アイコンをリストに表示するかどうかを設定

    ※ 在庫切れアイコン

    ● 商品が在庫切れ状態であることを知らせるアイコン
    ● 在庫管理及び在庫切れ機能を使う商品を対象に在庫がない場合に表示

    ※ おすすめ、新着商品アイコン

    ● 商品カテゴリやトップページのおすすめ商品、新着商品エリアに表示されている商品の場合、設定によって関連アイコンを表示する。

    ※ アイコン表示の設定位置 : [ショップ設定 > 商品設定 > '商品基本設定 > 商品管理の設定 > 商品アイコンの設定']
    approve_status

    承認申込結果

    N:承認申込(新規商品)
    E:承認申込(商品修正)
    C:承認完了
    R:承認拒否
    I:検収進行中
    Empty Value:申込履歴がない
    sold_out

    在庫切れ状況

    T:在庫切れ
    F:在庫切れではない
    discountprice

    商品の割引価格リソース
    decorationimages

    デコ画像リソース
    benefits

    特典リソース
    options

    商品オプションリソース


    Embedパラメーターを使って照会することができる。
    variants

    品目リソース


    Embedパラメーターを使って照会することができる。
    clearance_category_code

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    海外通関コード

    clearance_category_code

    additionalimages

    追加の画像リソース
    exposure_limit_type

    商品表示制限の範囲

    A：すべての顧客に表示
    M：会員にのみ表示
    exposure_group_list

    商品表示対象の会員ランク
    set_product_type

    セット商品のタイプ

    C:一般セット
    S:分離型セット
    use_kakaopay

    カカオページを使用するかどうか

    T:使用する
    F:使用しない
    shipping_fee_type

    送料タイプ

    (個別送料を利用する場合)商品の送料タイプ

    T:送料無料
    R:固定送料を使用
    M:購入金額によって課金
    D:購入金額別送料を使用
    W:商品の重量別送料を使用
    C:商品の数量別送料を使用
    N:商品の数量に比例して送料を課金
    main

    メイン表示

    商品を「おすすめ商品」、「新着商品」のようなメイン表示に表示する場合、メイン表示番号を表示する。
    channeldiscountprices

    商品の割引価格リソース
    market_sync

    ECモール連携を使用するかどうか

    T:使用する
    F:使用しない
    memos

    メモリソース


    Embedパラメーターを使って照会することができる。
    hits

    商品閲覧数リソース


    Embedパラメーターを使って照会することができる。
    seo

    商品Seo リソース


    Embedパラメーターを使って照会することができる。
    category

    カテゴリ番号

    商品が表示されている商品カテゴリ
    project_no

    キャンペーン番号
    description

    商品詳細説明

    商品に対するより詳細な情報が含まれている説明。HTMLを使って入力できる。
    mobile_description

    モバイル商品詳細説明

    入力するとモバイルショップで商品詳細説明の代わりにモバイルショップ商品詳細説明が表示される。
    separated_mobile_description

    モバイル用登録

    T : 直接登録
    F : 商品説明と同一
    payment_info

    商品決済ガイド

    商品の決済方法に対する案内文。HTMLを使って入力できる。
    shipping_info

    商品配送ガイド

    商品の配送方法に対するガイド。HTMLを使って入力できる。
    exchange_info

    交換・返品ガイド

    商品の交換・返品方法に対する説明。HTMLを使って入力できる。
    service_info

    サービスに関するお問い合わせ/ガイド

    製品の事後顧客サービス方法に関するガイド。HTMLを使って入力できる。
    product_tax_type_text

    消費税表示メッセージ

    [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定 > 追加設定'] の販売価格の消費税表示メッセージで設定したメッセージ表示
    simple_description

    商品簡略説明

    商品に対する簡単な情報。商品表示画面に表示できる説明。HTMLを使って入力できる。
    [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定']で表示されるように設定可能
    tags

    商品タグリソース


    Embedパラメーターを使って照会することができる。
    has_option

    オプション使用の設定

    商品にオプションが付いているかの有無。オプションのある商品はサイズや色など多様な選択肢を提供する。

    T:オプションを使用する
    F:オプションを使用しない
    option_type

    オプション構成方式

    オプションを使う場合、オプションのタイプを表示

    ● 組合型 : オプション名を基準にオプション値を組み合わせることができる。
    ● 商品連動型 : オプション表示方式は組合型と似ているが、必須オプションと選択オプションを選択することができる。オプションの組合せを制限なく生成することができる。
    ● 独立選択型 : 独立的な複数の条件をそれぞれ選択できるオプションで、オプション値が組み合わせられずそれぞれの品目として生成される。

    C:組み合わせ一体選択型
    S:組み合わせ分離選択型
    E:商品連携型
    F:独立選択型
    shipping_calculation

    配送の計算タイプ

    A：自動計算
    M：手動計算
    shipping_method

    配送方法

    (個別送料を使う場合)配送手段及び方法

    01:宅配
    02:速達郵便
    03:一般郵便
    04:直接配送
    05:クイック配送
    06:その他
    07:貨物配送
    08:店舗受取
    09:配送不要
    prepaid_shipping_fee

    送料前払いの設定

    shipping_calculationがA（自動計算）の場合はnullに返却。

    C:着払い
    P:前払い
    B:前払い/着払い
    shipping_period

    配送期間

    (個別送料を使う場合)商品の配送時に平均的にかかる配送期間
    shipping_scope

    配送情報

    国内配送しかできない商品か海外配送も可能な商品かを表示。[ショップ設定 > 配送設定 > '配送基本設定 > 送料の設定 > 個別送料設定']で商品別の個別送料設定が「使用しない」の場合は設定できない。

    A:国内配送
    C:海外配送
    B:国内/海外配送
    shipping_area

    Max Length : [255]

    配送地域

    (個別送料を使う場合)商品の配送ができる地域
    shipping_rates

    範囲別送料

    個別送料を使う場合、商品の個別送料

    shipping_fee_typeがR、Nの場合、配列内でshipping_feeを定義して送料を設定することができる。

    shipping_fee_typeがM、D、W、Cの場合、配列内で次のように定義して送料区間を設定することができる。
    shipping_rates_min:送料区間の開始基準
    shipping_rates_max:送料区間の終了基準
    shipping_fee:送料
    origin_place_code

    原産国コード

    商品の原産国コード
    additional_information

    追加項目

    [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定']で追加した追加項目

    基本的な商品情報以外に追加で表示する項目がある場合に追加して使う。
    relational_product

    関連商品

    似ている商品または代替可能な商品。関連商品を登録するとその商品の詳細ページの下部に表示される。
    select_one_by_option

    オプション別に１個ずつ選択(独立型オプション)

    独立型オプションを使う場合、一つのオプションを重複して選択することができず、一つずつしか選択できない。

    T:使用する
    F:使用しない

    Retrieve a list of products

    GET /api/v2/products

    GET

    ショッピングモールに作成されている商品を一覧で照会することができます。
    商品コード、商品名、販売価格などを照会することができます。
    商品が5,000個を超える場合はoffsetでは照会できませんので、since_product_noパラメータを活用していただければ照会することができます。

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    channeldiscountprices
    embed

    商品の割引価格リソース

    discountprice
    embed

    商品の割引価格リソース

    decorationimages
    embed

    デコ画像リソース

    benefits
    embed

    特典リソース

    options
    embed

    商品オプションリソース

    variants
    embed

    品目リソース

    商品1点あたりの品目情報を100件まで照会可能
    Embedパラメーターを使って照会することができる。

    additionalimages
    embed

    追加の画像リソース

    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    product_no

    商品番号

    検索したい商品の番号

    ,(コンマ)で複数の件を検索することができる。

    display

    表示ステータス

    表示または非表示商品の検索

    selling

    販売ステータス

    「販売中」または「販売しない」状態の商品検索

    product_name

    商品名

    検索キーワードが商品名に含まれている商品検索(大文字・小文字を区別しない)

    ,(コンマ)で複数の件を検索することができる。

    product_code

    商品コード

    検索キーワードが商品コードに含まれている商品検索(大文字・小文字を区別する)

    ,(コンマ)で複数の件を検索することができる。

    brand_code

    ブランドコード

    ブランドコードが一致する商品検索

    ,(コンマ)で複数の件を検索することができる。

    manufacturer_code

    メーカーコード

    メーカーコードが一致する商品検索

    ,(コンマ)で複数の件を検索することができる。

    supplier_code

    供給会社のコード

    供給会社コードが一致する商品検索

    ,(コンマ)で複数の件を検索することができる。

    trend_code

    トレンドコード

    トレンドコードが一致する商品検索

    ,(コンマ)で複数の件を検索することができる。

    product_tag

    商品検索キーワード

    検索キーワードが商品検索キーワードまたはタグに含まれている商品検索(大文字・小文字を区別しない)

    ,(コンマ)で複数の件を検索することができる。

    custom_product_code

    独自商品コード

    検索キーワードが独自商品コードに含まれている商品検索(大文字・小文字を区別する)

    ,(コンマ)で複数の件を検索することができる。

    custom_variant_code

    独自品目コード

    ,(コンマ)で複数の件を検索することができる。

    price_min

    商品販売価格の検索最小値

    販売価格が最小値以上の商品検索

    price_max

    商品販売価格の検索最大値

    販売価格が最大値以下の商品検索

    retail_price_min

    Min : [0]
    Max : [2147483647]

    商品の定価の検索最小値

    消費者価格が最小値以上の商品検索

    retail_price_max

    Min : [0]
    Max : [2147483647]

    商品の定価の検索最大値

    消費者価格が最大値以下の商品検索

    supply_price_min

    商品仕入れ価格の検索最小値

    原価が最小値以下の商品検索

    supply_price_max

    商品仕入れ価格の検索最大値

    原価が最大値以上の商品検索

    created_start_date

    商品登録日の検索開始日

    商品登録日が該当日以後である商品検索

    登録日検索の終了日と必ずペアで使用すること。

    検索開始日と終了日が同じ場合は該当日でのみ検索する。

    created_end_date

    商品登録日の検索終了日

    商品登録日が該当日以前である商品検索

    登録日検索の開始日と必ずペアで使用すること。

    検索開始日と終了日が同じ場合は該当日でのみ検索する。

    updated_start_date

    商品修正日の検索開始日

    商品修正日が該当日以後である商品検索

    修正日検索の終了日と必ずペアで使用すること。

    検索開始日と終了日が同じ場合は該当日でのみ検索する。

    updated_end_date

    商品修正日の検索終了日

    商品修正日が該当日以前である商品検索

    修正日検索の開始日と必ずペアで使用すること。

    検索開始日と終了日が同じ場合は該当日でのみ検索する。

    category

    カテゴリ番号

    特定のカテゴリに表示されている商品検索

    eng_product_name

    商品名(英語)

    検索キーワードが英語商品名に含まれている商品検索(大文字・小文字を区別しない)

    ,(コンマ)で複数の件を検索することができる。

    supply_product_name

    供給会社の商品名

    検索キーワードが供給会社の商品名に含まれている商品検索(大文字・小文字を区別しない)

    ,(コンマ)で複数の件を検索することができる。

    internal_product_name

    管理用商品名

    ,(コンマ)で複数の件を検索することができる。

    model_name

    モデル名

    検索キーワードがモデル名に含まれている商品検索(大文字・小文字を区別しない)

    ,(コンマ)で複数の件を検索することができる。

    product_condition

    商品ステータス

    特定商品のステータスを検索

    ,(コンマ)で複数の件を検索することができる。

    origin_place_value

    原産国情報

    原産国が「その他(1800)」の場合、原産国として入力可能な情報

    ,(コンマ)で複数の件を検索することができる。

    stock_quantity_max

    在庫数量の検索最大値

    在庫が最大値以下の商品検索

    品目が複数の商品はその条件に当たる品目が一つでもあれば検索する。

    stock_quantity_min

    在庫数量の検索最小値

    在庫が最小値以上の商品検索

    品目が複数の商品はその条件に当たる品目が一つでもあれば検索する。

    stock_safety_max

    安全在庫数量の検索最大値

    stock_safety_min

    安全在庫数量の検索最小値

    product_weight

    商品重量

    該当する重量の商品検索

    ,(コンマ)で複数の件を検索することができる。

    classification_code

    独自カテゴリ

    ,(コンマ)で複数の件を検索することができる。

    use_inventory

    在庫使用の設定

    該当する商品品目の在庫使用の有無

    T:使用する
    F:使用しない

    category_unapplied

    未適用カテゴリを検索

    カテゴリが登録されていない商品を検索する。

    T:未適用カテゴリを検索

    include_sub_category

    下位カテゴリを含めて検索

    下位カテゴリに登録されている商品を含めて検索する。

    T:含む

    additional_information_key

    追加項目の検索条件キー

    追加項目を検索するためのキー。検索のためにはkeyとvalue両方とも必要

    additional_information_value

    追加項目の検索条件値

    追加項目を検索するためのキーの値。検索のためにはkeyとvalue両方とも必要

    approve_status

    承認ステータスの検索

    N:承認申込(新規商品)のステータス値
    E:承認申込(商品修正)のステータス値
    C:承認完了のステータス値
    R:承認拒否のステータス値
    I:検収進行中のステータス値

    since_product_no

    Min : [0]
    Max : [2147483647]

    該当する商品番号以降の番号から検索

    特定の商品番号より数字が大きい商品番号を検索
    この検索条件を使用するとoffsetと関係なく、すべての商品を検索することができる。

    ※この検索条件を使用すると、以下ののパラメータは使用できない。

    product_no
    sort
    order
    offset

    product_bundle

    セット商品の有無

    T:使用する
    F:使用しない

    option_type

    オプション構成方式

    ,(コンマ)で複数の件を検索することができる。

    C:組み合わせ一体選択型
    S:組み合わせ分離選択型
    E:商品連携型
    F:独立選択型

    market_sync

    ECモール連携を使用するかどうか

    T:使用する
    F:使用しない

    sort

    並べ替え順序の値

    created_date:登録日
    updated_date:修正日
    product_name:商品名

    order

    並べ替え順序

    asc:並べ替え(昇順)
    desc:並べ替え(降順)

    offset

    Max : [5000]

    検索結果の開始位置

    検索結果の開始位置

    DEFAULT 0

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    Retrieve a count of products

    GET /api/v2/products/count

    GET

    ショッピングモールに登録されている商品の総数を照会することができます。

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    product_no

    商品番号

    検索したい商品の番号

    ,(コンマ)で複数の件を検索することができる。

    display

    表示ステータス

    表示または非表示商品の検索

    selling

    販売ステータス

    「販売中」または「販売しない」状態の商品検索

    product_name

    商品名

    検索キーワードが商品名に含まれている商品検索(大文字・小文字を区別しない)

    ,(コンマ)で複数の件を検索することができる。

    product_code

    商品コード

    商品コード

    ,(コンマ)で複数の件を検索することができる。

    brand_code

    ブランドコード

    ブランドコードが一致する商品検索

    ,(コンマ)で複数の件を検索することができる。

    manufacturer_code

    メーカーコード

    メーカーコードが一致する商品検索

    ,(コンマ)で複数の件を検索することができる。

    supplier_code

    供給会社のコード

    供給会社コードが一致する商品検索

    ,(コンマ)で複数の件を検索することができる。

    trend_code

    トレンドコード

    トレンドコードが一致する商品検索

    ,(コンマ)で複数の件を検索することができる。

    product_tag

    商品検索キーワード

    検索キーワードが商品検索キーワードまたはタグに含まれている商品検索(大文字・小文字を区別しない)

    ,(コンマ)で複数の件を検索することができる。

    custom_product_code

    独自商品コード

    検索キーワードが独自商品コードに含まれている商品検索(大文字・小文字を区別する)

    ,(コンマ)で複数の件を検索することができる。

    custom_variant_code

    独自品目コード

    ,(コンマ)で複数の件を検索することができる。

    price_min

    商品販売価格の検索最小値

    販売価格が最小値以上の商品検索

    price_max

    商品販売価格の検索最大値

    販売価格が最大値以下の商品検索

    retail_price_min

    Min : [0]
    Max : [2147483647]

    商品の定価の検索最小値

    消費者価格が最小値以上の商品検索

    retail_price_max

    Min : [0]
    Max : [2147483647]

    商品の定価の検索最大値

    消費者価格が最大値以下の商品検索

    supply_price_min

    商品仕入れ価格の検索最小値

    原価が最小値以下の商品検索

    supply_price_max

    商品仕入れ価格の検索最大値

    原価が最大値以上の商品検索

    created_start_date

    商品登録日の検索開始日

    商品登録日が該当日以後である商品検索

    登録日検索の終了日と必ずペアで使用すること。

    検索開始日と終了日が同じ場合は該当日でのみ検索する。

    created_end_date

    商品登録日の検索終了日

    商品登録日が該当日以前である商品検索

    登録日検索の開始日と必ずペアで使用すること。

    検索開始日と終了日が同じ場合は該当日でのみ検索する。

    updated_start_date

    商品修正日の検索開始日

    商品修正日が該当日以後である商品検索

    修正日検索の終了日と必ずペアで使用すること。

    検索開始日と終了日が同じ場合は該当日でのみ検索する。

    updated_end_date

    商品修正日の検索終了日

    商品修正日が該当日以前である商品検索

    修正日検索の開始日と必ずペアで使用すること。

    検索開始日と終了日が同じ場合は該当日でのみ検索する。

    category

    カテゴリ番号

    特定のカテゴリに表示されている商品検索

    eng_product_name

    商品名(英語)

    検索キーワードが英語商品名に含まれている商品検索(大文字・小文字を区別しない)

    ,(コンマ)で複数の件を検索することができる。

    supply_product_name

    供給会社の商品名

    検索キーワードが供給会社の商品名に含まれている商品検索(大文字・小文字を区別しない)

    ,(コンマ)で複数の件を検索することができる。

    internal_product_name

    管理用商品名

    ,(コンマ)で複数の件を検索することができる。

    model_name

    モデル名

    検索キーワードがモデル名に含まれている商品検索(大文字・小文字を区別しない)

    ,(コンマ)で複数の件を検索することができる。

    product_condition

    商品ステータス

    特定商品のステータスを検索

    ,(コンマ)で複数の件を検索することができる。

    origin_place_value

    原産国情報

    原産国が「その他(1800)」の場合、原産国として入力可能な情報

    ,(コンマ)で複数の件を検索することができる。

    stock_quantity_max

    在庫数量の検索最大値

    在庫が最大値以下の商品検索

    品目が複数の商品はその条件に当たる品目が一つでもあれば検索する。

    stock_quantity_min

    在庫数量の検索最小値

    在庫が最小値以上の商品検索

    品目が複数の商品はその条件に当たる品目が一つでもあれば検索する。

    stock_safety_max

    安全在庫数量の検索最大値

    stock_safety_min

    安全在庫数量の検索最小値

    product_weight

    商品重量

    該当する重量の商品検索

    ,(コンマ)で複数の件を検索することができる。

    classification_code

    独自カテゴリ

    独自カテゴリコードが一致する商品検索

    ,(コンマ)で複数の件を検索することができる。

    use_inventory

    在庫使用の設定

    該当する商品品目の在庫使用の有無

    T:使用する
    F:使用しない

    category_unapplied

    未適用カテゴリを検索

    カテゴリが登録されていない商品を検索する。

    T:未適用カテゴリを検索

    include_sub_category

    下位カテゴリを含めて検索

    下位カテゴリに登録されている商品を含めて検索する。

    T:含む

    additional_information_key

    追加項目の検索条件キー

    追加項目を検索するためのキー。検索のためにはkeyとvalue両方とも必要

    additional_information_value

    追加項目の検索条件値

    追加項目を検索するためのキーの値。検索のためにはkeyとvalue両方とも必要

    approve_status

    承認ステータスの検索

    N:承認申込(新規商品)のステータス値
    E:承認申込(商品修正)のステータス値
    C:承認完了のステータス値
    R:承認拒否のステータス値
    I:検収進行中のステータス値

    since_product_no

    Min : [0]
    Max : [2147483647]

    該当する商品番号以降の番号から検索

    特定の商品番号より数字が大きい商品番号を検索。
    この検索条件を使用するとoffsetと関係なく、すべての商品を検索することができる。

    ※この検索条件を使用すると、以下ののパラメータは使用できない。

    product_no
    sort
    order
    offset

    product_bundle

    セット商品の有無

    T:使用する
    F:使用しない

    option_type

    オプション構成方式

    ,(コンマ)で複数の件を検索することができる。

    C:組み合わせ一体選択型
    S:組み合わせ分離選択型
    E:商品連携型
    F:独立選択型

    market_sync

    ECモール連携を使用するかどうか

    T:使用する
    F:使用しない

    Retrieve a count of products
    Request Copy
    Response Copy

    Retrieve a product resource

    GET /api/v2/products/{product_no}

    GET

    ショッピングモールに作成されている商品を照会することができます。
    商品コード、自社商品コード、商品名、商品販売価格などを照会することができます。

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    検索したい商品の番号

    variants
    embed

    品目リソース


    Embedパラメーターを使って照会することができる。

    memos
    embed

    メモリソース


    Embedパラメーターを使って照会することができる。

    hits
    embed

    商品閲覧数リソース


    Embedパラメーターを使って照会することができる。

    seo
    embed

    商品Seo リソース


    Embedパラメーターを使って照会することができる。

    tags
    embed

    商品タグリソース


    Embedパラメーターを使って照会することができる。

    options
    embed

    商品オプションリソース


    Embedパラメーターを使って照会することができる。

    discountprice
    embed

    商品の割引価格リソース

    decorationimages
    embed

    デコ画像リソース

    benefits
    embed

    特典リソース

    additionalimages
    embed

    追加の画像リソース

    Retrieve a product resource
    Request Copy
    Response Copy

    Products decorationimages

    「Decorationimages」は、ショップに表示中の商品画像の上に追加して商品をより目立たせる機能です。ショップに登録されているデコ画像を照会して商品ごとにデコ画像を指定したり、商品に登録されているデコ画像を照会することができます。 

    デコ画像はサブリソースであるため、「Products」の以下で使用可能です。

    Endpoints 
    GET /api/v2/products/{product_no}/decorationimages

    Products decorationimages properties

    Attribute Description
    shop_no

    ショップ番号
    use_show_date

    表示期間の使用の有無

    T:使用する
    F:使用しない
    show_start_date

    表示期間の開始日
    show_end_date

    表示期間の終了日
    image_list

    デコ画像一覧

    水平位置(image_horizontal_position)
    L : 左
    C : 真ん中
    R : 右

    垂直位置(image_vertical_position)
    T : 上段
    C : 中断
    B : 下段

    Retrieve a list of product decoration images

    GET /api/v2/products/{product_no}/decorationimages

    GET

    特定の商品に登録されている装飾画像をリストで照会します。

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    商品固有の一連番号。ショップ内で商品番号は重複しない。

    Retrieve a list of product decoration images
    Request Copy
    Response Copy

    Products discountprice

    「Discountprice」は、商品の割引価格を表示するリソースです。 「Benefits」が適用された商品の場合、商品の割引価格を照会することができます。

    商品の割引価格はサブリソースであるため、「Products」の以下で使用可能です。 商品リストを照会する際に、Embedパラメータで呼び出して商品の割引価格を同時に照会することができます。

    Endpoints 
    GET /api/v2/products/{product_no}/discountprice

    Products discountprice properties

    Attribute Description
    pc_discount_price

    PC割引価格
    mobile_discount_price

    モバイル割引価格
    app_discount_price

    アプリ割引価格

    Retrieve a product discounted price

    GET /api/v2/products/{product_no}/discountprice

    GET

    商品番号を利用して該当商品の割引価格を照会します。
    PC割引販売価格、モバイル割引販売価格を確認できます。

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    Retrieve a product discounted price
    Request Copy
    Response Copy

    Products hits

    商品照会数(Hits)は商品をショップの顧客がどれほど照会したかを示す指標です。商品照会数を確認することで顧客がどんな商品を一番たくさん照会したかがわかります。
    商品照会数は下位Resourceで、商品(Products)の下位でしか使えません。

    Endpoints 
    GET /api/v2/products/{product_no}/hits/count

    Retrieve a count of product views

    GET /api/v2/products/{product_no}/hits/count

    GET

    商品番号を利用して該当商品の照会数を照会します。

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    システムにより付与された商品の番号。商品番号はショップ内で重複しない。

    Retrieve a count of product views
    Request Copy
    Response Copy

    Products icons

    商品アイコンは商品をアピールするために商品の横に追加する小さい画像です。表示されている商品に割引情報、「在庫わずか」などのメッセージを追加して商品をアピールすることができます。
    商品アイコンは下位Resourceで、商品(Products)の下位でしか使えません。

    Endpoints 
    GET /api/v2/products/{product_no}/icons

    Products icons properties

    Attribute Description
    shop_no

    ショップ番号
    use_show_date

    表示期間の使用の有無

    T:使用する
    F:使用しない
    show_start_date

    表示期間の開始日
    show_end_date

    表示期間の終了日
    image_list

    商品アイコン一覧

    Retrieve a list of product icons

    GET /api/v2/products/{product_no}/icons

    GET

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    Retrieve a list of product icons
    Request Copy
    Response Copy

    Products options

    「Options」は、顧客がカラー・サイズなど商品のオプションの中から好きなものを選択して購入できるようにする機能です。 オプションはカラー、サイズなどの「オプション名(option_name)」とカラーのうち赤、黄のような「オプション値(option_value)」で構成されています。 商品にオプションを登録すると、オプションに基づいて「品目(variants)」が作成されます。 

    オプションはサブリソースであるため、「Products」の以下で使用可能です。

    Endpoints 
    GET /api/v2/products/{product_no}/options

    Products options properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    product_no
    Required

    商品番号

    商品固有の一連番号。ショップ内で商品番号は重複しない。
    has_option

    オプション使用の設定

    T:使用する
    F:使用しない
    option_type

    オプション構成方式

    オプションを使う場合、オプションのタイプを表示

    ● 組合型 : オプション名を基準にオプション値を組み合わせることができる。
    ● 商品連動型 : オプション表示方式は組合型と似ているが、必須オプションと選択オプションを選択することができる。オプションの組合せを制限なく生成することができる。
    ● 独立選択型 : 独立的な複数の条件をそれぞれ選択できるオプションで、オプション値が組み合わせられずそれぞれの品目として生成される。

    T:組み合わせ型
    E:連携型
    F:独立型
    option_list_type

    オプション表示方式

    組合型オプションを使う場合、組合型オプションのタイプを表示

    * 組合一体選択型 : 一つのセレクトボックス(ボタンまたはラジオボタン)にすべてのオプションが組み合わせられて表示される。
    * 組合分離選択型 : オプションをそれぞれのセレクトボックス(ボタンまたはラジオボタン)で選択でき、オプション名を基準にオプション値を組み合わせることができる。

    独立型や商品連動型オプションを使っている場合、S(分離型)と入力される。

    C:一体型
    S:分離型
    options

    オプション
    select_one_by_option

    オプション別に１個ずつ選択(独立型オプション)

    独立型オプションを使う場合、一つのオプションを重複して選択することができず、一つずつしか選択できない。

    T:使用する
    F:使用しない
    use_additional_option

    追加入力オプション使用の設定

    T:使用する
    F:使用しない
    additional_options

    追加入力オプション
    use_attached_file_option

    ファイル添付オプション使用の設定

    T:使用する
    F:使用しない
    attached_file_option

    ファイル添付オプション

    Retrieve a list of product options

    GET /api/v2/products/{product_no}/options

    GET

    商品のオプションをリストで照会することができます。

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    商品固有の一連番号。ショップ内で商品番号は重複しない。

    Retrieve a list of product options
    Request Copy
    Response Copy

    Products variants

    品目(Variants)はショップで販売される商品の基本単位です。ショップは一般的に顧客に多様な選択肢を提供するために同じ商品でもサイズや色が違う品目を販売します。
    品目は下記のようなResourceを下位Resourceとして持っています。

    ● 在庫(Inventories)

    Endpoints 
    GET /api/v2/products/{product_no}/variants
GET /api/v2/products/{product_no}/variants/{variant_code}

    Products variants properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    variant_code

    Type : [A-Z0-9]
    Length Min : [12]~Max : [12]

    品目コード

    システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。
    options

    オプション
    display

    表示ステータス

    品目を表示するかどうかを設定。品目を表示する場合、商品詳細または商品リストでその品目を選択することができる。品目が設定されていない場合、その品目が表示されないため、その品目を購入することができない。

    T:表示する
    F:表示しない
    selling

    販売ステータス

    品目を販売するかどうかを設定。表示されているが販売はしない場合、その品目は「在庫切れ」と表示され、その品目を購入することができない。品目のステータスが「販売」であっても「表示しない」になっているとその品目は購入できない。

    T:販売する
    F:販売しない
    additional_amount

    追加金額

    品目を購入する時、商品の販売価格に加えて支払わなければならない追加価格
    quantity

    数量
    safety_inventory

    安全在庫数量
    image

    品目画像
    inventories

    在庫リソース

    品目の在庫Resource
    Embedパラメーターを使って照会することができる。

    Retrieve a list of product variants

    GET /api/v2/products/{product_no}/variants

    GET

    商品の品目を一覧で照会することができます。
    商品の品目コード、陳列状態、販売状態などを照会することができます。

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    システムにより付与された商品の番号。商品番号はショップ内で重複しない。

    inventories
    embed

    在庫リソース

    品目の在庫Resource
    Embedパラメーターを使って照会することができる。

    ,(コンマ)で複数の件を検索することができる。

    Retrieve a list of product variants
    Request Copy
    Response Copy

    Retrieve a product variant

    GET /api/v2/products/{product_no}/variants/{variant_code}

    GET

    商品の特定の品目を照会することができます。
    オプション情報、独自品目コード、陳列·販売状態などを照会することができます。

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    商品固有の一連番号。ショップ内で商品番号は重複しない。

    variant_code
    Required

    Type : [A-Z0-9]
    Length Min : [12]~Max : [12]

    品目コード

    inventories
    embed

    在庫リソース


    Embedパラメーターを使って照会することができる。

    Retrieve a product variant
    Request Copy
    Response Copy

    Products variants inventories

    在庫(Inventories)は販売可能な品目の数量を意味します。在庫は品目(Variants)別に存在し、在庫以上の品目が販売されるとその商品は在庫切れになります。

    Endpoints 
    GET /api/v2/products/{product_no}/variants/{variant_code}/inventories

    Products variants inventories properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    variant_code

    Type : [A-Z0-9]
    Length Min : [12]~Max : [12]

    品目コード

    システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。
    quantity

    数量

    販売可能な在庫数。在庫数は注文または決済時に差し引かれ、在庫切れの表示のためにチェックされる。
    safety_inventory

    安全在庫数量
    origin_code

    出荷元コード

    Retrieve inventory details of a product variant

    GET /api/v2/products/{product_no}/variants/{variant_code}/inventories

    GET

    商品の在庫を照会することができます。

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    商品固有の一連番号。ショップ内で商品番号は重複しない。

    variant_code
    Required

    Type : [A-Z0-9]
    Length Min : [12]~Max : [12]

    品目コード

    販売数量を検索する品目コード

    Retrieve inventory details of a product variant
    Request Copy
    Response Copy

    Productsdetail

    商品詳細情報(Productsdetail)は、商品詳細ページに表示される項目とその値を照会できる機能です。

    Endpoints 
    GET /api/v2/productsdetail/{product_no}

    Productsdetail properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    product_no

    商品番号

    商品固有の一連番号。ショップ内で商品番号は重複しない。
    detail_image

    詳細画像

    商品詳細画面に表示される商品画像
    small_image

    縮小画像

    商品詳細画面の下部に表示される商品の一覧画像
    additional_images

    Array Max : [20]

    追加画像

    商品詳細画面の下部に表示される商品の追加画像。縮小画像に似ている位置に表示される。PCショップではマウスオーバー時に、モバイルショップでは画像スワイプ(Swipe)時に追加画像の確認ができる。
    product_name

    商品名

    商品の名前。商品名は商品を区分する一番基礎的な情報で、検索情報になる。HTMLを使って入力できる。
    manufacturer_name

    メーカー

    メーカーの名前。メーカー名はショップ管理者画面でメーカーを区分する基本的な情報である。
    origin_place_value

    原産国
    retail_price

    商品の定価

    市場で販売される消費者価格。ショップの価格をアピールする比較の目的で使う。
    price

    販売価格

    商品の販売価格。クーポン及び特典を適用する前の価格
    商品登録時にはマルチショップに同じ価格で登録するが、ショップ別に異なる価格を入力したい場合は商品修正を通じて異なる価格を入力することができる。
    ※ 販売価格 = [ 原価 + (原価 * 売上総利益率) + 追加金額 ]
    interest_free_period

    分割払い(手数料無料)期間

    無利子分割払いが設定されたときに適用可能な期間
    eng_product_name

    商品名(英語)

    商品の英語名。海外配送などに使用可能
    custom_product_code

    独自商品コード

    ユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。
    points_amount

    ポイント

    商品注文時にもらえる積立金の金額。 設定によって積立金を決済手段に関係なく共通して受け取るように設定したり、決済手段別に受け取るように設定することができる。
    brand_name

    ブランド名
    model_name

    モデル名

    商品のモデル名
    price_excluding_tax

    商品販売価格

    税抜き商品の販売価格
    tax_calculationがA(自動計算)の場合、nullに返却される。
    tax

    税額
    product_code

    商品コード

    システムにより商品に付与されたコード。ショップ内で商品コードは重複しない。
    simple_description

    商品簡略説明

    商品に対する簡単な情報。商品表示画面に表示できる説明。HTMLを使って入力できる。
    [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定']で表示されるように設定可能
    summary_description

    商品要約説明

    商品に対する要約情報。商品表示画面に表示できる説明。HTMLを使って入力できる。
    [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定']で表示されるように設定可能
    supplier_name

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。
    made_date

    製造日

    商品を製造した製造日
    review_count

    商品レビュー数

    商品を選択し、使用レビューに書き込みが登録された数
    expiration_date

    有効期間

    商品を正常に使える期間。商品券やチケットのような無形商品、食品や化粧品のような有形商品の有効期間を表示

    主に商品券やチケットのような無形商品に使われ、その無形商品の有効期間を表示。
    coupon_discounted_price

    クーポン適用価格

    商品にクーポンが設定された場合、そのクーポンを適用した金額
    trend_name

    トレンド名
    shipping_scope

    配送情報

    国内配送しかできない商品か海外配送も可能な商品かを表示。[ショップ設定 > 配送設定 > '配送基本設定 > 送料の設定 > 個別送料設定']で商品別の個別送料設定が「使用しない」の場合は設定できない。
    shipping_fee_type

    送料タイプ

    shipping_calculationがA（自動計算）の場合はnullに返却。

    T:送料無料
    R:固定送料を使用
    M:購入金額によって課金
    D:購入金額別送料を使用
    W:商品の重量別送料を使用
    C:商品の数量別送料を使用
    N:商品の数量に比例して送料を課金
    shipping_rates

    範囲別送料

    個別送料を使用する場合は、商品の個別送料。

    shipping_rates_min : 送料 区間 開始 基準
    shipping_rates_max : 送料 区間 終了 基準
    shipping_fee : 送料

    shipping_calculationがA（自動計算）の場合はnullに返却。
    shipping_fee

    送料
    discount_price

    割引販売価格

    商品に割引が設定された場合、割引を適用した販売価格
    optimum_discount_price

    割引適用価格
    shipping_method

    配送方法

    配送手段および方法
    shipping_calculationがA（自動計算）の場合はnullに返却。
    promotion_period

    割引期間

    商品に割引が設定された場合、その割引が適用される期間
    colors

    カラー
    translated_additional_description

    商品追加説明の翻訳情報
    stock_quantity

    在庫数量
    question_count

    商品に関する問い合わせの数

    商品を選択し、商品お問い合わせに書き込みが登録された数
    relation_count

    関連商品数

    商品登録/修正時に関連商品として登録された商品数
    product_material

    商品素材
    product_article_count

    自由掲示板

    商品を選択し、商品自由掲示板に書き込みが登録された数
    additional_information

    追加項目

    商品登録/修正時に追加入力した項目
    payment_methods

    決済方法
    add_products

    追加構成商品

    商品登録/修正時に追加構成商品として登録された商品数

    Retrieve the details of a product

    GET /api/v2/productsdetail/{product_no}

    GET

    商品の詳細ページに表示される項目とその値を照会することができます。
    商品名、メーカー、画像などを照会することができます。

    基本スペック

    Property Description
    SCOPE 商品の閲覧権限 (mall.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    商品固有の一連番号。ショップ内で商品番号は重複しない。

    mobile

    モバイル設定値で照会するか否か

    T:使用する
    F:使用しない

    Retrieve the details of a product
    Request Copy
    Response Copy

    Category

    Categories

    Categories Resource関係図

    商品カテゴリ(Categories)はショップの顧客が見つけやすい方法で商品を表示したり分類できるカテゴリです。商品を一つ以上の商品カテゴリに表示しないと販売できません。一つの商品を複数の商品カテゴリに表示することができます。

    Endpoints 
    GET /api/v2/categories
GET /api/v2/categories/count
GET /api/v2/categories/{category_no}

    Categories properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    category_no

    カテゴリ番号

    商品カテゴリ固有の一連番号。ショップ内で商品カテゴリ番号は重複しない。
    category_depth

    Min : [1]~Max : [4]

    カテゴリdepth

    下位何次の商品カテゴリにあるカテゴリかを表示する。1~4次まで商品カテゴリが存在する。
    parent_category_no

    親カテゴリ番号

    商品カテゴリが2次(中カテゴリ)、3次(小カテゴリ)、4次(細カテゴリ)の場合、上位にある商品カテゴリの番号を表示する。

    parent_category_no = 1の場合、そのカテゴリは大カテゴリを意味する。
    category_name

    Max Length : [50]

    カテゴリ名

    商品カテゴリの名前を示す。
    full_category_name

    カテゴリ全体の名前

    商品カテゴリが属している上位商品カテゴリの名前をすべて表示
    full_category_no

    全てのカテゴリ番号

    該当する商品カテゴリが属している上位の商品カテゴリの番号をすべて表示
    root_category_no

    最上位カテゴリ番号

    商品カテゴリが属している最上位商品カテゴリのカテゴリ番号表示
    use_display

    表示ステータス

    商品カテゴリ表示の設定。「表示しない」の場合、その商品カテゴリにアクセスできない。

    この設定はショップ別に設定できず、すべてのショップに適用される。

    T:表示する
    F:表示しない
    display_order

    表示順序

    商品カテゴリをショップの運営者が配置した順序
    hash_tags

    ハッシュタグ

    該当する商品カテゴリのハッシュタグリスト

    ※ この機能はショッピングキュレーションサービスを使用する場合のみ使用することができる。

    Retrieve a list of product categories

    GET /api/v2/categories

    GET

    ショッピングモールに登録されている分類をリストで照会します。
    分類の分類番号や分類名などを確認できます。

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    category_depth

    Min : [1]~Max : [4]

    カテゴリdepth

    検索したい商品カテゴリの次数検索

    category_no

    カテゴリ番号

    検索したい商品カテゴリの番号

    parent_category_no

    親カテゴリ番号

    検索したい商品カテゴリの親商品カテゴリ番号検索

    大カテゴリのみ検索したい場合はparent_category_no =1で検索する。

    category_name

    カテゴリ名

    検索キーワードがカテゴリ名に含まれている商品カテゴリ検索(大文字・小文字を区別しない)

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    DEFAULT 0

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    Retrieve a count of product categories

    GET /api/v2/categories/count

    GET

    ショッピングモールに登録されている分類の数を照会します。

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    category_depth

    Min : [1]~Max : [4]

    カテゴリdepth

    検索したい商品カテゴリの次数検索

    category_no

    カテゴリ番号

    検索したい商品カテゴリの番号

    parent_category_no

    親カテゴリ番号

    検索したい商品カテゴリの親商品カテゴリ番号検索

    大カテゴリのみ検索したい場合はparent_category_no =1で検索する。

    category_name

    カテゴリ名

    検索キーワードがカテゴリ名に含まれている商品カテゴリ検索(大文字・小文字を区別しない)

    Retrieve a count of product categories
    Request Copy
    Response Copy

    Retrieve a product category

    GET /api/v2/categories/{category_no}

    GET

    分類番号を使用して、その分類について詳細を照会します。
    分類Depth、親分類番号、分類名などを照会することができます。

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    検索したい商品カテゴリの番号

    Retrieve a product category
    Request Copy
    Response Copy

    Personal

    Carts

    カート(Carts)は商品を注文する前に一度に注文できるように商品をあらかじめ入れておく機能です。
    ショッピングカートリソースでは、Front APIを使用して特定の商品をショッピングカートに入れることができ、Admin APIでは特定の会員のショッピングカートを照会することができます。

    Endpoints 
    POST /api/v2/carts

    Carts properties

    Attribute Description
    duplicated_item

    カート内アイテムコードの重複有無

    T:品目が重複する
    F:品目が重複しない
    variants

    品目
    product_no

    商品番号
    basket_type

    カートタイプ

    A0000:一般
    A0001:無利息
    prepaid_shipping_fee

    送料前払いの設定

    P:前払い
    C:着払い

    Create a shopping cart

    POST /api/v2/carts

    POST

    基本スペック

    Property Description
    SCOPE 個人化情報の投稿権限 (mall.write_personal)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    variants

    品目

    品目情報。カートに追加する品目の個数と品目コード

    quantity
    Required
    数量

    variants_code
    Required
    商品品目コード

    options Array

    option_code
    オプションコード

    value_no
    オプション値

    additional_option_values Array

    key
    追加オプションのキー値

    type
    追加オプションのタイプ

    name
    追加オプション名

    value
    追加オプション値
    addtional_products

    追加構成商品の品目

    product_no
    Required

    商品番号

    商品固有の一連番号。ショップ内で商品番号は重複しない。

    basket_type
    Required

    カートタイプ

    カートのタイプ。分割払い手数料無料が可能な商品の場合は手数料無料タイプに設定可能

    A0000:一般
    A0001:無利息

    duplicated_item_check
    Required

    カートの重複チェック

    カートに追加する品目に対し、重複を許容するかどうかを設定
    重複を許容すると品目の個数が追加される。
    重複を許容しないとその品目はカートに追加されない。

    T:品目の重複をチェックする
    F:品目の重複をチェックしない

    prepaid_shipping_fee
    Required

    送料前払いの設定

    P:前払い
    C:着払い

    Create a shopping cart
    Request Copy
    Response Copy

    Products carts



    商品カート(Products carts)は、特定の商品をカートに入れた会員とその数字を照会できるリソースです。
    特定の商品をカートに入れた会員のID、入れた日付、会員数情報を照会することができます。

    Endpoints 
    GET /api/v2/products/{product_no}/carts/count

    Retrieve a count of carts containing a product

    GET /api/v2/products/{product_no}/carts/count

    GET

    特定の商品をカートに入れた会員数を確認できます。

    基本スペック

    Property Description
    SCOPE 個人化情報の閲覧権限 (mall.read_personal)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    システムにより付与された商品の番号。商品番号はショップ内で重複しない。

    Retrieve a count of carts containing a product
    Request Copy
    Response Copy
    Top