NAV Navbar
javascript shell
  • Introduction
  • Cart
  • Categories
  • Products
  • Products cart
  • Products decorationimages
  • Products discountprice
  • Products hits
  • Products options
  • Products variants
  • Products variants inventories
  • Introduction

    Cafe24 API

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

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

    Request/Response Format

    要求例題(検索)

    curl -X GET \
      '{endpoint_url}' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json'
    

    要求例題(登録/修正)

    curl -X POST \
      '{endpoint_url}' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{ .... }'
    

    正常応答例題

    {
        "request": {
            "key": "value",
            "key": "value"
         }
    }
    

    エラー応答例題

    {
        "error": {
            "code": "エラーコード",
            "message": "エラーメッセージ",
            "more_info": {
            }
        }
    }
    

    Method

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

    Front API Intro

    使用例

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

    Front API

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

    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) AccessToken がない状況で呼び出した場合
    2) AccessTokenが有効ではない場合
    3) AccessTokenが満了した場合
    4) 不明なクライアントの場合
    有効な手続きを踏んで発行されたAccessTokenを使っているか確認します。
    401 Front APIの使用時にclient_idを入力していない場合 有効なクライアントIDを使っているか確認します。
    403 1) AccessTokenはあるが、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文書を参考に確認します。
    422 検索/処理を要求した時、値が決まっているスペックと違う場合
    1) 必須パラメーター抜け
    2) 決まっているスペックと違う場合
    API文書を参考に必須パラメーターが入力されていないか、有効でない値が入力されているか確認します。
    429 クライアントのAPI要求がBucketを超過した場合 API最大許容要求件数を超過しないようにしばらくしてからもう一度要求します。
    500 内部サーバーエラー、不明なエラー 一時的にエラーが発生しました。しばらくしてからもう一度お試しください。
    503 現在のサーバーがダウンした場合 開発者センターにお問い合わせください。
    503 サーバーがダウンした場合。APIが使用できない 開発者センターにお問い合わせください。
    504 要求時間を超過した場合(Timeout) 一時的にエラーが発生し、応答が遅れています。しばらくしてからもう一度お試しください。

    How to use GET API

    全てのショップの情報検索

    例) 特定のブランド内で価格が100円以上の商品を検索する場合
    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
    


    パラメーターで複数の条件で検索する

    例) 11番、12番、13番商品の情報を検索する場合
    GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13
    


    全てのショップの情報検索

    例) 2番ショップの商品を検索する
    GET https://{mallid}.cafe24api.com/api/v2/products?shop_no=2
    


    詳細検索と1件検索

    例) 128番商品を詳細検索する方法
    GET https://{{mallid}}.cafe24api.com/api/v2/admin/products/128
    
    
    例) 128番商品をパラメーターを使って1件検索する場合
    GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?product_no=128
    


    Pagination

    例) 商品を1回に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
    


    Fieldパラメーター

    例) 商品検索時に商品名と商品番号パラメーターのみ検索する
    GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?fields=product_name,product_no
    


    Embedパラメーター

    例) 商品検索時にオプションと品目データを一緒に検索する
    GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?embed=variants,inventories
    

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

    1. 検索条件を追加

    API検索時に検索条件はエンドポイントにパラメーターを追加して検索できます。複数の条件で同時に検索する場合は、区切り文字「&」を使って検索条件を追加することができます。

    開始日、終了日などの範囲を検索する場合にも区切り文字「&」を使って検索することができます。

    2. パラメーターで色々な条件検索

    APIで対応する場合、コンマ(,)を使って複数の値を同時に検索することができます。

    コンマ(,)を使って追加した検索条件はOR条件で、その検索条件に該当するすべての値が検索されます。

    3. すべてのショップ情報検索

    API検索時に特定のshop_noを明示すると、該当する全てのショップの情報を検索することができます。特定のshop_noを明示しない場合は1番目のショップ(基本ショップ)の情報を検索します。

    4. 詳細検索と1件検索

    ほとんどのEntityはURLにEntityのIDを明示して詳細検索ができます。

    詳細検索はEntity一つしか検索できませんが、リスト検索よりたくさんの項目が返還されます。

    5. Pagination

    リスト検索時に検索する項目が多すぎる場合は、すべての結果が一気に検索されないこともあります。1回の検索でより多くの結果を得たい場合は、「limit」パラメーターを使って検索件数を拡張することができます。「limit」パラメーターを使わない場合は「limit」の基本値だけ検索されます。

    「limit」パラメーターで拡張できる検索件数は、各APIに定義されている「最大値」までです。もし「limit 最大値」ですべてのデータを検索することができない場合は、「offset」パラメーターを使うことができます。「offset」パラメーターは何番目の商品から検索を始めるかを決定し、その商品から「limit」数だけの商品を再度検索します。

    6. Fieldパラメーター

    API検索値の中で特定の値だけ検索したい場合は、fieldパラメーターを使ってその値を検索することができます。

    7. Embedパラメーター

    商品検索時に商品に属する下位Entity(例: 品目、在庫)を一緒に検索したい場合は、「embed」パラメーターを使って下位Entityのデータを一緒に検索することができます。

    「embed」パラメーターは対応するAPIでしか使用できません。

    API Limit

    X-Api-Call-Limit : 1/30
    

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

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

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

    Cart

    Cart properties

    Attribute Description
    duplicated_item

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

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

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

    variants

    品目

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

    product_no

    商品番号

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

    basket_type

    カートタイプ

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

    A0000:一般
    A0001:無利息

    prd_detail_ship_fee

    送料前払いの設定

    送料を前払いにするか着払いにするかを設定

    P:前払い
    C:着払い

    Create a cart

    Definition

    POST 'https://{domain}/api/v2/cart'
    
    POST 'https://{mallid}.cafe24api.com/api/v2/cart'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    var data = {
        "request": {
            "duplicated_item_check": "T",
            "product_no": 950,
            "basket_type": "A0000",
            "shipping_type": "A",
            "prefaid_shipping_fee": "P",
            "variants": [
                {
                    "quantity": 1,
                    "variants_code": "P0000BJU000H"
                }
            ]
        }
    } 
    CAFE24API.post('/api/v2/cart', data, function(err, res){
        console.log(res);
    });
    
    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/cart' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "duplicated_item_check": "T",
            "product_no": 950,
            "basket_type": "A0000",
            "shipping_type": "A",
            "prefaid_shipping_fee": "P",
            "variants": [
                {
                    "quantity": 1,
                    "variants_code": "P0000BJU000H"
                }
            ]
        }
    }'
    

    Response example:

    {
        "cart": [
            {
                "duplicated_item": "T",
                "variants": [
                    {
                        "quantity": 1,
                        "variants_code": "P0000BJU000H"
                    },
                    {
                        "quantity": 2,
                        "variants_code": "P0000BJU000M"
                    }
                ],
                "product_no": 950,
                "basket_type": "A0000",
                "shipping_type": "A",
                "prefaid_shipping_fee": "P"
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 個人化情報 投稿権限 (WRITE_PERSONAL)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    variants

    品目

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

    addtional_products

    追加構成商品の品目

    product_no
    Required

    商品番号

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

    basket_type
    Required

    カートタイプ

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

    A0000:一般
    A0001:無利息

    duplicated_item_check
    Required

    カートの重複チェック

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

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

    prefaid_shipping_fee
    Required

    送料前払いの設定

    送料を前払いにするか着払いにするかを設定

    P:前払い
    C:着払い

    Categories

    Categories Entity関係図

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

    最上位カテゴリ番号

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

    display_order

    表示順序

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

    hash_tags

    キュレーションハッシュタグ

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

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

    List all categories

    Definition

    GET 'https://{domain}/api/v2/categories'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/categories'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/categories', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/categories' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "categories": [
            {
                "shop_no": 1,
                "category_no": 27,
                "category_depth": 1,
                "parent_category_no": 1,
                "category_name": "(large scale classification) Bottoms",
                "full_category_name": {
                    "1": "(Main Category) Tops",
                    "2": "(Middle Category) Tees",
                    "3": "(Small Category) Long Sleeve",
                    "4": "(Detailed Category) Cropped"
                },
                "root_category_no": 27,
                "display_order": 0,
                "full_category_no": {
                    "1": "25",
                    "2": "28",
                    "3": "30",
                    "4": "40"
                },
                "hash_tags": [
                    "tag1",
                    "tag2"
                ]
            },
            {
                "shop_no": 1,
                "category_no": 28,
                "category_depth": 1,
                "parent_category_no": 1,
                "category_name": "(large scale classification) Accessories",
                "full_category_no": {
                    "1": "28",
                    "2": null,
                    "3": null,
                    "4": null
                },
                "full_category_name": {
                    "1": "(large scale classification) Accessories",
                    "2": null,
                    "3": null,
                    "4": null
                },
                "display_order": 0,
                "hash_tags": [
                    "tag1",
                    "tag2"
                ]
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 商品カテゴリ 閲覧権限 (READ_CATEGORY)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    category_depth

    Min : [1]~Max : [4]

    カテゴリdepth

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

    category_no

    カテゴリ番号

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

    parent_category_no

    親カテゴリ番号

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

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

    category_name

    カテゴリ名

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

    limit

    Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    Count all categories

    Definition

    GET 'https://{domain}/api/v2/categories/count'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/categories/count'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/categories/count', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/categories/count' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    基本スペック

    Property Description
    SCOPE 商品カテゴリ 閲覧権限 (READ_CATEGORY)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    category_depth

    Min : [1]~Max : [4]

    カテゴリdepth

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

    category_no

    カテゴリ番号

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

    parent_category_no

    親カテゴリ番号

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

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

    category_name

    カテゴリ名

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

    Get a category

    Definition

    GET 'https://{domain}/api/v2/categories/{#id}'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/categories/{#id}'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/categories/40', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/categories/40' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "category": {
            "shop_no": 1,
            "category_no": 40,
            "category_depth": 4,
            "parent_category_no": 37,
            "category_name": "(Detailed Category) Cropped",
            "full_category_no": {
                "1": "25",
                "2": "28",
                "3": "30",
                "4": "40"
            },
            "full_category_name": {
                "1": "(Main Category) Tops",
                "2": "(Middle Category) Tees",
                "3": "(Small Category) Long Sleeve",
                "4": "(Detailed Category) Cropped"
            },
            "display_order": 0,
            "hash_tags": [
                "tag1",
                "tag2"
            ]
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品カテゴリ 閲覧権限 (READ_CATEGORY)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

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

    Products

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

    商品(Products)の{#id}は""product_no""です。

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

    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

    商品販売価格

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

    retail_price

    商品の消費者価格

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

    display

    表示ステータス

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

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

    selling

    販売ステータス

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

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

    product_used_month

    Max : [2147483647]

    中古商品の使用月数

    summary_description

    Max Length : [255]

    商品要約説明

    商品に対する要約情報。商品表示画面に表示できる説明。HTMLを使って入力できる。
    商品管理 > 商品表示管理 > 商品情報表示設定で表示されるように設定可能

    product_tag

    Max Length : [200]

    商品検索キーワード

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

    price_content

    Max Length : [20]

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

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

    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」と表示されます。

    mileage_amount

    ポイント設定情報

    商品注文時にもらえるポイント。設定によってポイントを決済方法と関係なく共通でもらえるように設定したり、決済方法別にもらえるように設定することができる。

    adult_certification

    年齢認証

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

    detail_image

    詳細画像

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

    list_image

    一覧画像

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

    tiny_image

    縮小一覧画像

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

    small_image

    縮小画像

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

    has_option

    オプション使用の設定

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

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

    option_type

    オプション構成方式

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

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

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

    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)」の場合、原産国として入力可能な情報

    icon_show_period

    アイコンの表示期間

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

    icon

    Array Max : [5]

    アイコン

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

    product_material

    商品素材

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

    list_icon

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

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

    ※ 在庫切れアイコン

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

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

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

    ※ アイコン表示の設定位置 : [ショップ管理> 運営管理> 詳細設定> (タブ)商品設定> 商品アイコンの設定]

    select_one_by_option

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

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

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

    approve_status

    承認申込結果

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

    sold_out

    在庫切れ状況

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

    discountprice

    商品の割引価格Entity


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

    decorationimages

    デコ画像Entity


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

    variants

    品目Entity


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

    詳細検索時のみ確認可能である。

    memos

    メモEntity


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

    詳細検索時のみ確認可能である。

    hits

    商品閲覧数Entity


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

    詳細検索時のみ確認可能である。

    seo

    商品Seo Entity


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

    詳細検索時のみ確認可能である。

    category

    カテゴリ番号

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

    詳細検索時のみ確認可能である。

    description

    商品詳細説明

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

    詳細検索時のみ確認可能である。

    mobile_description

    モバイル商品詳細説明

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

    詳細検索時のみ確認可能である。

    additional_image

    Array Max : [20]

    追加画像

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

    特定商品詳細検索APIでしか確認できない。

    詳細検索時のみ確認可能である。

    payment_info

    商品決済ガイド

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

    詳細検索時のみ確認可能である。

    shipping_info

    商品配送ガイド

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

    詳細検索時のみ確認可能である。

    exchange_info

    交換・返品ガイド

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

    詳細検索時のみ確認可能である。

    service_info

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

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

    詳細検索時のみ確認可能である。

    product_tax_type_text

    消費税表示メッセージ

    商品管理 > 商品表示管理 > 商品情報表示設定 > 販売価格付加価値税表示メッセージで設定したメッセージ表示

    詳細検索時のみ確認可能である。

    set_product_type

    セット商品のタイプ

    詳細検索時のみ確認可能である。

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

    simple_description

    商品簡略説明

    商品に対する簡単な情報。商品表示画面に表示できる説明。HTMLを使って入力できる。
    商品管理 > 商品表示管理 > 商品情報表示設定で表示されるように設定可能

    詳細検索時のみ確認可能である。

    tags

    商品タグEntity


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

    詳細検索時のみ確認可能である。

    options

    商品オプションEntity


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

    詳細検索時のみ確認可能である。

    shipping_method

    配送方法

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

    詳細検索時のみ確認可能である。

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

    prepaid_shipping_fee

    送料前払いの設定

    詳細検索時のみ確認可能である。

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

    shipping_period

    配送期間

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

    詳細検索時のみ確認可能である。

    shipping_scope

    配送情報

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

    詳細検索時のみ確認可能である。

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

    shipping_area

    Max Length : [255]

    配送地域

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

    詳細検索時のみ確認可能である。

    shipping_fee_type

    送料タイプ

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

    詳細検索時のみ確認可能である。

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

    shipping_rates

    区間別送料

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

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

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

    詳細検索時のみ確認可能である。

    clearance_category_code

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

    海外通関コード

    詳細検索時のみ確認可能である。

    origin_place_code

    原産国コード

    商品の原産国コード

    詳細検索時のみ確認可能である。

    additional_information

    追加項目

    商品管理 > 商品表示設定 > 商品情報項目設定で追加した追加項目

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

    詳細検索時のみ確認可能である。

    main

    メイン表示

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

    詳細検索時のみ確認可能である。

    relational_product

    関連商品

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

    詳細検索時のみ確認可能である。

    List all products

    Definition

    GET 'https://{domain}/api/v2/products'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/products'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "products": [
            {
                "shop_no": 1,
                "product_no": 24,
                "product_code": "P000000X",
                "custom_product_code": "",
                "product_name": "iPhone X",
                "eng_product_name": "iPhone Ten",
                "model_name": "A1865",
                "price": "1000.00",
                "retail_price": "0.00",
                "display": "T",
                "selling": "F",
                "product_used_month": 2,
                "summary_description": "This is Product Summary.",
                "price_content": null,
                "buy_unit_type": "O",
                "buy_unit": 1,
                "order_quantity_limit_type": "O",
                "minimum_quantity": 1,
                "maximum_quantity": 0,
                "mileage_amount": null,
                "adult_certification": "F",
                "detail_image": "http:\/\/{domain}\/web\/product\/big\/201711\/20_shop1_750339.png",
                "list_image": "http:\/\/{domain}\/web\/product\/medium\/201711\/20_shop1_750339.png",
                "tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201711\/20_shop1_750339.png",
                "small_image": "http:\/\/{domain}\/web\/product\/small\/201711\/20_shop1_750339.png",
                "has_option": "F",
                "option_type": "T",
                "manufacturer_code": "M0000000",
                "trend_code": "T0000000",
                "brand_code": "B0000000",
                "made_date": "",
                "expiration_date": {
                    "start_date": "20170908",
                    "end_date": "20170914"
                },
                "origin_classification": "F",
                "origin_place_no": 1798,
                "origin_place_value": "",
                "icon_show_period": {
                    "start_date": "2017-10-30 09:00:00",
                    "end_date": "2017-11-02 16:00:00"
                },
                "icon": [
                    "icon_01_01",
                    "icon_02_01"
                ],
                "product_material": "",
                "list_icon": {
                    "soldout_icon": true,
                    "recommend_icon": false,
                    "new_icon": false
                },
                "approve_status": "",
                "sold_out": "F"
            },
            {
                "shop_no": 1,
                "product_no": 23,
                "product_code": "P000000W",
                "custom_product_code": "",
                "product_name": "iPhone X",
                "eng_product_name": "iPhone Ten",
                "model_name": "A1865",
                "price": 1000,
                "retail_price": 0,
                "display": "T",
                "selling": "F",
                "product_used_month": 2,
                "summary_description": "This is Product Summary.",
                "price_content": null,
                "buy_unit_type": "O",
                "buy_unit": 1,
                "order_quantity_limit_type": "O",
                "minimum_quantity": 1,
                "maximum_quantity": 0,
                "mileage_amount": null,
                "adult_certification": "F",
                "detail_image": "http:\/\/{domain}\/web\/product\/big\/201711\/20_shop1_750339.png",
                "list_image": "http:\/\/{domain}\/web\/product\/medium\/201711\/20_shop1_750339.png",
                "tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201711\/20_shop1_750339.png",
                "small_image": "http:\/\/{domain}\/web\/product\/small\/201711\/20_shop1_750339.png",
                "has_option": "F",
                "option_type": "T",
                "manufacturer_code": "M0000000",
                "trend_code": "T0000000",
                "brand_code": "B0000000",
                "made_date": "",
                "expiration_date": {
                    "start_date": "20170908",
                    "end_date": "20170914"
                },
                "origin_classification": "F",
                "origin_place_no": 1798,
                "origin_place_value": "",
                "icon_show_period": {
                    "start_date": "2017-10-30 09:00:00",
                    "end_date": "2017-11-02 16:00:00"
                },
                "icon": [
                    "icon_01_01",
                    "icon_02_01"
                ],
                "product_material": "",
                "list_icon": {
                    "soldout_icon": true,
                    "recommend_icon": false,
                    "new_icon": false
                },
                "approve_status": "C",
                "sold_out": "F"
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 商品 閲覧権限 (READ_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    discountprice
    embed

    商品の割引価格Entity


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

    decorationimages
    embed

    デコ画像Entity


    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

    独自商品コード

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

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

    price_min

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

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

    price_max

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

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

    retail_price_min

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

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

    retail_price_max

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

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

    supply_price_min

    商品原価の検索最小値

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

    supply_price_max

    商品原価の検索最大値

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

    created_start_date

    timezone

    商品登録日の検索開始日

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

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

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

    created_end_date

    timezone

    商品登録日の検索終了日

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

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

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

    updated_start_date

    timezone

    商品修正日の検索開始日

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

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

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

    updated_end_date

    timezone

    商品修正日の検索終了日

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

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

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

    category

    カテゴリ番号

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

    eng_product_name

    英語商品名

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

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

    supply_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 : [1]
    Max : [2147483647]

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

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

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

    product_no
    sort
    order
    offset

    sort

    並べ替え順序の値

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

    order

    並べ替え順序

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

    offset

    Max : [5000]

    検索結果の開始位置

    検索結果の開始位置

    limit

    Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    Count all products

    Definition

    GET 'https://{domain}/api/v2/products/count'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/products/count'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/count', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/count' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    基本スペック

    Property Description
    SCOPE 商品 閲覧権限 (READ_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    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

    独自商品コード

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

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

    price_min

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

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

    price_max

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

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

    retail_price_min

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

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

    retail_price_max

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

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

    supply_price_min

    商品原価の検索最小値

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

    supply_price_max

    商品原価の検索最大値

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

    created_start_date

    timezone

    商品登録日の検索開始日

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

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

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

    created_end_date

    timezone

    商品登録日の検索終了日

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

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

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

    updated_start_date

    timezone

    商品修正日の検索開始日

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

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

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

    updated_end_date

    timezone

    商品修正日の検索終了日

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

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

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

    category

    カテゴリ番号

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

    eng_product_name

    英語商品名

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

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

    supply_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 : [1]
    Max : [2147483647]

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

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

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

    product_no
    sort
    order
    offset

    Get a product

    Definition

    GET 'https://{domain}/api/v2/products/{#id}'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/products/{#id}'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/20', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/20' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "product": {
            "shop_no": 1,
            "variants": null,
            "memos": null,
            "hits": null,
            "product_no": 20,
            "category": [
                {
                    "category_no": 27,
                    "recommend": "F",
                    "new": "T"
                },
                {
                    "category_no": 28,
                    "recommend": "T",
                    "new": "F"
                }
            ],
            "product_code": "P000000T",
            "custom_product_code": "",
            "product_name": "iPhone X",
            "eng_product_name": "iPhone Ten",
            "model_name": "A1865",
            "price": "1000.00",
            "retail_price": "0.00",
            "display": "T",
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "additional_image": [
                {
                    "big": "http:\/\/{domain}\/web\/product\/extra\/big\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                    "medium": "http:\/\/{domain}\/web\/product\/extra\/medium\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                    "small": "http:\/\/{domain}\/web\/product\/extra\/small\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg"
                },
                {
                    "big": "http:\/\/{domain}\/web\/product\/extra\/big\/201810\/e1ab68969d69287a828438c7684b14c4.jpg",
                    "medium": "http:\/\/{domain}\/web\/product\/extra\/medium\/201810\/e1ab68969d69287a828438c7684b14c4.jpg",
                    "small": "http:\/\/{domain}\/web\/product\/extra\/small\/201810\/e1ab68969d69287a828438c7684b14c4.jpg"
                }
            ],
            "payment_info": "Sample payment info. You have to Pay.",
            "shipping_info": "Sample shipping info. You have to ship.",
            "exchange_info": "Sample exchange info. You have to exchange.",
            "service_info": "Sample service info. You have to service.",
            "meta_title": "",
            "meta_author": "",
            "meta_description": "",
            "meta_keywords": "",
            "meta_alt": "",
            "search_engine_exposure": "T",
            "product_tax_type_text": null,
            "set_product_type": null,
            "selling": "F",
            "product_used_month": 2,
            "simple_description": "This is Product Description.",
            "summary_description": "This is Product Summary.",
            "product_tag": "edu,test,sample",
            "tags": {
                "tag": [
                    "edu",
                    "test",
                    "sample"
                ]
            },
            "price_content": null,
            "buy_unit_type": "O",
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "mileage_amount": null,
            "adult_certification": "F",
            "detail_image": "http:\/\/{domain}\/web\/product\/big\/201711\/20_shop1_750339.png",
            "list_image": "http:\/\/{domain}\/web\/product\/medium\/201711\/20_shop1_750339.png",
            "tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201711\/20_shop1_750339.png",
            "small_image": "http:\/\/{domain}\/web\/product\/small\/201711\/20_shop1_750339.png",
            "has_option": "F",
            "option_type": "T",
            "manufacturer_code": "M0000000",
            "trend_code": "T0000000",
            "brand_code": "B0000000",
            "made_date": "",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "origin_classification": "F",
            "origin_place_no": 1798,
            "origin_place_value": "",
            "icon_show_period": {
                "start_date": "2017-10-30 09:00:00",
                "end_date": "2017-11-02 16:00:00"
            },
            "icon": null,
            "product_material": "",
            "shipping_method": "01",
            "prepaid_shipping_fee": "B",
            "shipping_period": {
                "minimum": 3,
                "maximum": 7
            },
            "shipping_scope": "A",
            "shipping_area": "All around World",
            "shipping_fee_type": "W",
            "shipping_rates": [
                {
                    "shipping_rates_min": "0.00",
                    "shipping_rates_max": "1.00",
                    "shipping_fee": "100.00"
                },
                {
                    "shipping_rates_min": "1.00",
                    "shipping_rates_max": "2.00",
                    "shipping_fee": "200.00"
                }
            ],
            "clearance_category_code": "ACAB0000",
            "list_icon": {
                "soldout_icon": true,
                "recommend_icon": true,
                "new_icon": true
            },
            "additional_information": [
                {
                    "key": "custom_option1",
                    "name": "gift option",
                    "value": "Yes"
                }
            ],
            "main": [
                3,
                2
            ],
            "relational_product": [
                {
                    "product_no": 17,
                    "interrelated": "T"
                },
                {
                    "product_no": 19,
                    "interrelated": "F"
                }
            ],
            "select_one_by_option": "F",
            "approve_status": "C",
            "sold_out": "F"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 閲覧権限 (READ_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

    検索したい商品の番号

    variants
    embed

    品目Entity


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

    memos
    embed

    メモEntity


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

    hits
    embed

    商品閲覧数Entity


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

    seo
    embed

    商品Seo Entity


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

    tags
    embed

    商品タグEntity


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

    options
    embed

    商品オプションEntity


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

    discountprice
    embed

    商品の割引価格Entity


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

    decorationimages
    embed

    デコ画像Entity


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

    Products cart

    商品カートは商品別に顧客がカートにどれほど商品を入れたかを確認する情報です。商品カートAPIで商品が顧客のカートにいくら入っているかを確認することができます。

    Products cart properties

    Count all products cart

    Definition

    GET 'https://{domain}/api/v2/products/{#id}/cart/count'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/products/{#id}/cart/count'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/11/cart/count', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/11/cart/count' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 7
    }
    

    基本スペック

    Property Description
    SCOPE 個人化情報 閲覧権限 (READ_PERSONAL)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Products decorationimages

    Products decorationimages properties

    Attribute Description
    use_show_date

    表示期間の使用の有無

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

    show_start_date

    timezone

    表示期間の開始日

    show_end_date

    timezone

    表示期間の終了日

    image_list

    デコ画像一覧

    List all products decoration images

    Definition

    GET 'https://{domain}/api/v2/products/{#id}/decorationimages'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/products/{#id}/decorationimages'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/{#id}/decorationimages', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/{#id}/decorationimages' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "decorationimage": {
            "use_show_date": "T",
            "show_start_date": "2017-10-30T09:00:00+09:00",
            "show_end_date": "2017-11-02T16:00:00+09:00",
            "image_list": [
                {
                    "code": "image_custom_4",
                    "path": "\/web\/upload\/image_custom_415421761806290.gif",
                    "image_vertical_position": "L",
                    "image_horizontal_position": "T"
                },
                {
                    "code": "image_custom_3",
                    "path": "\/web\/upload\/image_custom_615421761805558.gif",
                    "image_vertical_position": "C",
                    "image_horizontal_position": "B"
                }
            ]
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 閲覧権限 (READ_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    Products discountprice

    Products discountprice properties

    Attribute Description
    pc_discount_price

    PC割引価格

    mobile_discount_price

    モバイル割引価格

    List all products discountprice

    Definition

    GET 'https://{domain}/api/v2/products/{#id}/discountprice'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/products/{#id}/discountprice'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/24/discountprice', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/24/discountprice' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "discountprice": {
            "pc_discount_price": "7000.00",
            "mobile_discount_price": "6000.00"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 閲覧権限 (READ_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    Products hits

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

    Products hits properties

    Count all products hits

    Definition

    GET 'https://{domain}/api/v2/products/{#id}/hits/count'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/products/{#id}/hits/count'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/7/hits/count', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/7/hits/count' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    基本スペック

    Property Description
    SCOPE 商品 閲覧権限 (READ_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Products 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:分離型

    option

    オプション

    商品のオプション名とオプション値表示

    select_one_by_option

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

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

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

    use_additional_option

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

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

    additional_option

    追加入力オプション

    use_attached_file_option

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

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

    attached_file_option

    ファイル添付オプション

    List all products options

    Definition

    GET 'https://{domain}/api/v2/products/{#id}/options'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/products/{#id}/options'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/7/options', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/7/options' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "options": {
            "shop_no": 1,
            "product_no": 7,
            "has_option": "T",
            "option_type": "E",
            "option_display_type": "S",
            "option": [
                {
                    "option_code": "O000000A",
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_831549.gif",
                            "option_color": "#000000",
                            "option_text": "Black"
                        },
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_831549.gif",
                            "option_color": "#007543",
                            "option_text": "Red"
                        }
                    ],
                    "required_option": "T",
                    "option_display_type": "S"
                },
                {
                    "option_code": "O000000B",
                    "option_name": "Size",
                    "option_value": [
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_931549.gif",
                            "option_color": "#000000",
                            "option_text": "Small"
                        },
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_931549.gif",
                            "option_color": "#007543",
                            "option_text": "Large"
                        }
                    ],
                    "required_option": "T",
                    "option_display_type": "S"
                }
            ],
            "select_one_by_option": "F",
            "use_additional_option": "T",
            "additional_option": [
                {
                    "additional_option_name": "Pattern",
                    "required_additional_option": "T",
                    "additional_option_text_length": 20
                },
                {
                    "additional_option_name": "Custom Option",
                    "required_additional_option": "F",
                    "additional_option_text_length": 10
                }
            ],
            "use_attached_file_option": "T",
            "attached_file_option": {
                "option_name": "Pattern Images",
                "required": "T",
                "size_limit": 3
            }
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 閲覧権限 (READ_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Products variants

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

    在庫(Inventories)

    Products variants properties

    Attribute Description
    shop_no

    ショップ番号

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

    variant_code

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

    品目コード

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

    option

    オプション

    品目のオプション。品目がどのようなオプションで構成されているかを示す。顧客が商品を購入する時、オプションを選択すると現在の品目を購入することができる。

    display

    表示ステータス

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

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

    selling

    販売ステータス

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

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

    additional_amount

    追加金額

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

    inventories

    在庫Entity

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

    List all products variants

    Definition

    GET 'https://{domain}/api/v2/products/{#id}/variants'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/products/{#id}/variants'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/20/variants', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/20/variants' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "variants": [
            {
                "shop_no": 1,
                "item_code": "P000000R000C",
                "option": [
                    {
                        "name": "Color",
                        "value": "Blue"
                    },
                    {
                        "name": "Size",
                        "value": "Small"
                    }
                ],
                "display": "T",
                "selling": "T",
                "additional_amount": "0.00"
            },
            {
                "shop_no": 1,
                "item_code": "P000000R000D",
                "option": [
                    {
                        "name": "Color",
                        "value": "Red"
                    },
                    {
                        "name": "Size",
                        "value": "Small"
                    }
                ],
                "display": "T",
                "selling": "T",
                "additional_amount": "0.00"
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 商品 閲覧権限 (READ_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Get a products variant

    Definition

    GET 'https://{domain}/api/v2/products/{#id}/variants/{#id}'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/products/{#id}/variants/{#id}'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/20/variants/P000000R000C', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/20/variants/P000000R000C' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "variant": {
            "shop_no": 1,
            "variant_code": "P000000R000C",
            "option": [
                {
                    "name": "Color",
                    "value": "Black"
                }
            ],
            "display": "T",
            "selling": "T",
            "additional_amount": "0.00"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 閲覧権限 (READ_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    variant_code
    Required

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

    品目コード

    inventories
    embed

    在庫Entity


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

    Products variants inventories

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

    Products variants inventories properties

    Attribute Description
    shop_no

    ショップ番号

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

    variant_code

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

    品目コード

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

    quantity

    数量

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

    List all products variants inventory

    Definition

    GET 'https://{domain}/api/v2/products/{#id}/variants/{#id}/inventories'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/products/{#id}/variants/{#id}/inventories'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/20/variants/P000000R000C/inventories', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/20/variants/P000000R000C/inventories' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "inventory": {
            "shop_no": 1,
            "variant_code": "P000000R000C",
            "quantity": 0
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 閲覧権限 (READ_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    variant_code
    Required

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

    品目コード

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