닫기
  • Shop

  • Product

    non-print

    API Index

    Introduction

    D.Collection API

    D.Collection APIは、Cafe24ショップの販売を促すことを目的とするマーケティング・広告サービスおよびその関連サービスの制作に携わっている、Cafe24の承認を得たパートナー会社にのみ提供されます。

    当APIを通して取得した情報を事前に承認を得ていないチャンネル(またはメディア)または目的のために使用することはできません。

    D.Collection APIは、Basic Auth基盤の認証システムと標準HTTP Request Method、リソースの予測ができるエンドポイントURL, HTTPコード基盤のエラーメッセージを提供します。

    Request/Response Format

    • APIのリクエストおよびレスポンスはJSON Formatに対応しています。

    • 個人情報などのセキュリティ保護のため、D.Collection APIはHTTPSプロトコルにのみ対応しています。

    • Dates属性は ISO_8601 フォーマットで提供されます。: YYYY-MM-DDTHH:MM:SS+09:00

    • 決済通貨は、 ISO_4217 標準に準拠してリクエストされます。

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

    Method

    各リソースごとにReadに対応しており、標準HTTP MethodでAPIを使用することができます。

    • GET : 該当するリソースの情報を照会(Read)します。

    D.Collection API Intro

    D.Collection APIは、D.Collectionプログラムに参加しているショップの情報の照会に適しています。 D.Collection APIでは、該当のリソースに対するほぼ全ての情報を照会することができます。D.Collection APIを使用するには、Basic Auth方式による別途の認証が必要となります。

    使用例
    ショップの照会 : https://dcollection-api.cafe24.com/api/shops
    商品の照会 : https://dcollection-api.cafe24.com/api/products?dcollection_product_category={dcollection_product_category}

    API Status Code

    Code 発生事例 エラーの解決方法
    200 GETの成功時
    401 1) APIが要求するAccess Tokenがない状態で呼び出しを行った場合
    2) APIが要求するAccess Tokenが有効ではない場合
    3) 認証をリクエストしたclient権限が有効でない場合
    有効なAccess Tokenを使用したリクエストであるかどうかを確認します。
    404 1) API URLの呼び出しに間違いがあった場合
    2) リソースが見つからない場合
    API Docsを参考にし、エンドポイントURLに間違いがないかを確認します。
    422 照会・処理リクエストの際において、使用された値が仕様で決まっている値と異なる場合
    1) 必須パラメーターの漏れがあった場合
    2) パラメーターの値が無効な形式(タイプ)であった場合
    API Docsを参考にし、必須パラメーターの入力漏れや無効な形式(タイプ)の値を使用したかどうかなどを確認します。
    429 クライアントのAPIリクエスト数が上限(1分あたり最大40件)を超えた場合 APIリクエスト数が上限を超えないよう、しばらく時間をおいてから再度リクエストを行います。
    500 内部サーバーエラー、不明なエラー Cafe24 Developersまでお問い合わせください。
    503 サーバーが過負荷でダウンした場合 Cafe24 Developersまでお問い合わせください。
    504 リクエストの処理に時間がかかり、タイムアウトとなった場合 一時的なエラーが発生したため、処理に時間がかかっている状態です。しばらく時間をおいてから再度お試しください。

    How to use GET API

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

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

    1. 検索条件の追加

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

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

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

    検索条件の追加
    例) 特定のショップ名に該当するショップの照会
    GET https://dcollection-api.cafe24.com/api/shops?shop_name=nelly
    
    例) 特定のショップ名および特定の属性に該当するショップの照会
    GET https://dcollection-api.cafe24.com/api/shops?shop_name=nelly&shop_properties=hartebeest
    
    例) 特定のカテゴリに該当する商品の照会
    GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802
    
    例) 特定のカテゴリおよび特定のショップ名に該当する商品の照会
    GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802&shop_name=안다르

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

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

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

    カンマ(,)を使用した複数の値の検索
    例) 特定のショップ名(複数指定可)に該当するショップの照会
    GET https://dcollection-api.cafe24.com/api/shops?shop_name=nelly,reseda
    
    例) 特定のカテゴリまたは特定の商品名(複数指定可)に該当する商品の照会
    GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802&product_name=안다르,에어쿨링

    3. Pagination

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

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

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

    Pagination
    예) 100点店舗を検索する場合
    GET https://dcollection-api.cafe24.com/api/shops?limit=100
     店舗
    예) 100点の商品を検索する場合
    GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802&limit=100
    
    예) 201番目から300番目までの店舗を検索する場合
    GET https://dcollection-api.cafe24.com/api/shops?limit=100&offset=200
    
    예) 201番目から300番目までの商品を検索する場合
    GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802&limit=100&offset=200

    API Limit

    dcollection APIは、LaravelミドルウェアのThrottle機能を使用し、1つのIPでは1分あたり最大40件のリクエストのみ実行できるよう、呼び出し件数の制限を設けています。

    呼び出し1回あたり1件の呼び出し可能件数が消費され、1分間で40回以上のリクエストがあった場合、429エラー(Too Many Request)が返されます。

    429エラーが返されないようにするには、Headerで「X-RateLimit–Limit」と「X-RateLimit–Remaining」を確認してください。

    X-Api-Call-Limit : 1/40

    Shop

    Shops

    Endpoints

    Shops properties

    Attribute Description
    dcollection_store_category

    D.Collectionショップ標準カテゴリ

    store_id

    ショップID

    shop_name

    ショップ名

    shop_no

    越境ECショップ番号

    shop_url

    ショップのメインドメイン

    shop_currency_code

    決済通貨

    KRW : ₩ ウォン
    USD : $ ドル
    JPY : ¥ 円
    PHP : ₱ ペソ

    shop_language

    ショップの言語

    ko_KR : 韓国語
    en_US : 英語
    zh_CN : 中国語(簡体字)
    zh_TW : 中国語(繁体字)
    ja_JP : 日本語
    vi_VN : ベトナム語

    shop_grade

    ショップの人気度

    black : 人気指数90以上
    purple : 人気指数80以上
    green : 人気指数70以上
    orange : 人気指数70未滿

    shop_popular_age

    ショップの人気度(年齢別)

    teenager : 10代
    twenties : 20代
    thirties : 30代
    forties : 40代
    etc : その他

    shop_sex

    ショップの人気度(性別)

    F : 女性
    M : 男性

    shop_region

    ショップの人気度(地域別)

    ソウル特別市
    京畿道
    仁川広域市
    江原道
    忠清北道
    世宗特別自治市
    忠清南道
    大田広域市
    慶尚北道
    大邱広域市
    蔚山広域市
    釜山広域市
    慶尚南道
    全羅北道
    全羅南道
    光州広域市
    済州特別自治道

    shop_tags

    ショップタグのコード

    social_logins

    SNSアカウント連携チャンネル

    facebook : Facebook
    kakao : Kakao
    naver : NAVER
    line : LINE
    google : Google
    apple : Apple

    use_cafe24pay

    Cafe24 Payを使用するかどうか

    true : 使用する
    false : 使用しない

    use_naverpay

    Naver Payを使用するかどうか

    true : 使用する
    false : 使用しない

    use_EMS

    郵便局EMSを使用するかどうか

    true : 使用する
    false : 使用しない

    shipping_fee_type

    ショップの基本送料タイプ

    T : 送料無料
    R : 固定送料を使用
    M : 購入金額によって課金
    D : 購入金額別送料を使用
    W : 商品の重量別送料を使用
    C : 商品の数量別送料を使用
    N : 商品の数量に比例して送料を課金
    E : 自動策定送料(EMS)使用
    F : 着払い

    benefits

    ショップで提供される特典タイプ

    DP : 期間限定割引
    DR : 再購入割引
    DQ : 大量購入割引
    DM : 会員割引
    DN : 新着商品割引
    DV : 送料割引
    PG : ノベルティ
    PB : 1+Nイベント

    global_payment_type

    ショップで提供される海外決済サービス

    AX : AXES
    EX : Eximbay
    PP : PayPal
    CG : WeChat Pay
    EY : ECPAY
    PW : Paymentwall

    created_date

    Date

    ショップ作成日

    updated_date

    Date

    ショップアップデート日

    Retrieve a list of stores

    GET

    基本スペック

    Property Description
    SCOPE ショップの読み取り権限 (dcollection.read_shop)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    dcollection_store_category

    D.Collectionショップ標準カテゴリ

    shop_name

    Array Max : [3]

    ショップ名

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

    store_id

    ショップID

    shop_no

    Array Max : [3]

    越境ECショップ番号

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

    shop_currency_code

    決済通貨

    KRW : ₩ ウォン
    USD : $ ドル
    JPY : ¥ 円
    PHP : ₱ ペソ

    shop_language

    ショップの言語

    ko_KR : 韓国語
    en_US : 英語
    zh_CN : 中国語(簡体字)
    zh_TW : 中国語(繁体字)
    ja_JP : 日本語
    vi_VN : ベトナム語

    shop_grade

    ショップの人気度

    black : 人気指数90以上
    purple : 人気指数80以上
    green : 人気指数70以上
    orange : 人気指数70未滿

    shop_popular_age

    ショップの人気度(年齢別)

    teenager : 10代
    twenties : 20代
    thirties : 30代
    forties : 40代
    etc : その他

    shop_sex

    ショップの人気度(性別)

    F : 女性
    M : 男性

    shop_region

    ショップの人気度(地域別)

    ソウル特別市
    京畿道
    仁川広域市
    江原道
    忠清北道
    世宗特別自治市
    忠清南道
    大田広域市
    慶尚北道
    大邱広域市
    蔚山広域市
    釜山広域市
    慶尚南道
    全羅北道
    全羅南道
    光州広域市
    済州特別自治道

    shop_tags

    Array Max : [10]

    ショップタグ

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

    use_cafe24pay

    Cafe24 Payを使用するかどうか

    true : 使用する
    false : 使用しない

    use_naverpay

    Naver Payを使用するかどうか

    true : 使用する
    false : 使用しない

    use_EMS

    郵便局EMSを使用するかどうか

    true : 使用する
    false : 使用しない

    social_logins

    SNSアカウント連携チャンネル

    facebook : Facebook
    kakao : Kakao
    naver : NAVER
    line : LINE
    google : Google
    apple : Apple

    shipping_fee_type

    ショップの基本送料タイプ

    T : 送料無料
    R : 固定送料を使用
    M : 購入金額によって課金
    D : 購入金額別送料を使用
    W : 商品の重量別送料を使用
    C : 商品の数量別送料を使用
    N : 商品の数量に比例して送料を課金
    E : 自動策定送料(EMS)使用
    F : 着払い

    benefits

    ショップで提供される特典タイプ

    DP : 期間限定割引
    DR : 再購入割引
    DQ : 大量購入割引
    DM : 会員割引
    DN : 新着商品割引
    DV : 送料割引
    PG : ノベルティ
    PB : 1+Nイベント

    global_payment_type

    ショップで提供される海外決済サービス

    AX : AXES
    EX : Eximbay
    PP : PayPal
    CG : WeChat Pay
    EY : ECPAY
    PW : Paymentwall

    created_start_date

    Date

    ショップ作成日検索の開始値

    created_end_date

    Date

    ショップ作成日検索の終了値

    limit

    Min : [1]~Max : [100]

    照会結果の最大件数

    DEFAULT 10

    offset

    Min : [0]~Max : [5000]

    照会結果の開始位置

    DEFAULT 0

    sort

    ソート順の値

    created_date : ショップ作成日
    shop_name : ショップ名

    order

    ソート順

    asc : 昇順
    desc : 降順

    Retrieve a list of stores
    Request Copy
    Response Copy

    Product

    Products

    Products properties

    Attribute Description
    dcollection_product_category

    D.Collection商品標準カテゴリ

    product_ukey

    商品の固有キー

    shop_name

    ショップ名

    store_id

    ショップID

    shop_no

    越境ECショップ番号

    shop_grade

    ショップの人気度

    black : 人気指数90以上
    purple : 人気指数80以上
    green : 人気指数70以上
    orange : 人気指数70未滿

    shop_language

    ショップの言語

    ko_KR : 韓国語
    en_US : 英語
    zh_CN : 中国語(簡体字)
    zh_TW : 中国語(繁体字)
    ja_JP : 日本語
    vi_VN : ベトナム語

    shop_currency_code

    決済通貨

    KRW : ₩ ウォン
    USD : $ ドル
    JPY : ¥ 円
    PHP : ₱ ペソ

    product_name

    商品名

    product_no

    商品番号

    product_code

    商品コード

    product_url

    商品ページのURL

    product_status_type

    商品ステータス

    N : 新品
    B : 返品品
    R : 在庫品
    U : 中古品
    E : 展示品
    F : メーカー再生品
    S : キズあり品

    price

    商品販売価格

    pc_discount_price

    割引販売価格(PC割引適用時)

    mobile_discount_price

    割引販売価格(モバイル割引適用時)

    is_pc_discount

    PC割引の適用対象であるかどうか

    true : 使用する
    false : 使用しない

    is_mobile_discount

    モバイル割引の適用対象であるかどうか

    true : 使用する
    false : 使用しない

    pc_discount_rate

    PC割引率

    mobile_discount_rate

    モバイル割引率

    is_free_shipping

    送料無料商品であるかどうか

    true : 使用する
    false : 使用しない

    is_international_shipping

    海外配送の可否

    true : 使用する
    false : 使用しない

    international_shipping_country

    商品の配送が可能な海外の国・地域

    is_free_gift

    ノベルティを提供するかどうか

    true : 使用する
    false : 使用しない

    is_coupon_discount

    割引クーポンを提供するかどうか

    true : 使用する
    false : 使用しない

    product_options

    商品オプション

    brand_name

    ブランド名

    product_standard_tags

    D.Collectionから提供される商品標準タグ

    product_popular_age

    商品の人気度(年齢別)

    teenager : 10代
    twenties : 20代
    thirties : 30代
    forties : 40代
    etc : その他

    detail_image

    詳細画像のURL

    list_image

    一覧画像のURL

    tiny_image

    縮小一覧画像のURL

    small_image

    縮小画像のURL

    review_count

    商品レビュー数

    review_score

    商品レビューの評価

    hits_count

    PV(ページビュー)数

    expiration_date

    Date

    商品の有効期限

    created_date

    Date

    商品作成日

    updated_date

    Date

    商品アップデート日

    Retrieve a list of products

    GET

    基本スペック

    Property Description
    SCOPE 商品の読み取り権限 (dcollection.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    dcollection_product_category
    Required

    D.Collection商品標準カテゴリ

    product_ukey

    Array Max : [100]

    商品の固有キー

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

    shop_name

    Array Max : [3]

    ショップ名

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

    store_id

    ショップID

    shop_no

    Array Max : [3]

    越境ECショップ番号

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

    shop_grade

    Array Max : [4]

    ショップの人気度

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

    black : 人気指数90以上
    purple : 人気指数80以上
    green : 人気指数70以上
    orange : 人気指数70未滿

    shop_language

    ショップの言語

    ko_KR : 韓国語
    en_US : 英語
    zh_CN : 中国語(簡体字)
    zh_TW : 中国語(繁体字)
    ja_JP : 日本語
    vi_VN : ベトナム語

    shop_currency_code

    決済通貨

    KRW : ₩ ウォン
    USD : $ ドル
    JPY : ¥ 円
    PHP : ₱ ペソ

    product_name

    Array Max : [3]

    商品名

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

    product_no

    Array Max : [3]

    商品番号

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

    product_status_type

    商品ステータス

    N : 新品
    B : 返品品
    R : 在庫品
    U : 中古品
    E : 展示品
    F : メーカー再生品
    S : キズあり品

    price_min

    商品販売価格検索の開始値

    price_max

    商品販売価格検索の終了値

    is_pc_discount

    PC割引の適用対象であるかどうか

    true : 使用する
    false : 使用しない

    is_mobile_discount

    モバイル割引の適用対象であるかどうか

    true : 使用する
    false : 使用しない

    pc_discount_price_min

    割引販売価格(PC割引適用時)検索の最小値

    pc_discount_price_max

    割引販売価格(PC割引適用時)検索の最大値

    mobile_discount_price_min

    割引販売価格(モバイル割引適用時)検索の最小値

    mobile_discount_price_max

    割引販売価格(モバイル割引適用時)検索の最大値

    pc_discount_rate_min

    PC割引率の最小値

    pc_discount_rate_max

    PC割引率の最大値

    mobile_discount_rate_min

    モバイル割引率の最小値

    mobile_discount_rate_max

    モバイル割引率の最大値

    is_free_shipping

    送料無料商品であるかどうか

    true : 使用する
    false : 使用しない

    is_international_shipping

    海外配送の可否

    true : 使用する
    false : 使用しない

    international_shipping_country

    商品の配送が可能な海外の国・地域

    is_free_gift

    ノベルティを提供するかどうか

    true : 使用する
    false : 使用しない

    is_coupon_discount

    割引クーポンを提供するかどうか

    true : 使用する
    false : 使用しない

    review_count_min

    商品レビュー数の最小値

    review_count_max

    商品レビュー数の最大値

    review_score_min

    Min : [0]~Max : [5]

    商品レビューの評価の最小値

    review_score_max

    Min : [0]~Max : [5]

    商品レビューの評価の最大値

    brand_name

    ブランド名

    product_standard_tags

    D.Collectionから提供される商品標準タグ

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

    product_popular_age

    商品の人気度(年齢別)

    teenager : 10代
    twenties : 20代
    thirties : 30代
    forties : 40代
    etc : その他

    created_start_date

    Date

    商品作成日検索の開始値

    created_end_date

    Date

    商品作成日検索の終了値

    updated_start_date

    Date

    商品アップデート日検索の開始値

    updated_end_date

    Date

    商品アップデート日検索の終了値

    limit

    Min : [1]~Max : [100]

    照会結果の最大件数

    DEFAULT 10

    offset

    Min : [0]~Max : [5000]

    照会結果の開始位置

    DEFAULT 0

    sort

    ソート順の値

    mobile_discount_price : 割引販売価格(モバイル割引適用時)
    pc_discount_price : 割引販売価格(PC割引適用時)
    mobile_discount_rate : モバイル割引率
    pc_discount_rate : PC割引率
    price : 商品販売価格
    created_date : 商品作成日
    product_name : 商品名
    review_count : 商品レビュー数
    review_score : 商品レビューの評価
    hits_count : PV(ページビュー)数
    popularity_score : 人気指数

    order

    ソート順

    asc : 昇順
    desc : 降順

    Retrieve a list of products
    Request Copy
    Response Copy

    Retrieve the number of product items

    GET

    基本スペック

    Property Description
    SCOPE 商品の読み取り権限 (dcollection.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    dcollection_product_category
    Required

    D.Collection商品標準カテゴリ

    product_ukey

    Array Max : [100]

    商品の固有キー

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

    shop_name

    Array Max : [3]

    ショップ名

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

    store_id

    ショップID

    shop_no

    Array Max : [3]

    越境ECショップ番号

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

    shop_grade

    Array Max : [4]

    ショップの人気度

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

    black : 人気指数90以上
    purple : 人気指数80以上
    green : 人気指数70以上
    orange : 人気指数70未滿

    shop_language

    ショップの言語

    ko_KR : 韓国語
    en_US : 英語
    zh_CN : 中国語(簡体字)
    zh_TW : 中国語(繁体字)
    ja_JP : 日本語
    vi_VN : ベトナム語

    shop_currency_code

    決済通貨

    KRW : ₩ ウォン
    USD : $ ドル
    JPY : ¥ 円
    PHP : ₱ ペソ

    product_name

    Array Max : [3]

    商品名

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

    product_no

    Array Max : [3]

    商品番号

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

    product_status_type

    商品ステータス

    N : 新品
    B : 返品品
    R : 在庫品
    U : 中古品
    E : 展示品
    F : メーカー再生品
    S : キズあり品

    price_min

    商品販売価格検索の開始値

    price_max

    商品販売価格検索の終了値

    is_pc_discount

    PC割引の適用対象であるかどうか

    true : 使用する
    false : 使用しない

    is_mobile_discount

    モバイル割引の適用対象であるかどうか

    true : 使用する
    false : 使用しない

    pc_discount_price_min

    割引販売価格(PC割引適用時)検索の最小値

    pc_discount_price_max

    割引販売価格(PC割引適用時)検索の最大値

    mobile_discount_price_min

    割引販売価格(モバイル割引適用時)検索の最大値

    mobile_discount_price_max

    割引販売価格(モバイル割引適用時)検索の最大値

    pc_discount_rate_min

    PC割引率の最小値

    pc_discount_rate_max

    PC割引率の最大値

    mobile_discount_rate_min

    モバイル割引率の最小値

    mobile_discount_rate_max

    モバイル割引率の最大値

    is_free_shipping

    送料無料商品であるかどうか

    true : 使用する
    false : 使用しない

    is_international_shipping

    海外配送の可否

    true : 使用する
    false : 使用しない

    international_shipping_country

    商品の配送が可能な海外の国・地域

    is_free_gift

    ノベルティを提供するかどうか

    true : 使用する
    false : 使用しない

    is_coupon_discount

    割引クーポンを提供するかどうか

    true : 使用する
    false : 使用しない

    review_count_min

    商品レビュー数の最小値

    review_count_max

    商品レビュー数の最大値

    review_score_min

    Min : [0]~Max : [5]

    商品レビューの評価の最小値

    review_score_max

    Min : [0]~Max : [5]

    商品レビューの評価の最大値

    brand_name

    ブランド名

    product_standard_tags

    D.Collectionから提供される商品標準タグ

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

    product_popular_age

    商品の人気度(年齢別)

    teenager : 10代
    twenties : 20代
    thirties : 30代
    forties : 40代
    etc : その他

    created_start_date

    Date

    商品作成日検索の開始値

    created_end_date

    Date

    商品作成日検索の終了値

    updated_start_date

    Date

    商品アップデート日検索の開始値

    updated_end_date

    Date

    商品アップデート日検索の終了値

    Retrieve the number of product items
    Request Copy
    Response Copy

    Products standardtags

    Products standardtags properties

    Attribute Description
    standard_tag_key

    標準タグキー

    standard_tag_values

    標準タグ値

    Retrieve a list of product tag properties

    GET

    基本スペック

    Property Description
    SCOPE 商品の読み取り権限 (dcollection.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    limit

    Min : [1]~Max : [100]

    照会結果の最大件数

    DEFAULT 10

    offset

    Min : [0]~Max : [5000]

    照会結果の開始位置

    DEFAULT 0

    Retrieve a list of product tag properties
    Request Copy
    Response Copy

    Storeproducts

    Storeproducts properties

    Attribute Description
    dcollection_product_category

    D.Collection商品標準カテゴリ

    product_ukey

    商品の固有キー

    shop_name

    ショップ名

    store_id

    ショップID

    shop_no

    越境ECショップ番号

    shop_grade

    ショップの人気度

    black : 人気指数90以上
    purple : 人気指数80以上
    green : 人気指数70以上
    orange : 人気指数70未滿

    shop_language

    ショップの言語

    ko_KR : 韓国語
    en_US : 英語
    zh_CN : 中国語(簡体字)
    zh_TW : 中国語(繁体字)
    ja_JP : 日本語
    vi_VN : ベトナム語

    shop_currency_code

    決済通貨

    KRW : ₩ ウォン
    USD : $ ドル
    JPY : ¥ 円
    PHP : ₱ ペソ

    product_name

    商品名

    product_no

    商品番号

    product_code

    商品コード

    product_url

    商品ページのURL

    product_status_type

    商品ステータス

    N : 新品
    B : 返品品
    R : 在庫品
    U : 中古品
    E : 展示品
    F : メーカー再生品
    S : キズあり品

    price

    商品販売価格

    pc_discount_price

    割引販売価格(PC割引適用時)

    mobile_discount_price

    割引販売価格(モバイル割引適用時)

    is_pc_discount

    PC割引の適用対象であるかどうか

    true : 使用する
    false : 使用しない

    is_mobile_discount

    モバイル割引の適用対象であるかどうか

    true : 使用する
    false : 使用しない

    pc_discount_rate

    PC割引率

    mobile_discount_rate

    モバイル割引率

    is_free_shipping

    送料無料商品であるかどうか

    true : 使用する
    false : 使用しない

    is_international_shipping

    海外配送の可否

    true : 使用する
    false : 使用しない

    international_shipping_country

    商品の配送が可能な海外の国・地域

    is_free_gift

    ノベルティを提供するかどうか

    true : 使用する
    false : 使用しない

    is_coupon_discount

    割引クーポンを提供するかどうか

    true : 使用する
    false : 使用しない

    product_options

    商品オプション

    brand_name

    ブランド名

    product_standard_tags

    D.Collectionから提供される商品標準タグ

    product_popular_age

    商品の人気度(年齢別)

    teenager : 10代
    twenties : 20代
    thirties : 30代
    forties : 40代
    etc : その他

    detail_image

    詳細画像のURL

    list_image

    一覧画像のURL

    tiny_image

    縮小一覧画像のURL

    small_image

    縮小画像のURL

    review_count

    商品レビュー数

    review_score

    商品レビューの評価

    hits_count

    PV(ページビュー)数

    expiration_date

    Date

    商品の有効期限

    created_date

    Date

    商品作成日

    updated_date

    Date

    商品アップデート日

    Retrieve a list of products with mall ID

    GET

    基本スペック

    Property Description
    SCOPE 商品の読み取り権限 (dcollection.read_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    store_id
    Required

    ショップID

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

    shop_name

    Array Max : [3]

    ショップ名

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

    shop_no

    Array Max : [3]

    越境ECショップ番号

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

    product_name

    商品名

    product_status_type

    商品ステータス

    N : 新品
    B : 返品品
    R : 在庫品
    U : 中古品
    E : 展示品
    F : メーカー再生品
    S : キズあり品

    price_min

    商品販売価格検索の開始値

    price_max

    商品販売価格検索の終了値

    is_pc_discount

    PC割引の適用対象であるかどうか

    true : 使用する
    false : 使用しない

    is_mobile_discount

    モバイル割引の適用対象であるかどうか

    true : 使用する
    false : 使用しない

    pc_discount_price_min

    割引販売価格(PC割引適用時)検索の最小値

    pc_discount_price_max

    割引販売価格(PC割引適用時)検索の最大値

    mobile_discount_price_min

    割引販売価格(モバイル割引適用時)検索の最小値

    mobile_discount_price_max

    割引販売価格(モバイル割引適用時)検索の最大値

    pc_discount_rate_min

    PC割引率の最小値

    pc_discount_rate_max

    PC割引率の最大値

    mobile_discount_rate_min

    モバイル割引率の最小値

    mobile_discount_rate_max

    モバイル割引率の最大値

    is_free_shipping

    送料無料商品であるかどうか

    true : 使用する
    false : 使用しない

    is_international_shipping

    海外配送の可否

    true : 使用する
    false : 使用しない

    international_shipping_country

    商品の配送が可能な海外の国・地域

    is_free_gift

    ノベルティを提供するかどうか

    true : 使用する
    false : 使用しない

    is_coupon_discount

    割引クーポンを提供するかどうか

    true : 使用する
    false : 使用しない

    review_count_min

    商品レビュー数の最小値

    review_count_max

    商品レビュー数の最大値

    review_score_min

    Min : [0]~Max : [5]

    商品レビューの評価の最小値

    review_score_max

    Min : [0]~Max : [5]

    商品レビューの評価の最大値

    brand_name

    ブランド名

    product_popular_age

    商品の人気度(年齢別)

    teenager : 10代
    twenties : 20代
    thirties : 30代
    forties : 40代
    etc : その他

    created_start_date

    Date

    商品作成日検索の開始値

    created_end_date

    Date

    商品作成日検索の終了値

    updated_start_date

    Date

    商品アップデート日検索の開始値

    updated_end_date

    Date

    商品アップデート日検索の終了値

    limit

    Min : [1]~Max : [100]

    照会結果の最大件数

    DEFAULT 10

    offset

    Min : [0]~Max : [5000]

    照会結果の開始位置

    DEFAULT 0

    sort

    ソート順の値

    mobile_discount_price : 割引販売価格(モバイル割引適用時)
    pc_discount_price : 割引販売価格(PC割引適用時)
    mobile_discount_rate : モバイル割引率
    pc_discount_rate : PC割引率
    price : 商品販売価格
    created_date : 商品作成日
    product_name : 商品名
    review_count : 商品レビュー数
    review_score : 商品レビューの評価
    hits_count : PV(ページビュー)数
    popularity_score : 人気指数

    DEFAULT mobile_discount_price

    order

    ソート順

    asc : 昇順
    desc : 降順

    DEFAULT asc

    Retrieve a list of products with mall ID
    Request Copy
    Response Copy
    Top