NAV Navbar
shell
  • Introduction
  • Authentication
  • Appstore orders
  • Appstore payments
  • Brands
  • Categories
  • Classifications
  • Coupons
  • Coupons issue
  • Currency
  • Customergroup
  • Customers
  • Customers memos
  • Customers reviews
  • Customersprivacy
  • Dashboard
  • Mains
  • Mains products
  • Manufacturers
  • Mileage
  • Orders
  • Orders buyer
  • Orders items
  • Orders receivers
  • Origin
  • Products
  • Products approve
  • Products cart
  • Products decorationimages
  • Products discountprice
  • Products hits
  • Products icons
  • Products images
  • Products memos
  • Products options
  • Products seo
  • Products tags
  • Products variants
  • Products variants inventories
  • Reports salesvolume
  • Reviews
  • Reviews comments
  • Scripttags
  • Shops
  • Sms
  • Sms senders
  • Store
  • Suppliers
  • Suppliers users
  • Themes
  • Trends
  • Users
  • Codes
  • 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を使用することができます。

    Admin API Intro

    使用例

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

    Admin API

    Admin APIはショップの管理者によるショップ情報の検索、生成、修正、削除に適合しています。Admin APIはEntityの情報の大半を検索することができ、OAuth2.0方式の別途認証をパスした場合のみ使用できます。

    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の余裕分を確認することができます。

    Authentication

    Get Authentication Code

    トークン発行要求時に使われたcodeは再使用できず、コード発行後1分が経過すると満了します。

    例示コード(要求)

    GET 'https://{mallid}.cafe24api.com/api/v2/oauth/authorize?response_type=code&client_id={client_id}&state={state}&redirect_uri={redirect_uri}&scope={scope}'
    

    例示コード(応答)

    HTTP/1.1 302 Found
    Location: {redirect_uri}?code={authorize_code}&state={state}
    

    アクセストークンの発行のためにはまずアクセスコードを要求しなければなりません。アクセスコードはクライアントがウェブアプリケーションの形態である場合に利用されます。コードの要求はcURLではなくウェブブラウザーで行わなければなりません。

    詳細

    Get Access Token

    発行された認証コードを使用し、実際にAPIの呼び出しができるユーザートークン(Access Token、Refresh Token)をもらうことができます。

    例示コード(要求)

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/oauth/token' \
      -H 'Authorization: Basic {base64_encode({client_id}:{client_secret})}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -d 'grant_type=authorization_code' \
      -d 'code={code}' \
      -d 'redirect_uri={redirect_uri}'
    

    例示コード(応答)

    HTTP/1.1 200 OK
    {
        "access_token": "0iqR5nM5EJIq.......",
        "expires_at": "2017-10-19T19:17:57.902",
        "refresh_token": "Cuq6H1WLKBxqqf.......",
        "client_id": "BrIfqEKoP.......",
        "mall_id": "yourmall",
        "user_id": "test",
        "scopes": [
            "mall.read_order",
            "mall.read_product",
            "mall.read_store",
            "...etc...",
        ],
        "issued_at": "2017-10-19T17:17:57.911"
    }
    

    access_token: アクセストークンで、クライアントがリソースサーバーにアクセスする時に使われます。

    refresh_token: アクセストークン満了後に再発行するために使うトークンです。

    詳細

    Get Access Token using refresh token

    アクセストークンは発行後2時間が経過すると使えません。リソースサーバーにアクセスするためにはアクセストークン満了後に再発行が必要です。すでにアクセストークンが発行された場合はrefresh_tokenを使ってアクセストークンの再発行が可能です。

    refresh tokenは2週間有効で、refresh token満了前に要求すると更新されたaccess tokenと更新されたrefresh tokenが一緒に返還されます。既存のrefresh tokenは満了処理され、使用できません。

    発行された認証コードを使って実際にAPIの呼び出しができるユーザートークン(Access Token、Refresh Token)をもらうことができます。

    例示コード(要求)

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/oauth/token' \
      -H 'Authorization: Basic {base64_encode({client_id}:{client_secret})}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -d 'grant_type=refresh_token' \
      -d 'refresh_token={refresh_token}'
    

    例示コード(応答)

    HTTP/1.1 200 OK
    {
        "access_token": "0iqR5nM5EJIq.......",
        "expires_at": "2017-10-19T19:17:57.902",
        "refresh_token": "Cuq6H1WLKBxqqf.......",
        "client_id": "BrIfqEKoP.......",
        "mall_id": "yourmall",
        "user_id": "test",
        "scopes": [
            "mall.read_order",
            "mall.read_product",
            "mall.read_store",
            "...etc...",
        ],
        "issued_at": "2017-10-19T17:17:57.911"
    }
    

    access_token : アクセストークンで、クライアントがリソースサーバーにアクセスする時に使われます。

    refresh_token : アクセストークン満了後に再発行するために使うトークンです。

    詳細

    Appstore orders

    cafe24 App Storeの注文生成APIでショップの運営者に決済時必要な金額を払わせるためにcafe24 App Storeの注文を生成することができます。

    Appstore orders properties

    Attribute Description
    order_id

    注文ID

    cafe24 App Store注文の注文ID

    order_name

    注文名

    cafe24 App Store注文の注文名。注文生成時に指定可能で、ユーザーが決済時にその決済の内容が分かるようなものでなければならない。

    order_amount

    注文金額

    cafe24 App Store注文生成時に決済を要求した注文金額

    return_url

    Return Url

    ユーザーが決済後に移動するページ

    automatic_payment

    Max Length : [1]

    定期課金の有無

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

    created_date

    timezone

    注文生成日

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

    confirmation_url

    決済URL

    ユーザーが決済するために自動的に移動するページのアドレス

    Get an appstore order

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/appstore/orders/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/appstore/orders/cafe24-20180704-100000000' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "order": {
            "order_id": "cafe24-20180704-100000000",
            "order_name": "App Name_Appstore Order Name",
            "order_amount": "1000.00",
            "return_url": "https:\/\/sample_shop.cafe24.com",
            "automatic_payment": "F",
            "created_date": "2018-07-04T13:52:49+09:00"
        }
    }
    

    基本スペック

    Property Description
    SCOPE アプリ 閲覧権限 (READ_APPLICATION)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    order_id
    Required

    注文番号

    検索したいcafe24 App Store注文番号

    Create an appstore order

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/appstore/orders'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/appstore/orders' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "order_name": "Appstore Order Name",
            "order_amount": "1000.00",
            "return_url": "https:\/\/sample_shop.cafe24.com",
            "automatic_payment": "F"
        }
    }'
    

    Response example:

    {
        "order": {
            "order_id": "cafe24-20180704-100000000",
            "order_name": "Appstore Order Name",
            "order_amount": "1000.00",
            "return_url": "https:\/\/sample_shop.cafe24.com",
            "automatic_payment": "F",
            "confirmation_url": "https:\/\/samplemall.cafe24.com\/disp\/common\/myapps\/order?signature=BAhpBBMxojw%3D--d1c0134218f0ff3c0f57cb3b57bcc34e6f170727"
        }
    }
    

    基本スペック

    Property Description
    SCOPE アプリ 投稿権限 (WRITE_APPLICATION)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    order_name
    Required

    Max Length : [100]

    注文名

    cafe24 App Store注文の注文名。注文生成時に指定可能で、ユーザーが決済時にその決済の内容が分かるようなものでなければならない。

    order_amount
    Required

    注文金額

    ユーザーに決済してもらう注文金額を入力

    return_url
    Required

    Max Length : [250]

    Return URL

    ユーザーが決済後に移動するページ。決済完了ページのアドレスを入力する。

    automatic_payment

    Max Length : [1]

    定期課金の有無

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

    DEFAULT F

    Appstore payments

    cafe24 App Storeでの注文の決済を完了した場合、cafe24 App Storeの決済検索機能を使って決済の内訳を確認することができます。

    Appstore payments properties

    Attribute Description
    order_id

    決済番号

    cafe24 App Store注文の注文ID

    title

    注文名

    cafe24 App Store注文の注文名。注文生成時に指定可能で、ユーザーが決済時にその決済の内容が分かるようなものでなければならない。

    approval_no

    承認番号

    決済承認番号

    payment_gateway_name

    決済代行会社名

    payment_method

    決済方法

    payment_amount

    決済金額

    currency

    通貨単位

    locale_code

    決済先の国

    pay_date

    timezone

    決済承認日

    List all appstore payments

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/appstore/payments'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/appstore/payments?start_date=2018-04-06&end_date=2018-07-05' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "payments": [
            {
                "order_id": "cafe24-20180704-100000000",
                "title": "App Name_App Store Order1",
                "approval_no": "10000000",
                "payment_gateway_name": "allat",
                "payment_method": "card",
                "payment_amount": "1000.00",
                "currency": "KRW",
                "locale_code": "ko_KR",
                "pay_date": "2018-07-04T11:19:27+09:00"
            },
            {
                "order_id": "cafe24-20180704-200000000",
                "title": "App Name_App Store Order2",
                "approval_no": "20000000",
                "payment_gateway_name": "allat",
                "payment_method": "card",
                "payment_amount": "1000.00",
                "currency": "KRW",
                "locale_code": "ko_KR",
                "pay_date": "2018-07-04T11:19:27+09:00"
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE アプリ 閲覧権限 (READ_APPLICATION)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    order_id

    注文番号

    検索したいcafe24 App Store注文番号

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

    start_date
    Required

    Date
    timezone

    検索開始日

    該当日以後に決済完了した注文検索

    end_date
    Required

    Date
    timezone

    検索終了日

    該当日以前に決済完了した注文検索

    limit

    Max : [50]

    検索結果の最大件数

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

    DEFAULT 20

    offset

    Max : [10000]

    検索結果の開始位置

    検索結果の開始位置

    Count all appstore payments

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/appstore/payments/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/appstore/payments/count?start_date=2018-04-06&end_date=2018-07-05' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    基本スペック

    Property Description
    SCOPE アプリ 閲覧権限 (READ_APPLICATION)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    order_id

    注文番号

    検索したいcafe24 App Store注文番号

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

    start_date
    Required

    Date
    timezone

    検索開始日

    該当日以後に決済完了した注文検索

    end_date
    Required

    Date
    timezone

    検索終了日

    該当日以前に決済完了した注文検索

    Brands

    ブランド(Brands)は商品の「製作情報」の中でブランドに入力する情報を意味します。ブランドはショップの商品を区分する販売カテゴリの一つで、商品は必ず一つのブランドを持っています(指定しない場合は「独自ブランド」を使う)。
    ブランド(Brands)の{#id}は「brand_code」です。

    Brands properties

    Attribute Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    brand_code

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

    ブランドコード

    brand_name

    Max Length : [50]

    ブランド名

    use_brand

    ブランドの使用有無

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

    created_date

    作成日

    product_count

    商品数

    List all brands

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/brands'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/brands' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "brands": [
            {
                "shop_no": 1,
                "brand_code": "B0000000",
                "brand_name": "Default Brand",
                "use_brand": "T",
                "created_date": "2018-01-01",
                "product_count": 2
            },
            {
                "shop_no": 1,
                "brand_code": "B000000A",
                "brand_name": "Default Brand",
                "use_brand": "F",
                "created_date": "2018-01-02",
                "product_count": 3
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 販売カテゴリ 閲覧権限 (READ_COLLECTION)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    brand_code

    ブランドコード

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

    brand_name

    ブランド名

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

    use_brand

    ブランドの使用有無

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

    limit

    Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    Count all brands

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/brands/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/brands/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    基本スペック

    Property Description
    SCOPE 販売カテゴリ 閲覧権限 (READ_COLLECTION)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    brand_code

    ブランドコード

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

    brand_name

    ブランド名

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

    use_brand

    ブランドの使用有無

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

    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]

    カテゴリ名

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

    display_type

    ショップの表示設定

    商品カテゴリをPCショップとモバイルショップ、両方に表示するかどうかを設定

    A:PC + モバイル
    P:PC
    M:モバイル
    F:両方とも使用しない

    full_category_name

    カテゴリ全体の名前

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

    full_category_no

    全てのカテゴリ番号

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

    root_category_no

    最上位カテゴリ番号

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

    use_main

    メインカテゴリの表示ステータス

    商品カテゴリがショップのトップページに表示されるかどうかの有無。メインカテゴリに表示する場合は中/小/細カテゴリも大カテゴリのように最上位に表示される。

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

    use_display

    表示ステータス

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

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

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

    display_order

    表示順序

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

    soldout_product_display

    在庫切れ商品の表示

    在庫切れ商品を商品カテゴリの一番前に表示するか、一番後ろに表示するかの設定
    商品の在庫切れステータスはList all productsのsold_outパラメーターで分かる。

    B:在庫切れ商品を一番後ろに
    F:在庫切れ商品を一番前に
    N:在庫切れ商品関係なし

    sub_category_product_display

    下位カテゴリ商品の表示

    現在の商品カテゴリの下位カテゴリに表示されている商品まで含めて表示するか否かの設定

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

    hashtag_product_display

    キュレーションハッシュタグ商品の表示

    ハッシュタグ商品表示機能の使用設定

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

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

    hash_tags

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

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

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

    product_display_scope

    商品カテゴリの表示エリアの区分

    商品カテゴリに商品を一括表示するか、エリア別に表示するかの設定

    「すべて」に設定された場合、次の項目で表示設定ができる。
    product_display_type
    product_display_key
    product_display_sort
    product_display_period

    「エリア別」に設定された場合、次の項目でエリア別に表示設定ができる。
    normal_product_display_type
    normal_product_display_key
    normal_product_display_sort
    normal_product_display_period
    recommend_product_display_type
    recommend_product_display_key
    recommend_product_display_sort
    recommend_product_display_period
    new_product_display_type
    new_product_display_key
    new_product_display_sort
    new_product_display_period

    A:すべて
    G:エリア別

    product_display_type

    商品カテゴリの表示方法

    商品カテゴリ表示エリアの設定が「すべて」の場合、その商品カテゴリの表示方法

    A:自動並べ替え
    U:ユーザー指定
    M:自動並べ替え+ユーザー指定

    product_display_key

    商品カテゴリの表示方法キー

    商品カテゴリ表示エリアの設定が「すべて」で、商品カテゴリの表示方法が「自動表示」または「自動表示+使用者指定」の場合、その商品カテゴリをどのような基準で表示するかの設定

    A:最近追加された商品
    R:最近登録された商品
    U:最近修正された商品
    N:商品名五十音順
    P:販売価格が高い商品
    S:販売数の多い商品
    C:閲覧数の多い商品
    L:いいねが多い商品

    product_display_sort

    商品カテゴリの表示方法の順序

    商品カテゴリの表示方法を降順にするか、昇順にするかの設定

    D:降順
    A:昇順

    product_display_period

    表示順序に対する期間

    表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間

    W:すべての期間
    1D:1日
    3D:3日
    7D:7日
    15D:15日
    1M:1カ月
    3M:3カ月
    6M:6カ月

    normal_product_display_type

    商品カテゴリの表示方法

    商品カテゴリ表示エリアの設定が「エリア別」の場合、一般商品エリアの表示方法

    A:自動並べ替え
    U:ユーザー指定
    M:自動並べ替え+ユーザー指定

    normal_product_display_key

    商品カテゴリの表示方法キー

    商品カテゴリ表示エリアの設定が「エリア別」の場合、一般商品エリアをどのような基準で表示するかの設定

    A:最近追加された商品
    R:最近登録された商品
    U:最近修正された商品
    N:商品名五十音順
    P:販売価格が高い商品
    S:販売数の多い商品
    C:閲覧数の多い商品
    L:いいねが多い商品

    normal_product_display_sort

    商品カテゴリの表示方法の順序

    一般商品エリアの表示方法を降順にするか、昇順にするかの設定

    D:降順
    A:昇順

    normal_product_display_period

    表示順序に対する期間

    一般商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間

    W:すべての期間
    1D:1日
    3D:3日
    7D:7日
    15D:15日
    1M:1カ月
    3M:3カ月
    6M:6カ月

    recommend_product_display_type

    商品カテゴリの表示方法

    商品カテゴリ表示エリアの設定が「エリア別」の場合、おすすめ商品エリアの表示方法

    A:自動並べ替え
    U:ユーザー指定
    M:自動並べ替え+ユーザー指定

    recommend_product_display_key

    商品カテゴリの表示方法キー

    商品カテゴリ表示エリアの設定が「エリア別」の場合、おすすめ商品エリアをどのような基準で表示するかの設定

    A:最近追加された商品
    R:最近登録された商品
    U:最近修正された商品
    N:商品名五十音順
    P:販売価格が高い商品
    S:販売数の多い商品
    C:閲覧数の多い商品
    L:いいねが多い商品

    recommend_product_display_sort

    商品カテゴリの表示方法の順序

    おすすめ商品エリアの表示方法を降順にするか、昇順にするかの設定

    D:降順
    A:昇順

    recommend_product_display_period

    表示順序に対する期間

    おすすめ商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間

    W:すべての期間
    1D:1日
    3D:3日
    7D:7日
    15D:15日
    1M:1カ月
    3M:3カ月
    6M:6カ月

    new_product_display_type

    商品カテゴリの表示方法

    商品カテゴリ表示エリアの設定が「エリア別」の場合、新着商品エリアの表示方法

    A:自動並べ替え
    U:ユーザー指定
    M:自動並べ替え+ユーザー指定

    new_product_display_key

    商品カテゴリの表示方法キー

    商品カテゴリ表示エリアの設定が「エリア別」の場合、新着商品エリアをどのような基準で表示するかの設定

    A:最近追加された商品
    R:最近登録された商品
    U:最近修正された商品
    N:商品名五十音順
    P:販売価格が高い商品
    S:販売数の多い商品
    C:閲覧数の多い商品
    L:いいねが多い商品

    new_product_display_sort

    商品カテゴリの表示方法の順序

    新着商品エリアの表示方法を降順にするか、昇順にするかの設定

    D:降順
    A:昇順

    new_product_display_period

    表示順序に対する期間

    新着商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間

    W:すべての期間
    1D:1日
    3D:3日
    7D:7日
    15D:15日
    1M:1カ月
    3M:3カ月
    6M:6カ月

    List all categories

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/categories' \
      -H 'Authorization: Bearer {access_token}' \
      -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",
                "display_type": "A",
                "full_category_name": {
                    "1": "(Main Category) Tops",
                    "2": "(Middle Category) Tees",
                    "3": "(Small Category) Long Sleeve",
                    "4": "(Detailed Category) Cropped"
                },
                "root_category_no": 27,
                "use_main": "F",
                "use_display": "T",
                "display_order": 0,
                "full_category_no": {
                    "1": "25",
                    "2": "28",
                    "3": "30",
                    "4": "40"
                },
                "soldout_product_display": "B",
                "sub_category_product_display": "T",
                "hashtag_product_display": "T",
                "hash_tags": [
                    "tag1",
                    "tag2"
                ],
                "product_display_scope": "A",
                "product_display_type": "U",
                "product_display_key": "A",
                "product_display_sort": "D",
                "product_display_period": "W",
                "normal_product_display_type": null,
                "normal_product_display_key": null,
                "normal_product_display_sort": null,
                "normal_product_display_period": null,
                "recommend_product_display_type": null,
                "recommend_product_display_key": null,
                "recommend_product_display_sort": null,
                "recommend_product_display_period": null,
                "new_product_display_type": null,
                "new_product_display_key": null,
                "new_product_display_sort": null,
                "new_product_display_period": null
            },
            {
                "shop_no": 1,
                "category_no": 28,
                "category_depth": 1,
                "parent_category_no": 1,
                "category_name": "(large scale classification) Accessories",
                "display_type": "A",
                "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
                },
                "use_main": "F",
                "use_display": "T",
                "display_order": 0,
                "soldout_product_display": "B",
                "sub_category_product_display": "T",
                "hashtag_product_display": "T",
                "hash_tags": [
                    "tag1",
                    "tag2"
                ],
                "product_display_scope": "A",
                "product_display_type": "U",
                "product_display_key": "A",
                "product_display_sort": "D",
                "product_display_period": "W",
                "normal_product_display_type": null,
                "normal_product_display_key": null,
                "normal_product_display_sort": null,
                "normal_product_display_period": null,
                "recommend_product_display_type": null,
                "recommend_product_display_key": null,
                "recommend_product_display_sort": null,
                "recommend_product_display_period": null,
                "new_product_display_type": null,
                "new_product_display_key": null,
                "new_product_display_sort": null,
                "new_product_display_period": null
            }
        ]
    }
    

    基本スペック

    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://{mallid}.cafe24api.com/api/v2/admin/categories/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/categories/count' \
      -H 'Authorization: Bearer {access_token}' \
      -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://{mallid}.cafe24api.com/api/v2/admin/categories/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/categories/40' \
      -H 'Authorization: Bearer {access_token}' \
      -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",
            "display_type": "A",
            "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"
            },
            "use_main": "F",
            "use_display": "T",
            "display_order": 0,
            "soldout_product_display": "B",
            "sub_category_product_display": "T",
            "hashtag_product_display": "T",
            "hash_tags": [
                "tag1",
                "tag2"
            ],
            "product_display_scope": "A",
            "product_display_type": "U",
            "product_display_key": "A",
            "product_display_sort": "D",
            "product_display_period": "W",
            "normal_product_display_type": null,
            "normal_product_display_key": null,
            "normal_product_display_sort": null,
            "normal_product_display_period": null,
            "recommend_product_display_type": null,
            "recommend_product_display_key": null,
            "recommend_product_display_sort": null,
            "recommend_product_display_period": null,
            "new_product_display_type": null,
            "new_product_display_key": null,
            "new_product_display_sort": null,
            "new_product_display_period": null
        }
    }
    

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

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

    Create a category

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/categories'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/categories' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "parent_category_no": 1,
            "category_name": "(large scale classification) Bottoms",
            "display_type": "A",
            "use_display": "T",
            "use_main": "T",
            "soldout_product_display": "B",
            "sub_category_product_display": "T",
            "hashtag_product_display": "T",
            "hash_tags": [
                "tag1",
                "tag2"
            ],
            "product_display_scope": "A",
            "product_display_type": "U",
            "product_display_key": "A",
            "product_display_sort": "D",
            "product_display_period": "W",
            "normal_product_display_type": null,
            "normal_product_display_key": null,
            "normal_product_display_sort": null,
            "normal_product_display_period": null,
            "recommend_product_display_type": null,
            "recommend_product_display_key": null,
            "recommend_product_display_sort": null,
            "recommend_product_display_period": null,
            "new_product_display_type": null,
            "new_product_display_key": null,
            "new_product_display_sort": null,
            "new_product_display_period": null
        }
    }'
    

    Response example:

    {
        "category": {
            "shop_no": 1,
            "category_no": 40,
            "category_depth": 1,
            "parent_category_no": 1,
            "category_name": "(large scale classification) Bottoms",
            "display_type": "A",
            "full_category_name": {
                "1": "(large scale classification) Bottoms",
                "2": null,
                "3": null,
                "4": null
            },
            "full_category_no": {
                "1": "40",
                "2": null,
                "3": null,
                "4": null
            },
            "root_category_no": 40,
            "use_main": "T",
            "use_display": "T",
            "display_order": 5,
            "soldout_product_display": "B",
            "sub_category_product_display": "T",
            "hashtag_product_display": "T",
            "hash_tags": [
                "tag1",
                "tag2"
            ],
            "product_display_scope": "A",
            "product_display_type": "U",
            "product_display_key": "A",
            "product_display_sort": "D",
            "product_display_period": "W",
            "normal_product_display_type": null,
            "normal_product_display_key": null,
            "normal_product_display_sort": null,
            "normal_product_display_period": null,
            "recommend_product_display_type": null,
            "recommend_product_display_key": null,
            "recommend_product_display_sort": null,
            "recommend_product_display_period": null,
            "new_product_display_type": null,
            "new_product_display_key": null,
            "new_product_display_sort": null,
            "new_product_display_period": null
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品カテゴリ 投稿権限 (WRITE_CATEGORY)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    parent_category_no

    親カテゴリ番号

    登録する商品カテゴリの親カテゴリ番号

    商品カテゴリを特定カテゴリの下位に登録したい場合、そのカテゴリ番号を入力して登録することができる。

    category_name
    Required

    Max Length : [50]

    カテゴリ名

    該当する商品カテゴリ名

    display_type

    ショップの表示設定

    該当する商品カテゴリを PC ショップに表示するか、モバイルショップに表示するか、両方に表示するかの設定

    A:PC + モバイル
    P:PC
    M:モバイル
    F:両方とも使用しない

    use_main

    メインカテゴリの表示ステータス

    商品カテゴリがショップのトップページに表示されるかどうかの有無。メインカテゴリに表示する場合は中/小/細カテゴリも大カテゴリのように最上位に表示される。

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

    use_display

    表示ステータス

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

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

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

    soldout_product_display

    在庫切れ商品の表示

    在庫切れ商品を商品カテゴリの一番前に表示するか、一番後ろに表示するかの設定

    B:在庫切れ商品を一番後ろに
    F:在庫切れ商品を一番前に
    N:在庫切れ商品関係なし

    sub_category_product_display

    下位カテゴリ商品の表示

    現在の商品カテゴリの下位カテゴリに表示されている商品まで含めて表示するか否かの設定

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

    hashtag_product_display

    キュレーションハッシュタグ商品の表示

    ハッシュタグ商品表示機能の使用設定

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

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

    hash_tags

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

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

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

    product_display_scope

    商品カテゴリの表示エリアの区分

    商品カテゴリに商品を一括表示するか、エリア別に表示するかの設定

    「すべて」に設定された場合、次の項目で表示設定ができる。
    product_display_type
    product_display_key
    product_display_sort
    product_display_period

    「エリア別」に設定された場合、次の項目でエリア別に表示設定ができる。
    normal_product_display_type
    normal_product_display_key
    normal_product_display_sort
    normal_product_display_period
    recommend_product_display_type
    recommend_product_display_key
    recommend_product_display_sort
    recommend_product_display_period
    new_product_display_type
    new_product_display_key
    new_product_display_sort
    new_product_display_period

    A:すべて
    G:エリア別

    product_display_type

    商品カテゴリの表示方法

    商品カテゴリ表示エリアの設定が「すべて」の場合、その商品カテゴリの表示方法

    A:自動並べ替え
    U:ユーザー指定
    M:自動並べ替え+ユーザー指定

    product_display_key

    商品カテゴリの表示方法キー

    商品カテゴリ表示エリアの設定が「すべて」で、商品カテゴリの表示方法が「自動表示」または「自動表示+使用者指定」の場合、その商品カテゴリをどのような基準で表示するかの設定

    A:最近追加された商品
    R:最近登録された商品
    U:最近修正された商品
    N:商品名五十音順
    P:販売価格が高い商品
    S:販売数の多い商品
    C:閲覧数の多い商品
    L:いいねが多い商品

    product_display_sort

    商品カテゴリの表示方法の順序

    商品カテゴリの表示方法を降順にするか、昇順にするかの設定

    D:降順
    A:昇順

    product_display_period

    表示順序に対する期間

    表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間

    W:すべての期間
    1D:1日
    3D:3日
    7D:7日
    15D:15日
    1M:1カ月
    3M:3カ月
    6M:6カ月

    normal_product_display_type

    商品カテゴリの表示方法

    商品カテゴリ表示エリアの設定が「エリア別」の場合、一般商品エリアの表示方法

    A:自動並べ替え
    U:ユーザー指定
    M:自動並べ替え+ユーザー指定

    normal_product_display_key

    商品カテゴリの表示方法キー

    商品カテゴリ表示エリアの設定が「エリア別」の場合、一般商品エリアをどのような基準で表示するかの設定

    A:最近追加された商品
    R:最近登録された商品
    U:最近修正された商品
    N:商品名五十音順
    P:販売価格が高い商品
    S:販売数の多い商品
    C:閲覧数の多い商品
    L:いいねが多い商品

    normal_product_display_sort

    商品カテゴリの表示方法の順序

    一般商品エリアの表示方法を降順にするか、昇順にするかの設定

    D:降順
    A:昇順

    normal_product_display_period

    表示順序に対する期間

    一般商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間

    W:すべての期間
    1D:1日
    3D:3日
    7D:7日
    15D:15日
    1M:1カ月
    3M:3カ月
    6M:6カ月

    recommend_product_display_type

    商品カテゴリの表示方法

    商品カテゴリ表示エリアの設定が「エリア別」の場合、おすすめ商品エリアの表示方法

    A:自動並べ替え
    U:ユーザー指定
    M:自動並べ替え+ユーザー指定

    recommend_product_display_key

    商品カテゴリの表示方法キー

    商品カテゴリ表示エリアの設定が「エリア別」の場合、おすすめ商品エリアをどのような基準で表示するかの設定

    A:最近追加された商品
    R:最近登録された商品
    U:最近修正された商品
    N:商品名五十音順
    P:販売価格が高い商品
    S:販売数の多い商品
    C:閲覧数の多い商品
    L:いいねが多い商品

    recommend_product_display_sort

    商品カテゴリの表示方法の順序

    おすすめ商品エリアの表示方法を降順にするか、昇順にするかの設定

    D:降順
    A:昇順

    recommend_product_display_period

    表示順序に対する期間

    おすすめ商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間

    W:すべての期間
    1D:1日
    3D:3日
    7D:7日
    15D:15日
    1M:1カ月
    3M:3カ月
    6M:6カ月

    new_product_display_type

    商品カテゴリの表示方法

    商品カテゴリ表示エリアの設定が「エリア別」の場合、新着商品エリアの表示方法

    A:自動並べ替え
    U:ユーザー指定
    M:自動並べ替え+ユーザー指定

    new_product_display_key

    商品カテゴリの表示方法キー

    商品カテゴリ表示エリアの設定が「エリア別」の場合、新着商品エリアをどのような基準で表示するかの設定

    A:最近追加された商品
    R:最近登録された商品
    U:最近修正された商品
    N:商品名五十音順
    P:販売価格が高い商品
    S:販売数の多い商品
    C:閲覧数の多い商品
    L:いいねが多い商品

    new_product_display_sort

    商品カテゴリの表示方法の順序

    新着商品エリアの表示方法を降順にするか、昇順にするかの設定

    D:降順
    A:昇順

    new_product_display_period

    表示順序に対する期間

    新着商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間

    W:すべての期間
    1D:1日
    3D:3日
    7D:7日
    15D:15日
    1M:1カ月
    3M:3カ月
    6M:6カ月

    Update a category

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/categories/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/categories/40' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "category_name": "(large scale classification) Pants",
            "display_type": "A",
            "use_display": "T",
            "use_main": "T",
            "soldout_product_display": "B",
            "sub_category_product_display": "T",
            "hashtag_product_display": "F",
            "hash_tags": [
                "tag1",
                "tag2"
            ],
            "product_display_scope": "G",
            "normal_product_display_type": "A",
            "normal_product_display_key": "S",
            "normal_product_display_sort": "D",
            "normal_product_display_period": "1M",
            "recommend_product_display_type": "A",
            "recommend_product_display_key": "R",
            "recommend_product_display_sort": "D",
            "recommend_product_display_period": "W",
            "new_product_display_type": "A",
            "new_product_display_key": "C",
            "new_product_display_sort": "D",
            "new_product_display_period": "W"
        }
    }'
    

    Response example:

    {
        "category": {
            "shop_no": 1,
            "category_no": 40,
            "category_depth": 4,
            "parent_category_no": 37,
            "category_name": "(large scale classification) Pants",
            "display_type": "A",
            "full_category_name": {
                "1": "(Main Category) Tops",
                "2": "(Middle Category) Tees",
                "3": "(Small Category) Long Sleeve",
                "4": "(large scale classification) Pants"
            },
            "full_category_no": {
                "1": "25",
                "2": "30",
                "3": "37",
                "4": "40"
            },
            "root_category_no": 25,
            "use_main": "T",
            "use_display": "T",
            "display_order": 5,
            "soldout_product_display": "B",
            "sub_category_product_display": "T",
            "hashtag_product_display": "F",
            "hash_tags": [
                "tag1",
                "tag2"
            ],
            "product_display_scope": "G",
            "product_display_type": null,
            "product_display_key": null,
            "product_display_sort": null,
            "product_display_period": null,
            "normal_product_display_type": "A",
            "normal_product_display_key": "S",
            "normal_product_display_sort": "D",
            "normal_product_display_period": "1M",
            "recommend_product_display_type": "A",
            "recommend_product_display_key": "R",
            "recommend_product_display_sort": "D",
            "recommend_product_display_period": "W",
            "new_product_display_type": "A",
            "new_product_display_key": "C",
            "new_product_display_sort": "D",
            "new_product_display_period": "W"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品カテゴリ 投稿権限 (WRITE_CATEGORY)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    category_name

    Max Length : [50]

    カテゴリ名

    該当する商品カテゴリ名

    display_type

    ショップの表示設定

    該当する商品カテゴリを PC ショップに表示するか、モバイルショップに表示するか、両方に表示するかの設定

    A:PC + モバイル
    P:PC
    M:モバイル
    F:両方とも使用しない

    use_main

    メインカテゴリの表示ステータス

    商品カテゴリがショップのトップページに表示されるかどうかの有無。メインカテゴリに表示する場合は中/小/細カテゴリも大カテゴリのように最上位に表示される。

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

    use_display

    表示ステータス

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

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

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

    soldout_product_display

    在庫切れ商品の表示

    在庫切れ商品を商品カテゴリの一番前に表示するか、一番後ろに表示するかの設定

    B:在庫切れ商品を一番後ろに
    F:在庫切れ商品を一番前に
    N:在庫切れ商品関係なし

    sub_category_product_display

    下位カテゴリ商品の表示

    現在の商品カテゴリの下位カテゴリに表示されている商品まで含めて表示するか否かの設定

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

    hashtag_product_display

    キュレーションハッシュタグ商品の表示

    ハッシュタグ商品表示機能の使用設定

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

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

    hash_tags

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

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

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

    product_display_scope

    商品カテゴリの表示エリアの区分

    商品カテゴリに商品を一括表示するか、エリア別に表示するかの設定

    「すべて」に設定された場合、次の項目で表示設定ができる。
    product_display_type
    product_display_key
    product_display_sort
    product_display_period

    「エリア別」に設定された場合、次の項目でエリア別に表示設定ができる。
    normal_product_display_type
    normal_product_display_key
    normal_product_display_sort
    normal_product_display_period
    recommend_product_display_type
    recommend_product_display_key
    recommend_product_display_sort
    recommend_product_display_period
    new_product_display_type
    new_product_display_key
    new_product_display_sort
    new_product_display_period

    A:すべて
    G:エリア別

    product_display_type

    商品カテゴリの表示方法

    商品カテゴリ表示エリアの設定が「すべて」の場合、その商品カテゴリの表示方法

    A:自動並べ替え
    U:ユーザー指定
    M:自動並べ替え+ユーザー指定

    product_display_key

    商品カテゴリの表示方法キー

    商品カテゴリ表示エリアの設定が「すべて」で、商品カテゴリの表示方法が「自動表示」または「自動表示+使用者指定」の場合、その商品カテゴリをどのような基準で表示するかの設定

    A:最近追加された商品
    R:最近登録された商品
    U:最近修正された商品
    N:商品名五十音順
    P:販売価格が高い商品
    S:販売数の多い商品
    C:閲覧数の多い商品
    L:いいねが多い商品

    product_display_sort

    商品カテゴリの表示方法の順序

    商品カテゴリの表示方法を降順にするか、昇順にするかの設定

    D:降順
    A:昇順

    product_display_period

    表示順序に対する期間

    表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間

    W:すべての期間
    1D:1日
    3D:3日
    7D:7日
    15D:15日
    1M:1カ月
    3M:3カ月
    6M:6カ月

    normal_product_display_type

    商品カテゴリの表示方法

    商品カテゴリ表示エリアの設定が「エリア別」の場合、一般商品エリアの表示方法

    A:自動並べ替え
    U:ユーザー指定
    M:自動並べ替え+ユーザー指定

    normal_product_display_key

    商品カテゴリの表示方法キー

    商品カテゴリ表示エリアの設定が「エリア別」の場合、一般商品エリアをどのような基準で表示するかの設定

    A:最近追加された商品
    R:最近登録された商品
    U:最近修正された商品
    N:商品名五十音順
    P:販売価格が高い商品
    S:販売数の多い商品
    C:閲覧数の多い商品
    L:いいねが多い商品

    normal_product_display_sort

    商品カテゴリの表示方法の順序

    一般商品エリアの表示方法を降順にするか、昇順にするかの設定

    D:降順
    A:昇順

    normal_product_display_period

    表示順序に対する期間

    一般商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間

    W:すべての期間
    1D:1日
    3D:3日
    7D:7日
    15D:15日
    1M:1カ月
    3M:3カ月
    6M:6カ月

    recommend_product_display_type

    商品カテゴリの表示方法

    商品カテゴリ表示エリアの設定が「エリア別」の場合、おすすめ商品エリアの表示方法

    A:自動並べ替え
    U:ユーザー指定
    M:自動並べ替え+ユーザー指定

    recommend_product_display_key

    商品カテゴリの表示方法キー

    商品カテゴリ表示エリアの設定が「エリア別」の場合、おすすめ商品エリアをどのような基準で表示するかの設定

    A:最近追加された商品
    R:最近登録された商品
    U:最近修正された商品
    N:商品名五十音順
    P:販売価格が高い商品
    S:販売数の多い商品
    C:閲覧数の多い商品
    L:いいねが多い商品

    recommend_product_display_sort

    商品カテゴリの表示方法の順序

    おすすめ商品エリアの表示方法を降順にするか、昇順にするかの設定

    D:降順
    A:昇順

    recommend_product_display_period

    表示順序に対する期間

    おすすめ商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間

    W:すべての期間
    1D:1日
    3D:3日
    7D:7日
    15D:15日
    1M:1カ月
    3M:3カ月
    6M:6カ月

    new_product_display_type

    商品カテゴリの表示方法

    商品カテゴリ表示エリアの設定が「エリア別」の場合、新着商品エリアの表示方法

    A:自動並べ替え
    U:ユーザー指定
    M:自動並べ替え+ユーザー指定

    new_product_display_key

    商品カテゴリの表示方法キー

    商品カテゴリ表示エリアの設定が「エリア別」の場合、新着商品エリアをどのような基準で表示するかの設定

    A:最近追加された商品
    R:最近登録された商品
    U:最近修正された商品
    N:商品名五十音順
    P:販売価格が高い商品
    S:販売数の多い商品
    C:閲覧数の多い商品
    L:いいねが多い商品

    new_product_display_sort

    商品カテゴリの表示方法の順序

    新着商品エリアの表示方法を降順にするか、昇順にするかの設定

    D:降順
    A:昇順

    new_product_display_period

    表示順序に対する期間

    新着商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間

    W:すべての期間
    1D:1日
    3D:3日
    7D:7日
    15D:15日
    1M:1カ月
    3M:3カ月
    6M:6カ月

    Delete a category

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/categories/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/categories/24' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "category": {
            "category_no": 24
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品カテゴリ 投稿権限 (WRITE_CATEGORY)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    category_no
    Required

    カテゴリ番号

    Classifications

    独自カテゴリ(Classifications)は商品の「製作情報」の中で独自カテゴリに入力する情報を意味します。商品を区分する販売カテゴリの一つで、商品は必ず一つの独自カテゴリを持っています(指定しない場合は「基本の独自カテゴリ」を使う)。

    Classifications properties

    Attribute Description
    shop_no

    ショップ番号

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

    classification_code

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

    独自カテゴリコード

    classification_name

    Max Length : [200]

    独自カテゴリ名

    classification_description

    Max Length : [300]

    独自カテゴリの説明

    use_classification

    使用設定

    created_date

    timezone

    作成日

    product_count

    商品数

    List all classifications

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/classifications'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/classifications' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "classifications": [
            {
                "shop_no": 1,
                "classification_code": "C000000A",
                "classification_name": "Default Classification",
                "classification_description": "Default Classification description",
                "use_classification": "T",
                "created_date": "2018-01-16T12:00:41+09:00",
                "product_count": 2
            },
            {
                "shop_no": 1,
                "classification_code": "C000000B",
                "classification_name": "Classification 1",
                "classification_description": "Classification 1 description",
                "use_classification": "T",
                "created_date": "2018-01-16T12:00:41+09:00",
                "product_count": 3
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 販売カテゴリ 閲覧権限 (READ_COLLECTION)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    classification_code

    独自カテゴリコード

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

    classification_name

    独自カテゴリ名

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

    use_classification

    使用設定

    limit

    Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    Count all classifications

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/classifications/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/classifications/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    基本スペック

    Property Description
    SCOPE 販売カテゴリ 閲覧権限 (READ_COLLECTION)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    classification_code

    独自カテゴリコード

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

    classification_name

    独自カテゴリ名

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

    use_classification

    使用設定

    Coupons

    Coupons Entity関係図
    クーポン(Coupons)は商品の価格や送料を割引してもえるようにショップの会員に発行する特典です。クーポンはショップの販売促進(プロモーション)のために使うことができ、多様な形で会員に発行することができます。
    クーポン(Coupons)の{#id}は「coupon_no」です。

    Coupons properties

    Attribute Description
    shop_no

    ショップ番号

    DEFAULT 1

    coupon_no

    クーポンID

    クーポンID

    coupon_type

    クーポンタイプ

    クーポンのタイプ。オンラインクーポンとオフラインクローズドクーポンがある。

    O:オンラインクーポン
    S:オフラインクローズドクーポン

    coupon_name

    クーポン名

    クーポンの名前

    coupon_description

    クーポン内容

    クーポンに対する説明

    created_date

    timezone

    作成日

    クーポンの生成日

    deleted

    クーポンの削除有無

    クーポンが削除されたかどうかの区分

    T:削除
    F:削除されていない

    is_stopped_issued_coupon

    クーポンの完全削除(発行済みクーポンの使用停止)可否

    クーポンが完全に削除されたかどうかの有無。クーポンが完全に削除されるとすでに発行されたクーポンも使用できなくなる。

    T:完全削除
    F:完全削除ではない

    pause_begin_datetime

    timezone

    クーポン発行一時停止の開始時間

    クーポンを条件付き自動発行に設定した場合、条件に合っても発行を一時停止する期間の開始時間

    pause_end_datetime

    timezone

    クーポン発行一時停止の終了時間

    クーポンを条件付き自動発行に設定した場合、条件に合っても発行を一時停止する期間の終了時間

    benefit_text

    クーポン特典詳細内訳の出力

    クーポンによる特典の詳細内訳が出力される。

    benefit_type

    特典区分

    特典のタイプ。タイプ別に付与する特典が異なる。

    A:割引金額
    B:割引率
    C:ポイント
    D:付与率
    E:基本送料割引(全額割引)
    I:基本送料割引(割引率)
    H:基本送料割引(割引金額)
    F:即時付与

    benefit_price

    特典金額

    特典として割引される金額

    benefit_percentage

    特典割合

    特典として割引される割合

    benefit_percentage_round_unit

    特典割合の切り捨て単位

    特典として割引される金額の切り捨て単位

    benefit_percentage_max_price

    特典割合の最大金額

    特典として割引される最大金額

    include_regional_shipping_rate

    送料割引時に地域別区分を含むか否かの設定

    送料を割引する場合に地域別送料を含めるかどうかを設定

    T:地域別区分を含む
    F:地域別区分を含まない

    DEFAULT F

    include_foreign_delivery

    海外配送を含むかの有無

    クーポンによる特典に海外配送を含めるかどうかを設定

    T:海外配送を含む
    F:海外配送を含まない

    DEFAULT F

    coupon_direct_url

    クーポンの直接アクセス経路

    クーポンに直接アクセスできる経路

    issue_type

    発行方式

    クーポンの発行形態のタイプ

    M:対象者指定発行
    A:条件付き自動発行
    D:顧客のダウンロードで発行

    issue_sub_type

    発行下位タイプ

    クーポン発行の詳細下位タイプ

    M:会員対象
    C:リアルタイムアクセス者対象
    J:会員登録
    D:配送完了時
    A:記念日(誕生日)
    I:モジュール(プログラム)設置
    P:商品レビュー投稿
    O:注文完了時
    Q:購入数量充足時
    F:初注文の顧客
    N:一定期間購入していない会員対象

    issue_member_join

    会員登録時のクーポン発行の有無

    会員登録時に発行するクーポンであるかどうかを設定

    T:発行対象
    F:発行対象ではない

    DEFAULT F

    issue_member_join_recommend

    会員登録時の紹介者に対するクーポン発行の有無

    会員登録時に紹介者に発行するクーポンであるかどうかを設定

    T:発行対象
    F:発行対象ではない

    DEFAULT F

    issue_member_join_type

    会員登録時のクーポン発行対象

    会員登録時にクーポンを発行する対象の区分

    A:SMS受信同意ANDメール受信同意
    O:SMS受信同意ORメール受信同意
    S:SMS受信同意
    E:メール受信同意

    issue_order_amount_type

    発行可能な購入金額のタイプ

    クーポンによる割引の対象になる金額の基準

    O:購入金額基準
    S:実際の決済金額基準

    issue_order_start_date

    timezone

    クーポン発行可能な注文開始日時

    クーポンの発行可能な注文開始日時

    issue_order_end_date

    timezone

    クーポン発行可能な注文終了日時

    クーポンの発行可能な注文終了日時

    issue_order_amount_limit

    発行可能購入金額の制限タイプ

    クーポンの発行可能な購入金額を制限することができる。

    U:制限なし
    L:最小金額
    S:金額範囲

    issue_order_amount_min

    発行可能な最小購入金額

    クーポンの発行可能な最小購入金額

    issue_order_amount_max

    発行可能な最大購入金額

    クーポンの発行可能な最大購入金額

    issue_order_path

    注文経路

    発行したクーポンの使用可能な注文経路

    W:PCショップ専用
    M:モバイルショップ専用
    P:プラスアプリ専用

    issue_order_type

    発行単位

    クーポンの発行単位

    O:注文書単位発行クーポン
    P:商品単位発行クーポン

    issue_order_available_product

    発行対象商品

    クーポンの発行対象になる商品

    U:制限なし
    I:選択商品適用
    E:選択商品を除く

    issue_order_available_category

    発行対象カテゴリ

    クーポンの発行対象になるカテゴリ

    U:制限なし
    I:選択商品適用
    E:選択商品を除く

    issue_anniversary_type

    発行条件記念日のタイプ

    クーポンの発行条件になる記念日のタイプ

    B:誕生日
    W:結婚記念日

    issue_anniversary_pre_issue_day

    発行条件記念日の事前発行日数

    記念日クーポンの事前発行可能な日数

    issue_module_type

    発行条件設置モジュールのタイプ

    モジュール設置発行クーポンの設置モジュールタイプ

    S:ショートカット
    B:お気に入り
    L:ライブリンクオン

    issue_review_count

    発行条件商品レビューの個数

    クーポンの発行に必要な商品レビューの個数

    issue_review_has_image

    発行条件商品レビューに画像が含まれるか否かの設定

    クーポンの発行に必要な商品レビューに画像が含まれるかどうかを設定

    T:含む
    F:含まない

    DEFAULT F

    issue_quantity_min

    クーポン発行可能な最小購入数量

    クーポンの発行可能な最小購入数量

    issue_quntity_type

    クーポン発行可能数量の判断基準

    クーポンの発行可能な数量を判断する基準

    P:商品数量基準
    O:注文数量基準

    issue_max_count

    最大発行数

    クーポンの最大発行数量

    issue_max_count_by_user

    同一ユーザー当たりの最大発行数

    同じ顧客に最大発行可能なクーポン数

    issue_count_per_once

    クーポン発行数量(1回当たり発行数量)

    1回発行時のクーポン発行数量

    issued_count

    発行された数量

    クーポンが発行された数量

    issue_member_group_no

    発行会員ランク番号

    クーポンの発行対象になる会員ランクの番号

    issue_member_group_name

    発行会員ランク名

    クーポンの発行対象になる会員ランクの名前

    issue_no_purchase_period

    一定期間購入していない対象会員の未購入期間

    一定期間未購入会員を対象に発行する時、発行条件として設定した購入履歴がない期間

    issue_reserved

    自動発行予約使用の設定

    クーポンの発行日を予約する機能を使うかどうかの有無。予約した日時にクーポンが自動発行される。

    T:自動発行予約を使用する
    F:自動発行予約を使用しない

    DEFAULT F

    issue_reserved_date

    timezone

    自動発行予約の発行日時

    設定されたクーポン自動発行予約日時

    available_date

    クーポンの使用期間

    クーポンの使用可能な期間

    available_period_type

    使用期間のタイプ

    クーポンの使用可能な期間のタイプ

    F:一般期間
    R:クーポン発行日基準
    M:当月末まで使用

    available_begin_datetime

    timezone

    使用期間の開始日時

    クーポンの使用可能な期間の開始日時

    available_end_datetime

    timezone

    使用期間の終了日時

    クーポンの使用可能な期間の終了日時

    available_site

    使用対象のタイプ

    クーポンの使用可能なアクセス経路のタイプ

    W:PCショップ専用
    M:モバイルショップ専用
    P:プラスアプリ専用

    available_scope

    適用範囲

    クーポンの適用可能な範囲。商品クーポンとして適用する場合は商品一つに対してクーポンが適用され、注文書クーポンとして適用する場合は注文書全体に適用される。

    P:商品クーポン
    O:注文書クーポン

    available_day_from_issued

    使用可能日数

    クーポンの使用可能な日数

    available_price_type

    使用可能な購入金額のタイプ

    クーポンの使用可能な金額の基準。商品の金額が基準である場合は価格に数量を掛けた金額を基準とし、注文金額が基準である場合はその金額にその他の割引、送料が適用された金額を基準に計算する。

    U:制限なし
    O:注文金額基準
    P:商品金額基準

    available_min_price

    使用可能な購入金額のタイプ

    クーポンの使用可能な購入金額

    available_amount_type

    適用計算の基準

    クーポンを適用する基準になる決済金額。クーポン割引を各種割引(会員ランク割引、商品割引など)前の注文金額に適用するか各種割引後の金額に適用するかを設定

    E:割引(クーポンを除く)適用前の決済金額
    I:割引(クーポンを除く)適用後の決済金額

    available_payment_method

    使用可能な決済方法

    クーポンの使用可能な決済方法

    R:銀行振込
    E:仮想口座
    C:クレジットカード決済
    A:リアルタイム口座振替
    H:キャリア決済
    M:ポイント決済
    K:KPAY
    P:Paynow
    N:PAYCO
    O:KakaoPay

    available_product

    クーポン適用商品の選択

    クーポンの適用可能な商品の選択。特定の商品を除いたり適用したり、またはすべての商品に対してクーポンを適用するかどうか選択できる。

    U:制限なし
    I:選択商品適用
    E:選択商品を除く

    available_category

    クーポン適用カテゴリの選択

    クーポンの適用可能なカテゴリの選択。特定のカテゴリを除いたり適用したり、またはすべてのカテゴリに対してクーポンを適用するかどうか選択できる。

    U:制限なし
    I:選択カテゴリ適用
    E:選択カテゴリを除く

    available_coupon_count_by_order

    注文書当たり同一クーポンの最大使用数

    注文書当たり同じクーポンの最大使用可能数

    serial_generate_method

    クローズドクーポンの設定方法

    クローズドクーポンを生成する方法

    A:自動生成
    M:直接登録
    E:Excelアップロード

    coupon_image_type

    クーポン画像タイプ

    クーポン画像のタイプ

    B:基本画像の使用
    C:直接アップロード

    coupon_image_path

    クーポン画像経路

    クーポン画像のURL経路

    show_product_detail

    商品詳細ページの表示設定

    商品詳細ページに表示するかどうかを設定

    T:商品詳細ページを表示
    F:商品詳細ページを表示しない

    DEFAULT F

    use_notification_when_login

    ログイン時クーポン発行通知の使用設定

    会員ログイン時にクーポン発行通知を使うかどうかを設定

    T:通知を使用する
    F:通知を使用しない

    DEFAULT F

    send_sms_for_issue

    クーポン発行SMSの送信設定

    クーポンの発行情報をSMSで送信するかどうかを設定

    T:SMS送信
    F:SMS未送信

    DEFAULT F

    send_email_for_issue

    クーポン発行情報メールの送信設定

    クーポンの発行情報をEメールで送信するかどうかを設定

    T:メールを送信する
    F:メールを送信しない

    DEFAULT F

    List all coupons

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/coupons'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/coupons' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "coupons": [
            {
                "shop_no": 1,
                "coupon_no": "9000000000000000033",
                "coupon_type": "O",
                "coupon_name": "Special Discount Coupon",
                "coupon_description": null,
                "created_date": "2017-12-19T14:39:22+09:00",
                "deleted": "F",
                "is_stopped_issued_coupon": "F",
                "pause_begin_datetime": null,
                "pause_end_datetime": null,
                "benefit_text": "20.0% Discount. No cuts. Maximum discount 50",
                "benefit_type": "B",
                "benefit_price": null,
                "benefit_percentage": "20.0",
                "benefit_percentage_round_unit": "0.1",
                "benefit_percentage_max_price": "50.00",
                "include_regional_shipping_rate": null,
                "include_foreign_delivery": null,
                "coupon_direct_url": "\/exec\/front\/newcoupon\/IssueDownload?coupon_no=",
                "issue_type": "M",
                "issue_sub_type": "M",
                "issue_member_join": null,
                "issue_member_join_recommend": null,
                "issue_member_join_type": null,
                "issue_order_amount_type": null,
                "issue_order_start_date": null,
                "issue_order_end_date": null,
                "issue_order_amount_limit": null,
                "issue_order_amount_min": null,
                "issue_order_amount_max": null,
                "issue_order_path": null,
                "issue_order_type": "O",
                "issue_order_available_product": "U",
                "issue_order_available_category": "U",
                "issue_anniversary_type": null,
                "issue_anniversary_pre_issue_day": null,
                "issue_module_type": null,
                "issue_review_count": null,
                "issue_review_has_image": null,
                "issue_quantity_min": null,
                "issue_quntity_type": null,
                "issue_max_count": null,
                "issue_max_count_by_user": null,
                "issue_count_per_once": null,
                "issued_count": "0",
                "issue_member_group_no": null,
                "issue_member_group_name": null,
                "issue_no_purchase_period": null,
                "issue_reserved": "F",
                "issue_reserved_date": null,
                "available_date": "2017-12-19 00:00 ~ 2017-12-22 23:00",
                "available_period_type": "F",
                "available_begin_datetime": "2017-12-19T00:00:00+09:00",
                "available_end_datetime": "2017-12-22T23:00:00+09:00",
                "available_site": "W,M",
                "available_scope": "O",
                "available_day_from_issued": null,
                "available_price_type": "U",
                "available_min_price": null,
                "available_amount_type": "E",
                "available_payment_method": "R,E,C,A,H,M,K,P,N,O",
                "available_product": "U",
                "available_category": "U",
                "available_coupon_count_by_order": 1,
                "serial_generate_method": null,
                "coupon_image_type": "B",
                "coupon_image_path": null,
                "show_product_detail": null,
                "use_notification_when_login": "F",
                "send_sms_for_issue": "F",
                "send_email_for_issue": null
            },
            {
                "shop_no": 1,
                "coupon_no": "9000000000000000032",
                "coupon_type": "O",
                "coupon_name": "Christmas Week Coupon",
                "coupon_description": null,
                "created_date": "2017-12-18T11:56:41+09:00",
                "deleted": "F",
                "is_stopped_issued_coupon": "F",
                "pause_begin_datetime": null,
                "pause_end_datetime": null,
                "benefit_text": "discount for 10",
                "benefit_type": "A",
                "benefit_price": "10.00",
                "benefit_percentage": null,
                "benefit_percentage_round_unit": null,
                "benefit_percentage_max_price": null,
                "include_regional_shipping_rate": null,
                "include_foreign_delivery": null,
                "coupon_direct_url": "\/exec\/front\/newcoupon\/IssueDownload?coupon_no=",
                "issue_type": "M",
                "issue_sub_type": "M",
                "issue_member_join": null,
                "issue_member_join_recommend": null,
                "issue_member_join_type": null,
                "issue_order_amount_type": null,
                "issue_order_start_date": null,
                "issue_order_end_date": null,
                "issue_order_amount_limit": null,
                "issue_order_amount_min": null,
                "issue_order_amount_max": null,
                "issue_order_path": null,
                "issue_order_type": "O",
                "issue_order_available_product": "U",
                "issue_order_available_category": "U",
                "issue_anniversary_type": null,
                "issue_anniversary_pre_issue_day": null,
                "issue_module_type": null,
                "issue_review_count": null,
                "issue_review_has_image": null,
                "issue_quantity_min": null,
                "issue_quntity_type": null,
                "issue_max_count": null,
                "issue_max_count_by_user": null,
                "issue_count_per_once": null,
                "issued_count": "0",
                "issue_member_group_no": null,
                "issue_member_group_name": null,
                "issue_no_purchase_period": null,
                "issue_reserved": "F",
                "issue_reserved_date": null,
                "available_date": "2017-12-18 00:00 ~ 2017-12-21 23:00",
                "available_period_type": "F",
                "available_begin_datetime": "2017-12-18T00:00:00+09:00",
                "available_end_datetime": "2017-12-21T23:00:00+09:00",
                "available_site": "W,M",
                "available_scope": "O",
                "available_day_from_issued": null,
                "available_price_type": "U",
                "available_min_price": null,
                "available_amount_type": "E",
                "available_payment_method": "R,E,C,A,H,M,K,P,N,O",
                "available_product": "U",
                "available_category": "U",
                "available_coupon_count_by_order": 1,
                "serial_generate_method": null,
                "coupon_image_type": "B",
                "coupon_image_path": null,
                "show_product_detail": null,
                "use_notification_when_login": "F",
                "send_sms_for_issue": "F",
                "send_email_for_issue": null
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE プロモーション 閲覧権限 (READ_PROMOTION)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    coupon_no

    クーポンID

    クーポンID

    coupon_type

    クーポンタイプ

    クーポンタイプ

    O:オンラインクーポン
    S:オフラインクローズドクーポン

    coupon_name

    クーポン名

    クーポン名

    benefit_type

    特典区分

    クーポンによる特典の種類の区分

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

    A:割引金額
    B:割引率
    C:ポイント
    D:付与率
    E:基本送料割引(全額割引)
    I:基本送料割引(割引率)
    H:基本送料割引(割引金額)
    F:即時付与

    issue_type

    発行方式

    クーポンの発行形態のタイプ

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

    M:対象者指定発行
    A:条件付き自動発行
    D:顧客のダウンロードで発行

    issue_sub_type

    発行下位タイプ

    クーポン発行の詳細下位タイプ

    M:会員対象
    C:リアルタイムアクセス者対象
    J:会員登録
    D:配送完了時
    A:記念日(誕生日)
    I:モジュール(プログラム)設置
    P:商品レビュー投稿
    O:注文完了時
    Q:購入数量充足時
    F:初注文の顧客
    N:一定期間購入していない会員対象

    issued_flag

    発行されたクーポンの有無

    クーポンの発行履歴の有無

    T:発行履歴のあるクーポン
    F:発行履歴のないクーポン

    created_start_date

    Date
    timezone

    検索開始日

    クーポン生成日基準検索の検索開始日
    検索終了日と必ずペアで使用すること。

    created_end_date

    Date
    timezone

    検索終了日

    クーポン生成日基準検索の検索終了日
    検索開始日と必ずペアで使用すること。

    deleted

    クーポンの削除有無

    クーポンが削除されたかどうかの区分

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

    T:削除されたクーポン
    F:削除されていないクーポン

    DEFAULT F

    pause_begin_date

    Date
    timezone

    クーポン発行一時停止の開始時間

    クーポン一時停止日基準検索の検索開始日

    pause_end_date

    Date
    timezone

    クーポン発行一時停止の終了時間

    クーポン一時停止日基準検索の検索終了日

    issue_order_path

    注文経路

    発行したクーポンの使用可能な注文経路

    W:PC
    M:モバイル
    P:プラスアプリ

    issue_order_type

    発行単位

    クーポンの発行単位が商品か注文書単位クーポンかを設定

    P:商品クーポン
    O:注文書クーポン

    issue_reserved

    自動発行予約使用の設定

    クーポンの自動発行予約使用の設定

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

    available_period_type

    使用期間のタイプ

    クーポンの使用期間のタイプ

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

    F:一般期間
    R:クーポン発行日基準
    M:当月末まで使用

    available_datetime

    Date
    timezone

    該当する日付に発行できるクーポン検索

    該当日に発行可能なクーポン検索

    available_period_typeがFの場合のみ有効

    available_site

    使用対象のタイプ

    発行したクーポンの使用可能な注文経路

    W:PCショップ専用
    M:モバイルショップ専用
    P:プラスアプリ専用

    available_scope

    適用範囲

    クーポンの適用可能な範囲が商品か注文書単位クーポンかを設定

    P:商品クーポン
    O:注文書クーポン

    available_price_type

    使用可能な購入金額のタイプ

    クーポンの使用可能な金額の基準が注文金額か商品金額か制限がないかを設定

    U:制限なし
    O:注文金額基準
    P:商品金額基準

    limit

    Max : [500]

    検索結果の最大件数

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

    DEFAULT 100

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    Count all coupons

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/coupons/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/coupons/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 24
    }
    

    基本スペック

    Property Description
    SCOPE プロモーション 閲覧権限 (READ_PROMOTION)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    coupon_no

    クーポンID

    クーポンID

    coupon_type

    クーポンタイプ

    検索したいクーポンのタイプ

    O:オンラインクーポン
    S:オフラインクローズドクーポン

    coupon_name

    クーポン名

    クーポン名

    benefit_type

    特典区分

    クーポンによる特典の種類の区分

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

    A:割引金額
    B:割引率
    C:ポイント
    D:付与率
    E:基本送料割引(全額割引)
    I:基本送料割引(割引率)
    H:基本送料割引(割引金額)
    F:即時付与

    issue_type

    発行方式

    クーポンの発行形態のタイプ

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

    M:対象者指定発行
    A:条件付き自動発行
    D:顧客のダウンロードで発行

    issue_sub_type

    発行下位タイプ

    クーポン発行の詳細下位タイプ

    M:会員対象
    C:リアルタイムアクセス者対象
    J:会員登録
    D:配送完了時
    A:記念日(誕生日)
    I:モジュール(プログラム)設置
    P:商品レビュー投稿
    O:注文完了時
    Q:購入数量充足時
    F:初注文の顧客
    N:一定期間購入していない会員対象

    issued_flag

    発行されたクーポンの有無

    クーポンの発行履歴の有無

    T:発行履歴のあるクーポン
    F:発行履歴のないクーポン

    created_start_date

    Date
    timezone

    検索開始日

    クーポン生成日基準検索の検索開始日
    検索終了日と必ずペアで使用すること。

    created_end_date

    Date
    timezone

    検索終了日

    クーポン生成日基準検索の検索終了日
    検索開始日と必ずペアで使用すること。

    deleted

    クーポンの削除有無

    クーポンが削除されたかどうかの区分

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

    T:削除されたクーポン
    F:削除されていないクーポン

    DEFAULT F

    pause_begin_date

    Date
    timezone

    クーポン発行一時停止の開始時間

    クーポンの発行が一時停止され始めた時間

    pause_end_date

    Date
    timezone

    クーポン発行一時停止の終了時間

    クーポン発行の一時停止が終了した時間

    issue_order_path

    注文経路

    発行したクーポンの使用可能な注文経路

    W:PC
    M:モバイル
    P:プラスアプリ

    issue_order_type

    発行単位

    発行単位

    P:商品クーポン
    O:注文書クーポン

    issue_reserved

    自動発行予約使用の設定

    自動発行予約使用の設定

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

    available_period_type

    使用期間のタイプ

    クーポンの使用期間のタイプ

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

    F:一般期間
    R:クーポン発行日基準
    M:当月末まで使用

    available_datetime

    Date
    timezone

    該当する日付に発行できるクーポン検索

    該当日に発行可能なクーポン検索

    available_period_typeがFの場合のみ有効

    available_site

    使用対象のタイプ

    発行したクーポンの使用可能な注文経路

    W:PCショップ専用
    M:モバイルショップ専用
    P:プラスアプリ専用

    available_scope

    適用範囲

    クーポンの適用可能な範囲が商品か注文書単位クーポンかを設定

    P:商品クーポン
    O:注文書クーポン

    available_price_type

    使用可能な購入金額のタイプ

    クーポンの使用可能な金額の基準が注文金額か商品金額か制限がないかを設定

    U:制限なし
    O:注文金額基準
    P:商品金額基準

    Coupons issue

    クーポンの発行内訳(Issue)は会員にクーポンを発行した履歴です。クーポンの発行内訳に会員情報とクーポン番号を登録すると、会員にクーポンを発行することができます。

    Coupons issue properties

    Attribute Description
    shop_no

    ショップ番号

    count

    カウント

    クーポン番号別の発行した会員数

    Create a coupons issue

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/coupons/{#id}/issue'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/coupons/9000000000000000031/issue' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "issued_member_scope": "M",
            "member_id": "testmember",
            "allow_duplication": "T",
            "single_issue_per_once": "F",
            "issue_count_per_once": 3
        }
    }'
    

    Response example:

    {
        "issue": {
            "shop_no": 1,
            "count": {
                "9000000000000000031": 1
            }
        }
    }
    

    基本スペック

    Property Description
    SCOPE プロモーション 投稿権限 (WRITE_PROMOTION)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    coupon_no
    Required

    クーポンID

    クーポンID

    issued_member_scope
    Required

    会員/条件選択

    クーポン発行対象会員の範囲を特定してクーポンを発行することができる。
    特定会員グループ(G)を入力する場合、group_noを必ず入力しなければならない。
    特定会員(M)を入力する場合、member_idを必ず入力しなければならない。

    A:全会員
    G:特定会員グループ
    M:特定会員

    group_no

    会員ランク番号

    会員グループ番号

    member_id

    会員ID

    会員ID

    send_sms_for_issue
    Required

    クーポン発行SMSの送信設定

    クーポンの発行情報をSMSで送信するかどうかを設定

    T:発送する
    F:発送しない

    allow_duplication

    重複発行設定

    クーポンの重複発行設定

    T:発行する
    F:発行しない
    S:発行しない(使用の有無
    使用期間に対する追加検証をしない)

    DEFAULT F

    single_issue_per_once

    1回発行時に1枚のみ発行するか否かの設定

    クーポンを1回に1枚のみ発行するかどうかを設定

    T:1枚ずつ発行
    F:同時発行設定数量だけ発行

    DEFAULT T

    issue_count_per_once

    Min : [2]
    Max : [10]

    多数発行時の発行数量

    クーポンを1回に複数を発行する場合、その数量

    DEFAULT 2

    issued_place_type

    発行先区分

    クーポンが発行された発行先の区分

    W:PC
    M:モバイル
    P:プラスアプリ

    issued_by_action_type

    アプリのインストール時にクーポン発行

    アプリをインストールする場合、クーポンが発行される時点

    INSTALLATION:アプリをインストールするとクーポン発行
    ACCEPTING_PUSH:アプリのプッシュ通知をOnにするとクーポン発行

    issued_by_event_type

    特典による発行

    特典によるクーポンの発行時に該当する特典

    C:出席チェックイベント
    U:会員情報修正イベント
    B:バナー収益シェアプログラム
    R:ルーレットゲーム(CMC)チーム
    Z:プラスアプリのインストール(プラスアプリ)
    Y:プッシュ通知ON(プラスアプリ)
    X:プラスアプリ注文(プラスアプリ)
    M:リマインドMe注文
    W:リマインドMeリワード
    V:統合メンバーシップ
    L:永久会員切替イベント

    request_admin_id

    発行者ID

    発行者ID

    Currency

    Currency properties

    Attribute Description
    exchange_rate

    決済通貨の為替レート情報

    standard_currency_code

    基準通貨コード

    基本ショップで使う通貨コード。基準通貨とは一般的にショップの運営者が属している国家で通用する通貨を意味する。

    standard_currency_symbol

    基準通貨シンボル

    基本ショップで使う通貨の記号。基準通貨とは一般的にショップの運営者が属している国家で通用する通貨を意味する。

    shop_currency_code

    決済通貨コード

    shop_currency_symbol

    決済通貨シンボル

    Get currency setting

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/currency'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/currency' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "currency": {
            "exchange_rate": 1004,
            "standard_currency_code": "KRW",
            "standard_currency_symbol": "₩",
            "shop_currency_code": "USD",
            "shop_currency_symbol": "$"
        }
    }
    

    基本スペック

    Property Description
    SCOPE ショップ 閲覧権限 (READ_STORE)
    呼び出し件数制限 30

    Customergroup

    Customer Group Entity関係図

    会員ランク(CustomerGroups)は会員を管理するために会員をグループ化した概念です。会員は必ず一つの会員ランクに属し、ランクを指定しない場合は「一般会員」に分類されます。会員ランクを基準に特典を付与したり特定会員ランクだけにメッセージを送ることができます。

    会員ランク(CustomerGroups)の{#id}は「group_no」です。

    Customergroup properties

    Attribute Description
    shop_no

    ショップ番号

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

    group_no

    会員ランク番号

    システムにより会員ランクに付与された番号

    group_name

    会員ランク名

    会員ランクの作成時に指定した会員ランクの名前

    group_description

    会員ランクに関する説明

    会員ランクの作成時に入力した会員ランクに関する説明

    benefits_paymethod

    特典付与のための決済条件

    特典を付与するための決済条件。すべての決済、現金または現金を除いたすべての決済という3つのケースに対して特典付与のための決済条件を設定することができる。

    A:全ての決済
    B:現金決済(銀行振込)
    C:現金決済以外の全ての決済

    buy_benefits

    特典設定

    購入時に適用される割引やポイント

    F:特典なし
    D:購入金額割引
    M:ポイント付与
    P:割引適用/ポイント付与

    ship_benefits

    送料特典

    送料特典。配送を無料または有料に区分する。

    T:送料無料設定
    F:送料無料設定しない

    product_availability

    商品別割引の重複設定

    商品別割引を設定する。商品別価格割引のみに適用、会員ランク別価格割引にのみ適用、またはその両方を重複して適用することができる。

    P:商品別価格割引のみ適用
    M:会員ランク別価格割引のみ適用
    A:両方適用

    discount_information

    購入金額の割引設定

    購入金額による割引の設定。最小決済金額によって割引金額を設定することができる。

    mileage_information

    ポイント付与設定

    ポイント付与の設定。最小決済金額によって付与するポイントを設定することができる。

    mobile_discount_information

    モバイル購入の追加割引設定

    モバイル購入金額による追加割引の設定。最小決済金額によって割引金額を設定することができる。

    mobile_mileage_information

    モバイル購入の追加ポイント設定

    モバイル購入金額による追加ポイントの設定。最小決済金額によって付与するポイントを設定することができる。

    List all customergroup

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customergroup'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customergroup' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "customergroup": [
            {
                "shop_no": "1",
                "group_no": "1",
                "group_name": "Standard Membership",
                "group_description": "Group information",
                "benefits_paymethod": "A",
                "buy_benefits": "D",
                "ship_benefits": "F",
                "product_availability": "A",
                "discount_information": {
                    "amount_product": "100000.00",
                    "amount_discount": "100.00",
                    "discount_unit": "P",
                    "truncation_unit": "10",
                    "max_discount": "10.00"
                },
                "mileage_information": {
                    "amount_product": "100000.00",
                    "amount_discount": "20.00",
                    "discount_unit": "P",
                    "truncation_unit": "100",
                    "max_discount": "100.00"
                },
                "mobile_discount_information": {
                    "amount_product": "100000.00",
                    "amount_discount": "20.00",
                    "discount_unit": "P",
                    "truncation_unit": "100",
                    "max_discount": "100.00"
                },
                "mobile_mileage_information": {
                    "amount_product": "100000.00",
                    "amount_discount": "20.00",
                    "discount_unit": "P",
                    "truncation_unit": "100",
                    "max_discount": "100.00"
                }
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 会員 閲覧権限 (READ_CUSTOMER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    group_no

    会員ランク番号

    システムにより会員ランクに付与された番号

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

    group_name

    Max Length : [20]

    会員ランク名

    会員ランクの作成時に指定した会員ランクの名前

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

    Count all customergroup

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customergroup/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customergroup/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 1
    }
    

    基本スペック

    Property Description
    SCOPE 会員 閲覧権限 (READ_CUSTOMER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    group_no

    会員ランク番号

    システムにより会員ランクに付与された番号

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

    group_name

    Max Length : [20]

    会員ランク名

    会員ランクの作成時に指定した会員ランクの名前

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

    Get a customergroup

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customergroup/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customergroup/1' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "customergroup": {
            "shop_no": "1",
            "group_no": "1",
            "group_name": "Standard Membership",
            "group_description": "Group information",
            "benefits_paymethod": "A",
            "buy_benefits": "D",
            "ship_benefits": "F",
            "product_availability": "A",
            "discount_information": {
                "amount_product": "100000.00",
                "amount_discount": "100.00",
                "discount_unit": "P",
                "truncation_unit": "10",
                "max_discount": "10.00"
            },
            "mileage_information": {
                "amount_product": "100000.00",
                "amount_discount": "20.00",
                "discount_unit": "P",
                "truncation_unit": "100",
                "max_discount": "100.00"
            },
            "mobile_discount_information": {
                "amount_product": "100000.00",
                "amount_discount": "20.00",
                "discount_unit": "P",
                "truncation_unit": "100",
                "max_discount": "100.00"
            },
            "mobile_mileage_information": {
                "amount_product": "100000.00",
                "amount_discount": "20.00",
                "discount_unit": "P",
                "truncation_unit": "100",
                "max_discount": "100.00"
            }
        }
    }
    

    基本スペック

    Property Description
    SCOPE 会員 閲覧権限 (READ_CUSTOMER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    group_no
    Required

    会員ランク番号

    システムにより会員ランクに付与された番号

    Customers

    Customers Entity構造

    会員(Customers)はショップの商品を購入する顧客の中でショップのクーポン、ポイント、割引などの特典をもらうために登録した顧客です。会員を管理するためにショップの運営者は会員を特定会員ランクに分類したり特別会員に指定することができます。

    Customers properties

    Attribute Description
    shop_no

    ショップ番号

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

    member_id

    Max Length : [20]

    会員ID

    会員ID

    name

    お名前

    会員の名前

    available_mileage

    有効ポイント

    使用可能なポイント

    group_no

    会員ランク番号

    会員ランクの番号

    member_authentication

    会員認証の有無

    会員認証の設定。認証によって会員は4種類に区分される。認証会員を特別管理会員に設定する場合、その会員は一番最後に設定した特別管理会員として表示される。

    T:認証
    F:未認証
    B:特別管理会員
    J:14歳未満の会員

    use_blacklist

    要注意会員の設定

    要注意会員に設定。要注意会員の場合はそのタイプによって商品購入ブロックやログインブロック、または商品購入とログインを両方ブロックすることができる。

    T:設定する
    F:設定しない

    blacklist_type

    要注意会員のブロック設定

    要注意会員のタイプ。要注意会員のタイプによって商品購入ブロックやログインブロック、または商品購入とログインを両方ブロックすることができる。

    P:商品購入ブロック
    L:ログインブロック
    A:商品購入&ログインブロック

    Search customers

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customers'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers?cellphone=010-1000-0000' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "customers": [
            {
                "shop_no": 1,
                "member_id": "sampleid",
                "name": "Jo****",
                "available_mileage": "00.00",
                "group_no": 1,
                "member_authentication": "T",
                "use_blacklist": "F",
                "blacklist_type": ""
            },
            {
                "shop_no": 1,
                "member_id": "sampleid01",
                "name": "Ja****",
                "available_mileage": "00.00",
                "group_no": 1,
                "member_authentication": "T",
                "use_blacklist": "F",
                "blacklist_type": ""
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 会員 閲覧権限 (READ_CUSTOMER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    cellphone
    Required

    携帯電話

    ショップの会員を検索する携帯電話番号。個人情報の保護のため、携帯電話番号をすべて入力しないと検索できない。

    Customers memos

    Customers memos properties

    Attribute Description
    shop_no

    ショップ番号

    memo_no

    メモ番号

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

    author_id

    作成者ID

    メモを作成した管理者のID情報

    memo

    メモ内容

    メモの内容。HTMLを使って登録できる。

    important_flag

    重要メモの有無

    重要メモを区分するかどうかを設定

    T:重要メモ
    F:一般メモ

    created_date

    timezone

    作成日

    メモを作成した時間

    Count all customers memos

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/memos/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/testmember/memos/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    基本スペック

    Property Description
    SCOPE 会員 閲覧権限 (READ_CUSTOMER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    member_id
    Required

    会員ID

    会員ID

    List all customers memos

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/memos'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/testmember/memos' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "memos": [
            {
                "shop_no": 1,
                "memo_no": 1,
                "author_id": "subadmin1",
                "memo": "This is a sample memo.",
                "important_flag": "T",
                "created_date": "2018-01-18T11:19:27+09:00"
            },
            {
                "shop_no": 1,
                "memo_no": 2,
                "author_id": "subadmin2",
                "memo": "This is a sample memo.",
                "important_flag": "F",
                "created_date": "2018-01-18T11:19:27+09:00"
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 会員 閲覧権限 (READ_CUSTOMER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    member_id
    Required

    会員ID

    会員ID

    limit

    Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [10000]

    検索結果の開始位置

    検索結果の開始位置

    Get a customers memo

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/memos/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/testmember/memos/1' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "memo": {
            "shop_no": 1,
            "memo_no": 1,
            "author_id": "subadmin1",
            "memo": "This is a sample memo.",
            "important_flag": "T",
            "created_date": "2018-01-18T11:19:27+09:00"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 会員 閲覧権限 (READ_CUSTOMER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    memo_no
    Required

    メモ番号

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

    member_id
    Required

    会員ID

    会員ID

    Create a customers memo

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/memos'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/testmember/memos' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "author_id": "subadmin1",
            "memo": "This is a sample memo.",
            "important_flag": "T"
        }
    }'
    

    Response example:

    {
        "memo": {
            "shop_no": 1,
            "memo_no": 1,
            "author_id": "subadmin1",
            "memo": "This is a sample memo.",
            "important_flag": "T",
            "created_date": "2018-01-18T11:19:27+09:00"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 会員 投稿権限 (WRITE_CUSTOMER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    member_id
    Required

    会員ID

    会員ID

    author_id
    Required

    Max Length : [20]

    作成者ID

    メモを作成した管理者のID情報

    memo
    Required

    メモ

    メモの内容。HTMLを使って登録できる。

    important_flag

    重要メモの有無

    重要メモを区分するかどうかを設定

    T:重要メモ
    F:一般メモ

    DEFAULT F

    Update a customers memo

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/memos/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/testmember/memos/3' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "author_id": "subadmin1",
            "memo": "This is a sample memo.",
            "important_flag": "T"
        }
    }'
    

    Response example:

    {
        "memo": {
            "shop_no": 1,
            "memo_no": 1,
            "author_id": "subadmin1",
            "memo": "This is a sample memo.",
            "important_flag": "T",
            "created_date": "2018-01-18T11:19:27+09:00"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 会員 投稿権限 (WRITE_CUSTOMER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    memo_no
    Required

    メモ番号

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

    member_id
    Required

    会員ID

    会員ID

    author_id
    Required

    Max Length : [20]

    作成者ID

    メモを作成した管理者のID情報

    memo

    メモ

    メモの内容。HTMLを使って登録できる。

    important_flag

    重要メモの有無

    重要メモを区分するかどうかを設定

    T:重要メモ
    F:一般メモ

    Delete a customers memo

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/memos/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/testmember/memos/3' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "memo": {
            "shop_no": 1,
            "memo_no": 3
        }
    }
    

    基本スペック

    Property Description
    SCOPE 会員 投稿権限 (WRITE_CUSTOMER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    memo_no
    Required

    メモ番号

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

    member_id
    Required

    会員ID

    会員ID

    Customers reviews

    顧客レビュー(Customer Reviews)はショップの顧客が作成したレビューの顧客別リストを確認する関係型Entityです。

    Customers reviews properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    product_no

    상품번호

    商品番号

    review_no

    리뷰 번호

    order_id

    Order ID

    주문 번호

    nickname

    작성자 별명

    title

    리뷰 제목

    content

    리뷰 내용

    content_text_length

    리뷰글 텍스트 길이

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    writer

    작성자명

    writing_id

    작성자 회원 아이디

    created_date

    Date
    timezone

    작성일자

    comment_count

    댓글 갯수

    like_count

    Min : [0]

    좋아요 횟수

    share_count

    Min : [0]

    SNS 공유 횟수

    hit_count

    Min : [0]

    조회수

    additional_information

    추가 항목

    images

    첨부 이미지

    レビューに添付する画像

    tags

    해시태그

    rating

    평점

    use_share

    SNS 공유 여부

    レビューのSNSシェアの有無

    T : 공유함
    F : 공유안함

    display

    게시 여부

    レビューの掲示の有無

    T : 게시함
    F : 게시안함

    deleted

    삭제 여부

    レビューの削除の有無

    T : 삭제됨
    F : 삭제되지 않음

    List all customers reviews

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/reviews'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/reviews' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "reviews": [
            {
                "shop_no": 1,
                "product_no": 10,
                "review_no": 1,
                "order_id": "20180116-0000001",
                "nickname": "",
                "title": "#recommend #popular product.",
                "content": "#recommend #popular product.",
                "content_text_length": 16,
                "input_channel": "P",
                "writer": "John Doe",
                "writing_id": "user1",
                "created_date": "2018-01-17T17:57:40+09:00",
                "comment_count": 0,
                "like_count": 0,
                "share_count": 0,
                "hit_count": 0,
                "additional_information": [
                    {
                        "item_name": "Height",
                        "item_value": "170~180"
                    },
                    {
                        "item_name": "Size",
                        "item_value": "95"
                    }
                ],
                "images": [
                    {
                        "name": "39a9e7d3892c58034cd2357f74e5b04f.PNG",
                        "size": 143543,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/5358112ce7e01d423597ccd51eeb415a.PNG",
                        "thumb": {
                            "size": 222879,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/5358112ce7e01d423597ccd51eeb415a.PNG",
                            "width": 300,
                            "height": 409,
                            "tiny": {
                                "size": 12104,
                                "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/5358112ce7e01d423597ccd51eeb415a.PNG"
                            }
                        }
                    },
                    {
                        "name": "82c5736941ee04e49a172f620b3f1685.jpg",
                        "size": 83742,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/820ca38030768fc4dcc88789f75341c3.jpg",
                        "thumb": {
                            "size": 7779,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/820ca38030768fc4dcc88789f75341c3.jpg",
                            "width": 300,
                            "height": 200,
                            "tiny": {
                                "size": 1983,
                                "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/820ca38030768fc4dcc88789f75341c3.jpg"
                            }
                        }
                    }
                ],
                "tags": [
                    "cool",
                    "best"
                ],
                "rating": 3,
                "use_share": "F",
                "display": "T",
                "deleted": "T"
            },
            {
                "shop_no": 1,
                "product_no": 12,
                "review_no": 2,
                "order_id": "20180108-0000039",
                "nickname": "",
                "title": "Good Product.",
                "content": "Good!",
                "content_text_length": 8,
                "input_channel": "P",
                "writer": "John Doe",
                "writing_id": "user1",
                "created_date": "2018-01-08T11:46:56+09:00",
                "comment_count": 0,
                "like_count": 0,
                "share_count": 0,
                "hit_count": 0,
                "additional_information": "",
                "images": null,
                "tags": [],
                "rating": 5,
                "use_share": "T",
                "display": "T",
                "deleted": "F"
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 掲示板 閲覧権限 (READ_COMMUNITY)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no

    리뷰 번호

    writing_id
    Required

    작성자 회원 아이디

    created_start_date

    Date
    timezone

    작성일 검색 시작일

    レビュー作成日基準検索の検索開始日
    検索終了日と必ずペアで使用すること。

    created_end_date

    Date
    timezone

    작성일 검색 종료일

    レビュー作成日基準検索の検索終了日
    検索開始日と必ずペアで使用すること。

    deleted

    삭제된 리뷰글 여부

    T : 삭제됨
    F : 삭제되지 않음

    DEFAULT F

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    has_comment

    댓글이 작성된 리뷰만 검색

    T : 댓글이 작성된 리뷰만 검색
    F : 댓글이 작성되지 않은 리뷰만 검색

    has_image

    이미지가 첨부된 리뷰만 검색

    T : 이미지가 첨부된 리뷰만 검색
    F : 이미지가 첨부되지 않은 리뷰만 검색

    search_key

    검색 대상 항목

    writer : 작성자명
    writing_id : 작성자 회원 아이디
    content : 리뷰 내용
    product_no : 상품 번호
    product_name : 상품명
    product_code : 상품 코드

    keyword

    검색어

    mileage

    적립금 지급 여부

    todo : 지급안함
    done : 지급함

    limit

    Min : [1]

    목록에 표시 할 목록 갯수

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

    DEFAULT 50

    offset

    Min : [0]

    목록을 가져올 시작 위치

    検索結果の開始位置

    Get a customers review

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/reviews/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/user1/reviews/1' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "review": {
            "shop_no": 1,
            "product_no": 10,
            "review_no": 1,
            "order_id": "20180116-0000001",
            "nickname": "",
            "title": "#recommend #popular product.",
            "content": "#recommend #popular product.",
            "content_text_length": 28,
            "input_channel": "P",
            "writer": "John Doe",
            "writing_id": "user1",
            "created_date": "2018-01-17T17:57:40+09:00",
            "comment_count": 0,
            "like_count": 0,
            "share_count": 0,
            "hit_count": 0,
            "additional_information": [
                {
                    "item_name": "Height",
                    "item_value": "170~180"
                },
                {
                    "item_name": "Size",
                    "item_value": "95"
                }
            ],
            "images": [
                {
                    "name": "39a9e7d3892c58034cd2357f74e5b04f.PNG",
                    "size": 143543,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/5358112ce7e01d423597ccd51eeb415a.PNG",
                    "thumb": {
                        "size": 222879,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/5358112ce7e01d423597ccd51eeb415a.PNG",
                        "width": 300,
                        "height": 409,
                        "tiny": {
                            "size": 12104,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/5358112ce7e01d423597ccd51eeb415a.PNG"
                        }
                    }
                },
                {
                    "name": "82c5736941ee04e49a172f620b3f1685.jpg",
                    "size": 83742,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/820ca38030768fc4dcc88789f75341c3.jpg",
                    "thumb": {
                        "size": 7779,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/820ca38030768fc4dcc88789f75341c3.jpg",
                        "width": 300,
                        "height": 200,
                        "tiny": {
                            "size": 1983,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/820ca38030768fc4dcc88789f75341c3.jpg"
                        }
                    }
                }
            ],
            "tags": [
                "recommend",
                "popular"
            ],
            "rating": 4.5,
            "use_share": "F",
            "display": "T",
            "deleted": "T"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 掲示板 閲覧権限 (READ_COMMUNITY)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    writing_id
    Required

    작성자 회원 아이디

    review_no
    Required

    리뷰 번호

    Count all customers reviews

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/reviews/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/user1/reviews/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    基本スペック

    Property Description
    SCOPE 掲示板 閲覧権限 (READ_COMMUNITY)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    writing_id
    Required

    작성자 회원 아이디

    created_start_date

    Date
    timezone

    작성일 검색 시작일

    レビュー作成日基準検索の検索開始日
    検索終了日と必ずペアで使用すること。

    created_end_date

    Date
    timezone

    작성일 검색 종료일

    レビュー作成日基準検索の検索終了日
    検索開始日と必ずペアで使用すること。

    deleted

    삭제된 리뷰글 여부

    T : 삭제됨
    F : 삭제되지 않음

    DEFAULT F

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    has_comment

    댓글이 작성된 리뷰만 검색

    T : 댓글이 작성된 리뷰만 검색
    F : 댓글이 작성되지 않은 리뷰만 검색

    has_image

    이미지가 첨부된 리뷰만 검색

    T : 이미지가 첨부된 리뷰만 검색
    F : 이미지가 첨부되지 않은 리뷰만 검색

    search_key

    검색 대상 항목

    writer : 작성자명
    writing_id : 작성자 회원 아이디
    content : 리뷰 내용
    product_no : 상품 번호
    product_name : 상품명
    product_code : 상품 코드

    keyword

    검색어

    mileage

    적립금 지급 여부

    todo : 지급안함
    done : 지급함

    Customersprivacy

    Customersprivacy properties

    Attribute Description
    shop_no

    ショップ番号

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

    member_id

    Max Length : [20]

    会員ID

    会員ID

    name

    お名前

    会員の名前

    name_english

    お名前(ローマ字)

    会員の名前(ローマ字)

    name_phonetic

    お名前(フリガナ)(日本語)

    会員の名前のフリガナ表記

    phone

    電話番号

    会員の固定電話番号

    cellphone

    携帯電話

    会員の携帯電話番号

    email

    メールアドレス

    会員のメールアドレス

    sms

    SMS

    SMSを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。

    T:受信する
    F:受信しない

    news_mail

    メールマガジン受信の有無

    Eメールを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。「絶対受信しない」の場合は主要メールを含めてすべてのメールを受信しない。

    T:受信する
    F:受信しない

    wedding_anniversary

    Date

    結婚記念日

    会員の結婚記念日

    birthday

    Date

    誕生日

    会員の生年月日

    solar_calendar

    新暦/旧暦

    誕生日が新暦か旧暦かを表示

    T:新暦
    F:旧暦

    total_mileage

    ポイント合計

    会員のポイントの合計

    available_mileage

    有効ポイント

    使用可能なポイント

    used_mileage

    ポイント利用額

    会員が使ったポイント

    address1

    Max Length : [255]

    基本住所

    会員の基本住所(市区町村)

    address2

    Max Length : [255]

    詳細住所

    会員の詳細住所

    group_no

    会員ランク番号

    会員ランクの番号

    job_class

    職種

    会員の職種

    job

    職業

    会員の職業

    zipcode

    Max Length : [14]

    郵便番号

    created_date

    timezone

    登録日

    会員登録した日

    member_authentication

    会員認証の有無

    会員認証の設定。認証によって会員は4種類に区分される。認証会員を特別管理会員に設定する場合、その会員は一番最後に設定した特別管理会員として表示される。

    T:認証
    F:未認証
    B:特別管理会員
    J:14歳未満の会員

    use_blacklist

    要注意会員の設定

    要注意会員に設定。要注意会員の場合はそのタイプによって商品購入ブロックやログインブロック、または商品購入とログインを両方ブロックすることができる。

    T:設定する
    F:設定しない

    pointfy_member

    統合メンバーシップ会員の有無

    統合メンバーシップを利用するかどうかを設定。統合メンバーシップはブランドが一つで、実店舗と統合したい場合に利用できるサービスである。

    T:設定する
    F:設定しない

    blacklist_type

    要注意会員のブロック設定

    要注意会員のタイプ。要注意会員のタイプによって商品購入ブロックやログインブロック、または商品購入とログインを両方ブロックすることができる。

    P:商品購入ブロック
    L:ログインブロック
    A:商品購入&ログインブロック

    last_login_date

    timezone

    直近のアクセス日時

    会員が最終ログインした日時

    member_authority

    会員権限区分

    会員権限の区分。会員権限は一般会員、代表運営者、副運営者、供給会社に区分される。

    C:一般会員
    P:代表運営者
    A:副運営者
    S:供給会社

    nick_name

    Max Length : [50]

    運営者ニックネーム

    会員のニックネーム

    recommend_id

    紹介者ID

    会員登録時に入力した紹介者のID

    residence

    地域コード

    会員の居住地域

    interest

    関心分野

    会員の関心事

    gender

    性別

    会員の性別

    M:男性
    F:女性

    member_type

    会員タイプ

    会員のタイプ

    p:個人
    c:事業者
    f:外国人

    company_type

    事業者区分

    会員タイプが事業者の場合

    p:個人事業者
    c:法人事業者

    foreigner_type

    外国人の認証方法

    外国人会員の認証方法

    f:外国人登録番号
    p:パスポート番号
    d:国際運転免許証

    corporate_name

    法人名

    会員の法人名

    nationality

    国籍

    会員が「外国人」の場合、その会員の国籍

    shop_name

    ショップ名

    会員の商号

    country_code

    国コード

    会員登録時に入力した国家

    use_mobile_app

    スマホアプリ使用の設定

    会員のモバイルアプリ使用の設定

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

    available_deposit

    使用可能な預り金

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

    additional_information

    追加項目

    会員の追加項目
    会員詳細検索APIでしか確認できない。

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

    List all customersprivacy

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customersprivacy'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customersprivacy' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "customersprivacy": [
            {
                "shop_no": 1,
                "member_id": "sampleid",
                "name": "John Doe",
                "name_english": "John Doe",
                "name_phonetic": "John Doe",
                "phone": "02-0000-0000",
                "cellphone": "010-000-0000",
                "email": "sample@sample.com",
                "wedding_anniversary": "2018-06-20",
                "birthday": "2018-06-20",
                "solar_calendar": "T",
                "total_mileage": "0.00",
                "available_mileage": "0.00",
                "used_mileage": "0.00",
                "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
                "address2": "Professional Construction Hall",
                "group_no": 1,
                "job": "self-employment",
                "job_class": "service",
                "zipcode": "07071",
                "created_date": "2018-01-18T11:19:27+09:00",
                "member_authentication": "T",
                "use_blacklist": "F",
                "pointfy_member": "F",
                "blacklist_type": "",
                "last_login_date": "2018-01-18T11:19:27+09:00",
                "member_authority": "C",
                "nick_name": "nickname",
                "recommend_id": "testid2",
                "residence": "Seoul",
                "interest": "animation, movie\/theater",
                "gender": "F",
                "member_type": "p",
                "company_type": "p",
                "foreigner_type": "f",
                "corporate_name": "Sample company",
                "nationality": "Korea",
                "shop_name": "Sample Shop",
                "country_code": "KR",
                "use_mobile_appp": "F"
            },
            {
                "shop_no": 1,
                "member_id": "sampleid01",
                "name": "Jane Doe",
                "name_english": "Jane Doe",
                "name_phonetic": "Jane Doe",
                "phone": "02-0000-0000",
                "cellphone": "010-000-0000",
                "email": "sample@sample.com",
                "wedding_anniversary": "2018-06-20",
                "birthday": "2018-06-20",
                "solar_calendar": "T",
                "total_mileage": "0.00",
                "available_mileage": "0.00",
                "used_mileage": "0.00",
                "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
                "address2": "Professional Construction Hall",
                "group_no": 1,
                "job": "self-employment",
                "job_class": "service",
                "zipcode": "07071",
                "created_date": "2018-01-18T11:19:27+09:00",
                "member_authentication": "T",
                "use_blacklist": "F",
                "pointfy_member": "F",
                "blacklist_type": "",
                "last_login_date": "2018-01-18T11:19:27+09:00",
                "member_authority": "C",
                "nick_name": "nickname",
                "recommend_id": "testid2",
                "residence": "Seoul",
                "interest": "animation, movie\/theater",
                "gender": "F",
                "member_type": "p",
                "company_type": "p",
                "foreigner_type": "f",
                "corporate_name": "Sample company",
                "nationality": "Korea",
                "shop_name": "Sample Shop",
                "country_code": "KR",
                "use_mobile_appp": "F"
            }
        ]
    }
    

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    search_type

    検索タイプ

    会員検索の際に、会員情報もしくは登録日のうち、どちらかを検索基準に設定して検索することができる。
    登録日で検索する場合、offsetと関係なくすべての会員を検索することができる。

    ※登録日を基準にすると、created_start_dateを除くすべての検索条件は、使用できない。

    customer_info : 会員情報に基づいて検索
    created_date : 登録日を基準に検索

    DEFAULT customer_info

    created_start_date

    Date
    timezone

    登録日を基準に検索する場合の検索開始日

    search_typeがcreated_dateである場合、登録日基準の検索開始日を意味する。該当登録日以降に登録した会員を検索することができる。

    member_id

    Max Length : [20]

    会員ID

    会員ID

    news_mail

    メールマガジン受信の有無

    Eメールを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。「絶対受信しない」の場合は主要メールを含めてすべてのメールを受信しない。

    T:受信する
    F:受信しない

    sms

    SMS

    SMSを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。

    T:受信する
    F:受信しない

    group_no

    会員ランク番号

    会員ランクの番号

    search_field

    検索フィールド

    検索したい会員の検索フィールド

    id:アイディー
    name:お名前
    hp:携帯電話番号
    tel:電話番号
    mail:メールアドレス

    keyword

    検索キーワード

    検索したい会員の検索フィールドに対する検索キーワードを入力する。
    ex) search_field : mail
    keyword : cafe24@cafe24.com

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

    date_type

    検索日付のタイプ

    検索の基準となる検索フィールド。「会員登録日」基準で検索する場合は検索開始日と検索終了日の期間は会員登録日基準になる。

    join:会員登録日
    login:最終アクセス日
    age:生年月日

    start_date

    Date
    timezone

    検索開始日

    特定の検索基準に対する検索開始日
    検索終了日と必ずペアで使用すること。
    検索開始日と終了日が同じ場合は該当日でのみ検索する。
    ex) 2018-12-31 00:00:00

    end_date

    Date
    timezone

    検索終了日

    特定の検索基準に対する検索終了日
    検索開始日と必ずペアで使用すること。
    検索開始日と終了日が同じ場合は該当日でのみ検索する。
    ex) 2018-12-31 23:59:59

    member_type

    会員タイプ

    会員のタイプ

    vip:特別管理会員
    poor:ブラックリスト
    pointfy:統合メンバーシップ利用者

    residence

    地域コード

    会員の居住地域

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

    gender

    性別

    会員の性別

    M:男性
    F:女性

    member_authority

    会員権限区分

    会員権限の区分。会員権限は一般会員、代表運営者、副運営者、供給会社に区分される。

    C:一般会員
    P:代表運営者
    A:副運営者
    S:供給会社

    DEFAULT C

    limit

    Max : [1000]

    検索結果の最大件数

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

    DEFAULT 30

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    Count all customersprivacy

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customersprivacy/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customersprivacy/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    search_type

    検索タイプ

    会員検索の際に、会員情報もしくは登録日のうち、どちらかを検索基準に設定して検索することができる。
    登録日で検索する場合、offsetと関係なくすべての会員を検索することができる。

    ※登録日を基準にすると、created_start_dateを除くすべての検索条件は、使用できない。

    customer_info : 会員情報に基づいて検索
    created_date : 登録日を基準に検索

    DEFAULT customer_info

    created_start_date

    Date
    timezone

    登録日を基準に検索する場合の検索開始日

    search_typeがcreated_dateである場合、登録日基準の検索開始日を意味する。該当登録日以降に登録した会員を検索することができる。

    member_id

    Max Length : [20]

    会員ID

    会員ID

    news_mail

    メールマガジン受信の有無

    Eメールを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。「絶対受信しない」の場合は主要メールを含めてすべてのメールを受信しない。

    T:受信する
    F:受信しない

    sms

    SMS

    イベントSMSを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。

    T:受信する
    F:受信しない

    group_no

    会員ランク番号

    会員ランクの番号

    search_field

    検索フィールド

    検索したい会員の検索フィールド

    id:アイディー
    name:お名前
    hp:携帯電話番号
    tel:電話番号
    mail:メールアドレス

    keyword

    検索キーワード

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

    date_type

    検索日付のタイプ

    join:会員登録日
    login:最終アクセス日
    age:生年月日

    start_date

    Date
    timezone

    検索開始日

    特定の検索基準に対する検索開始日
    検索終了日と必ずペアで使用すること。
    検索開始日と終了日が同じ場合は該当日でのみ検索する。
    ex) 2018-12-31 00:00:00

    end_date

    Date
    timezone

    検索終了日

    特定の検索基準に対する検索終了日
    検索開始日と必ずペアで使用すること。
    検索開始日と終了日が同じ場合は該当日でのみ検索する。
    ex) 2018-12-31 23:59:59

    member_type

    会員タイプ

    会員のタイプ

    vip:特別管理会員
    poor:ブラックリスト
    pointfy:統合メンバーシップ利用者

    residence

    地域コード

    会員の居住地域

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

    gender

    性別

    会員の性別

    M:男性
    F:女性

    member_authority

    会員権限区分

    会員権限の区分。会員権限は一般会員、代表運営者、副運営者、供給会社に区分される。

    C:一般会員
    P:代表運営者
    A:副運営者
    S:供給会社

    DEFAULT C

    Get a customersprivacy

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customersprivacy/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customersprivacy/sampleid' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "customersprivacy": {
            "shop_no": 1,
            "member_id": "sampleid",
            "name": "John Doe",
            "name_english": "John Doe",
            "name_phonetic": "John Doe",
            "phone": "02-0000-0000",
            "cellphone": "010-000-0000",
            "email": "sample@sample.com",
            "wedding_anniversary": "2018-06-20",
            "birthday": "2018-06-20",
            "solar_calendar": "T",
            "total_mileage": "0.00",
            "available_mileage": "0.00",
            "used_mileage": "0.00",
            "available_deposit": "0.00",
            "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "address2": "Professional Construction Hall",
            "group_no": 1,
            "job": "self-employment",
            "job_class": "service",
            "zipcode": "07071",
            "created_date": "2018-01-18T11:19:27+09:00",
            "member_authentication": "T",
            "use_blacklist": "F",
            "pointfy_member": "F",
            "blacklist_type": "",
            "last_login_date": "2018-01-18T11:19:27+09:00",
            "member_authority": "C",
            "nick_name": "nickname",
            "recommend_id": "testid2",
            "residence": "Seoul",
            "interest": "animation, movie\/theater",
            "gender": "F",
            "member_type": "p",
            "company_type": "p",
            "foreigner_type": "f",
            "corporate_name": "Sample company",
            "nationality": "Korea",
            "shop_name": "Sample Shop",
            "country_code": "KR",
            "use_mobile_appp": "F",
            "additional_information": []
        }
    }
    

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    member_id
    Required

    Max Length : [20]

    会員ID

    会員ID

    Dashboard

    ダッシュボード(Dashboard)はショップの注文現況や売上現況などショップの運営に必要な情報を簡単に要約しておいた情報です。

    Dashboard properties

    Attribute Description
    shop_no

    ショップ番号

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

    daily_sales_stats

    日次現況情報

    一日単位の売上状況に関する情報

    weekly_sales_stats

    週間売上状況

    一週間単位の売上現況情報

    monthly_sales_stats

    月間売上状況

    一カ月単位の売上現況情報

    sold_out_products_count

    在庫切れ商品数

    在庫切れとなった商品数。在庫管理機能と在庫切れ機能が有効になっている場合は集計に含まれる。

    new_members_count

    新規会員数

    新規登録した会員数

    board_list

    掲示板リスト

    ショップの掲示板リスト

    Get dashboard

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/dashboard'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/dashboard' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "dashboard": [
            {
                "shop_no": 1,
                "daily_sales_stats": [
                    {
                        "title": "December 20",
                        "date": "2017-12-20",
                        "order_price": "0.00",
                        "payed_price": "0.00",
                        "refund_price": "0.00",
                        "order_count": 0,
                        "payed_count": 0,
                        "refund_count": 0,
                        "preparing_products_count": 0,
                        "preparing_shipment_count": 0,
                        "waiting_shipment_count": 0,
                        "delivering_count": 0,
                        "shipend_count": 0,
                        "canceled_count": 0,
                        "returned_count": 0,
                        "exchanged_count": 0,
                        "ordered_total_count": 0
                    },
                    {
                        "title": "December 21 (Today)",
                        "date": "2017-12-21",
                        "order_price": "0.00",
                        "payed_price": "0.00",
                        "refund_price": "0.00",
                        "order_count": 0,
                        "payed_count": 0,
                        "refund_count": 0,
                        "preparing_products_count": 0,
                        "preparing_shipment_count": 0,
                        "waiting_shipment_count": 0,
                        "delivering_count": 0,
                        "shipend_count": 0,
                        "canceled_count": 0,
                        "returned_count": 0,
                        "exchanged_count": 0,
                        "ordered_total_count": 0
                    }
                ],
                "weekly_sales_stats": {
                    "ordered_total_price": "0.00",
                    "payed_total_price": "0.00",
                    "refunded_total_price": "0.00",
                    "ordered_count": 0,
                    "payed_count": 0,
                    "refunded_count": 0,
                    "ordered_average_total_price": "0.00",
                    "payed_average_total_price": "0.00",
                    "refunded_average_total_price": "0.00",
                    "ordered_average_count": 0,
                    "payed_average_count": 0,
                    "refunded_average_count": 0
                },
                "monthly_sales_stats": {
                    "ordered_total_price": "0.00",
                    "payed_total_price": "0.00",
                    "refunded_total_price": "0.00",
                    "ordered_count": 0,
                    "payed_count": 0,
                    "refunded_count": 0,
                    "ordered_average_total_price": "0.00",
                    "payed_average_total_price": "0.00",
                    "refunded_average_total_price": "0.00",
                    "ordered_average_count": 0,
                    "payed_average_count": 0,
                    "refunded_average_count": 0
                },
                "sold_out_products_count": 0,
                "new_members_count": 0,
                "board_list": [
                    {
                        "type ": "B ",
                        "board_no ": 1,
                        "board_name ": "공지사항 ",
                        "new_registered_count ": 0,
                        "page_url ": "\/disp\/admin\/mobile\/index#\/bulletins?board_no=1"
                    },
                    {
                        "type ": "B ",
                        "board_no ": 2,
                        "board_name ": "뉴스\/이벤트 ",
                        "new_registered_count ": 0,
                        "page_url ": "\/disp\/admin\/mobile\/index#\/bulletins?board_no=2"
                    }
                ]
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE ショップ 閲覧権限 (READ_STORE)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    Mains

    Mains Entity関係図

    メインカテゴリ(Mains)はショップの商品をトップページに表示できる商品カテゴリです。

    Mains properties

    Attribute Description
    shop_no

    ショップ番号

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

    module_code

    モジュールコード

    各メインカテゴリに指定されたモジュールコード

    display_group

    メインカテゴリ番号

    group_name

    メインカテゴリ名

    メインカテゴリの生成時に指定したカテゴリ名

    soldout_sort_type

    在庫切れ商品の表示

    在庫切れ商品が表示される位置

    B:在庫切れ商品を一番後ろに
    F:在庫切れ商品を一番前に
    N:在庫切れ商品関係なし

    List all mains

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/mains'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/mains' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "mains": [
            {
                "shop_no": 1,
                "module_code": "product_listmain_1",
                "display_group": 2,
                "group_name": "Main Recommendations",
                "soldout_sort_type": "B"
            },
            {
                "shop_no": 1,
                "module_code": "product_listmain_2",
                "display_group": 3,
                "group_name": "New Arrival",
                "soldout_sort_type": "F"
            }
        ]
    }
    

    基本スペック

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

    Mains products

    Mains products properties

    Attribute Description
    shop_no

    ショップ番号

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

    product_no

    商品番号

    product_name

    商品名

    display_order

    表示順序

    商品の表示順位

    メイン表示に表示される順序を示す。表示される順序は表示されていた商品が削除された場合、順次に表示されないこともある。
    例)4番目の商品が削除された場合、1、2、3、5、6、7… のような順序で表示されることがある。

    表示順位を固定した商品には表示順位に数字9,999,999がプラスされる。
    例)表示順位3の商品(display_order=3)を固定する場合、display_order=10,000,002

    List all mains products

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/mains/2/products' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "products": [
            {
                "shop_no": 1,
                "product_no": 7,
                "product_name": "product_name",
                "display_order": 1
            },
            {
                "shop_no": 1,
                "product_no": 8,
                "product_name": "product_name2",
                "display_order": 10000002
            }
        ]
    }
    

    基本スペック

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

    要求スペック

    Parameter Description
    display_group
    Required

    メインカテゴリ番号

    Count all mains products

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/mains/2/products/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    基本スペック

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

    要求スペック

    Parameter Description
    display_group
    Required

    メインカテゴリ番号

    Create a mains product

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/mains/{#id}/products'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/mains/2/products' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "product_no": [
                7,
                8,
                9
            ]
        }
    }'
    

    Response example:

    {
        "product": {
            "shop_no": 1,
            "product_no": [
                7,
                8,
                9
            ]
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    display_group
    Required

    メインカテゴリ番号

    product_no
    Required

    商品番号

    Update a mains product

    メイン表示商品の修正は順序の変更のみ可能で、そのAPIでメイン表示に商品を追加したり削除する動作は提供しません。変更前にList all Mains products APIでメイン表示商品リストを検索した後、検索した項目そのまま順序だけ変更して修正APIに追加してください。

    最大200個の商品が表示されているメインカテゴリのみ表示順序の調整ができます。

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/mains/{#id}/products'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/mains/2/products' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "product_no": [
                7,
                8,
                9
            ],
            "fix_product_no": [
                8,
                9
            ]
        }
    }'
    

    Response example:

    {
        "product": {
            "shop_no": 1,
            "product_no": [
                7,
                8,
                9
            ]
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    display_group
    Required

    メインカテゴリ番号

    product_no
    Required

    商品番号

    要求した商品番号の順序で表示順位が指定される。

    fix_product_no

    表示順位固定商品の番号

    表示順位を固定したい商品番号を指定

    Delete a mains product

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/mains/{#id}/products/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/mains/2/products/7' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "product": {
            "shop_no": 1,
            "product_no": 7
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    display_group
    Required

    メインカテゴリ番号

    product_no
    Required

    商品番号

    Manufacturers

    メーカー(Manufacturers)は商品の「製作情報」の中でメーカーに入力する情報を意味します。メーカーは商品を製作、生産する主体を示し、商品を区分する販売カテゴリの一つです。商品は必ず一つのメーカーを持っています(指定しない場合は「独自メーカー」を使う)。
    メーカー(Manufacturers)の{#id}は「manufacturer_code」です。

    Manufacturers properties

    Attribute Description
    shop_no

    ショップ番号

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

    manufacturer_code

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

    メーカーコード

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

    manufacturer_name

    Max Length : [50]

    メーカー名

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

    president_name

    Max Length : [30]

    代表者名

    メーカーの代表者の名前

    use_manufacturer

    使用設定

    そのメーカーを使うかどうかを表示

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

    email

    Max Length : [255]

    メールアドレス

    メーカーのお問い合わせメールアドレス

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

    phone

    Max Length : [20]

    電話番号

    メーカーの電話番号

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

    homepage

    Max Length : [255]

    ホームページ

    メーカーのホームページアドレス

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

    zipcode

    郵便番号

    メーカーの事業所の郵便番号

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

    address1

    Max Length : [255]

    基本住所

    メーカーの住所(市区町村単位で表記)

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

    address2

    Max Length : [255]

    詳細住所

    メーカーの住所(詳細住所表記)

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

    created_date

    timezone

    作成日

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

    List all manufacturers

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "manufacturers": [
            {
                "shop_no": 1,
                "manufacturer_code": "M0000000",
                "manufacturer_name": "Sample Manufacturer",
                "president_name": "Sample Administrator",
                "use_manufacturer": "T"
            },
            {
                "shop_no": 1,
                "manufacturer_code": "M000000C",
                "manufacturer_name": "Sample Manufacturer",
                "president_name": "Sample Administrator",
                "use_manufacturer": "F"
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 販売カテゴリ 閲覧権限 (READ_COLLECTION)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    manufacturer_code

    メーカーコード

    検索したいメーカーのコード

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

    manufacturer_name

    メーカー名

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

    use_manufacturer

    メーカー使用の設定

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

    limit

    Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    Get a manufacturer

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers/M0000000' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "manufacturer": {
            "shop_no": 1,
            "manufacturer_code": "M0000000",
            "manufacturer_name": "Sample Manufacturer",
            "president_name": "Sample User",
            "email": "sample@sample.com",
            "phone": "010-000-0000",
            "homepage": "http:\/\/sample.com",
            "zipcode": "00000",
            "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "address2": "Professional Construction Hall",
            "created_date": "2018-09-01T15:00:00+09:00",
            "use_manufacturer": "T"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 販売カテゴリ 閲覧権限 (READ_COLLECTION)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    manufacturer_code
    Required

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

    メーカーコード

    Count all manufacturers

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    基本スペック

    Property Description
    SCOPE 販売カテゴリ 閲覧権限 (READ_COLLECTION)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    manufacturer_code

    メーカーコード

    検索したいメーカーのコード

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

    manufacturer_name

    メーカー名

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

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

    use_manufacturer

    メーカー使用の設定

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

    Create a manufacturer

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "manufacturer_name": "Sample Manufacturer",
            "president_name": "Sample User",
            "email": "sample@sample.com",
            "phone": "010-000-0000",
            "homepage": "http:\/\/sample.com",
            "zipcode": "00000",
            "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "address2": "Professional Construction Hall",
            "use_manufacturer": "T"
        }
    }'
    

    Response example:

    {
        "manufacturer": {
            "shop_no": 1,
            "manufacturer_code": "M0000000",
            "manufacturer_name": "Sample Manufacturer",
            "president_name": "Sample User",
            "email": "sample@sample.com",
            "phone": "010-000-0000",
            "homepage": "http:\/\/sample.com",
            "zipcode": "00000",
            "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "address2": "Professional Construction Hall",
            "use_manufacturer": "T"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 販売カテゴリ 投稿権限 (WRITE_COLLECTION)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    manufacturer_name
    Required

    Max Length : [50]

    メーカー名

    president_name
    Required

    Max Length : [30]

    代表者名

    email

    Max Length : [255]
    Email

    メールアドレス

    phone

    Max Length : [20]
    Phone Number

    電話番号

    homepage

    Max Length : [255]

    ホームページ

    zipcode

    郵便番号

    address1

    Max Length : [255]

    基本住所

    address2

    Max Length : [255]

    詳細住所

    use_manufacturer

    使用設定

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

    Update a manufacturer

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers/M000000A' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "manufacturer_name": "Sample Manufacturer",
            "president_name": "Sample User",
            "email": "sample@sample.com",
            "phone": "010-000-0000",
            "homepage": "http:\/\/sample.com",
            "zipcode": "00000",
            "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "address2": "Professional Construction Hall",
            "use_manufacturer": "T"
        }
    }'
    

    Response example:

    {
        "manufacturer": {
            "shop_no": 1,
            "manufacturer_code": "M000000A",
            "manufacturer_name": "Sample Manufacturer",
            "president_name": "Sample User",
            "email": "sample@sample.com",
            "phone": "010-000-0000",
            "homepage": "http:\/\/sample.com",
            "zipcode": "00000",
            "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "address2": "Professional Construction Hall",
            "use_manufacturer": "T"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 販売カテゴリ 投稿権限 (WRITE_COLLECTION)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    manufacturer_code
    Required

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

    メーカーコード

    manufacturer_name

    Max Length : [50]

    メーカー名

    president_name

    Max Length : [30]

    代表者名

    email

    Max Length : [255]
    Email

    メールアドレス

    phone

    Max Length : [20]
    Phone Number

    電話番号

    homepage

    Max Length : [255]

    ホームページ

    zipcode

    郵便番号

    address1

    Max Length : [255]

    基本住所

    address2

    Max Length : [255]

    詳細住所

    use_manufacturer

    使用設定

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

    Mileage

    Mileage properties

    Attribute Description
    amount

    ポイント

    1回あたり最大%s以下までポイントを付与することができます。
    有効ポイントより高い金額を差し引くことはできません。

    type

    ポイント増額・減額の設定

    ポイントを増額するか減額するかを選択することができる。

    reason

    付与の理由

    ポイントを増額・減額する理由を入力することができる。

    Create a mileage

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/mileage'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/mileage' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "member_id": "testmember",
            "amount": "10.00",
            "type": "increase",
            "reason": "test"
        }
    }'
    

    Response example:

    {
        "mileage": {
            "amount": "10.00",
            "type": "increase",
            "reason": "test"
        }
    }
    

    基本スペック

    Property Description
    SCOPE ポイント 投稿権限 (WRITE_MILEAGE)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    member_id
    Required

    Max Length : [20]

    会員ID

    会員ID

    amount
    Required

    Min : [0]

    ポイント

    1回あたり最大%s以下までポイントを付与することができます。
    有効ポイントより高い金額を差し引くことはできません。

    type
    Required

    ポイント増額・減額の設定

    ポイントを増額するか減額するかを選択することができる。

    increase:増額
    decrease:減額

    reason

    付与の理由

    ポイントを増額・減額する理由を入力することができる。

    Orders

    Orders Entity関係図

    注文(order)はショップでショップの顧客が商品を購入するためにショップに要求した内訳です。ショップの運営者は決済済みの注文情報を見てショップの顧客に商品を配送します。注文情報には注文と決済を行った注文者の情報と商品を受け取る受取人の情報が含まれています。

    注文(Orders)の{#id}は「order_id」です。

    注文は下記のようなEntityを下位Entityとして持っています。
    品目別注文(Items)
    受取人情報(Receivers)

    Orders properties

    Attribute Description
    shop_no

    ショップ番号

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

    currency

    通貨単位

    マルチショップの通貨単位

    order_id

    注文番号

    注文番号

    market_id

    モール型ECサイトの区分値

    価格比較サイトを経由してモール型ECサイトなどで商品を購入する場合、そのサイトを区分するためのID

    market_order_info

    モール型ECサイトのその他の情報

    モール型ECサイトまたは注文経路に関するその他の情報

    buyer_name

    注文者名

    注文者の名前。入金者または受取人の名前と異なる場合がある。

    buyer_email

    注文者のメールアドレス

    注文者のメールアドレス。入金者または受取人のメールアドレスと異なる場合がある。

    buyer_phone

    注文者の固定電話番号

    注文者の固定電話番号。入金者または受取人の固定電話番号と異なる場合がある。

    buyer_cellphone

    注文者の携帯電話番号

    注文者の携帯電話番号。入金者または受取人の携帯電話番号と異なる場合がある。

    member_id

    会員ID

    会員ID

    member_authentication

    会員認証の有無

    会員認証の設定。設定によって会員は3つのタイプに分けられる。

    T:承認
    B:特別管理会員
    J:14歳未満の会員

    billing_name

    決済者名

    入金者の名前。注文者または受取人の名前と違う場合がある。

    bank_code

    銀行コード

    入金者の銀行コード

    bank_code_name

    入金銀行名

    入金者の銀行名

    payment_method

    決済方法コード

    注文者が利用した決済方法のコード

    payment_method_name

    決済方法名

    注文者が利用した決済方法の名前

    payment_method_icon

    決済方法アイコン

    決済方法のアイコン

    payment_gateway_name

    決済代行サービス名

    注文者が利用した決済代行会社の名前

    paid

    決済の有無

    決済が完了したかどうかの表示

    T:決済
    F:未決済

    order_date

    timezone

    注文日

    注文日

    first_order

    初注文の有無

    初めての注文であるかどうかの表示

    T:初注文
    F:初注文ではない

    payment_date

    timezone

    決済日

    決済日

    order_from_mobile

    モバイル区分

    注文をモバイルで行ったかどうかの区分

    T:モバイル注文
    F:モバイル注文ではない

    order_price_amount

    注文金額

    注文金額

    use_escrow

    エスクロー使用の設定

    エスクローを使ったかどうかを設定

    T:エスクローを使用する
    F:エスクローを使用しない

    customer_group_no_when_ordering

    注文時の会員ランク

    注文当時の会員ランク

    membership_discount_amount

    会員限定割引金額

    会員に対する割引金額

    app_discount_amount

    앱 주문할인금액

    actual_payment_amount

    実際の決済金額

    実際の支払金額。顧客が実際支払った金額で、キャンセル、交換、返品などを行う場合、実際の支払金額が変更されることがある。

    mileage_spent_amount

    ポイント使用金額

    ポイント利用額

    bank_account_no

    口座番号

    注文件に対するショップの口座番号

    market_customer_id

    モール型ECサイトの注文者ID

    モール型ECサイトの注文者ID

    payment_amount

    決済金額(初期の支払済み金額)

    決済金額。最初に決済された金額で、変更されない。

    cancel_date

    timezone

    注文キャンセル日

    注文キャンセル日

    inflow_name

    流入チャンネル名

    流入チャンネル名

    inflow_id

    流入チャンネルID

    流入チャンネルID

    order_place_name

    注文経路テキスト

    order_place_id

    注文経路

    payment_confirmation

    後払い決済の入金確認可能の設定

    入金確認の有無

    T:入金確認
    F:入金未確認

    postpay_commission

    後払い決済手数料

    後払い決済手数料

    postpay

    後払い決済の有無

    後払いの設定

    T:後払い決済
    F:後払い決済ではない

    shipping_fee

    送料

    送料

    shipping_type

    配送タイプ

    配送タイプ。国内配送か海外配送か両方とも可能かを設定

    A:国内
    B:国内&海外
    C:海外

    shipping_type_text

    配送タイプ名

    配送タイプの説明。国内配送か海外配送か両方とも可能かを説明

    shipping_status

    配送ステータス

    配送ステータス

    F:配送前
    M:配送中
    T:配送完了
    W:配送保留

    wished_delivery_date

    配送希望日

    配達希望日

    wished_delivery_time

    配達希望時間

    配達希望時間

    wished_carrier_id

    希望配送会社コード

    配達希望会社コード

    return_confirmed_date

    timezone

    返品承認日時

    返品承認日時

    total_supply_price

    供給価額の合計

    供給価額の合計

    additional_order_info_list

    注文書の追加項目

    store_pickup

    店舗受取の設定

    実店舗で受け取る商品かどうかを設定

    T:店舗にて受取り
    F:店舗にて受取りではない

    easypay_name

    簡単決済の決済代行会社名

    簡単決済の決済代行会社の名前

    loan_status

    与信状態

    ローンの状態

    OK : GOOD
    NG : NOT GOOD
    ER : ERROR

    shipping_message

    配送メッセージ

    配送メッセージ

    items

    品目別注文エンティティ(Item Entity)


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

    receivers

    受取人情報エンティティ(Receiver Entity)


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

    buyer

    주문자정보 엔티티 (Buyer Entity)


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

    List all orders

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/orders'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/orders?start_date=2017-01-01&end_date=2017-12-31&order_status=N10,N20&date_type=pay_date' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "orders": [
            {
                "shop_no": "1",
                "currency": "KRW",
                "order_id": "20170710-0000013",
                "market_id": "self",
                "market_order_info": null,
                "buyer_name": "John Doe",
                "buyer_email": "sample@sample.com",
                "buyer_phone": "02-0000-0000",
                "buyer_cellphone": "010-0000-0000",
                "member_id": "sampleid",
                "member_authentication": "T",
                "customer_group_no_when_ordering": 1,
                "billing_name": "Test",
                "bank_code": "bank_26",
                "bank_code_name": "Sample Bank",
                "payment_method": "card",
                "payment_method_name": "Card",
                "payment_method_icon": "<img src='\/\/img.echosting.cafe24.com\/icon\/ico_pay_card.gif' alt='Card' title='Card'>",
                "payment_gateway_name": "",
                "paid": "T",
                "order_date": "2018-07-04T11:21:35+09:00",
                "first_order": "T",
                "payment_date": "2018-07-04T11:21:35+09:00",
                "order_from_mobile": "F",
                "order_price_amount": "30000.00",
                "use_escrow": "F",
                "membership_discount_amount": "0.00",
                "app_discount_amount": "0.00",
                "actual_payment_amount": "30000.00",
                "mileage_spent_amount": "0.00",
                "bank_account_no": "12312422234",
                "market_customer_id": null,
                "payment_amount": "30000.00",
                "cancel_date": null,
                "inflow_name": "Zig Zag",
                "inflow_id": "zigzag",
                "order_place_name": "Naver Pay",
                "order_place_id": "NCHECKOUT",
                "payment_confirmation": null,
                "postpay_commission": "0.00",
                "postpay": "F",
                "shipping_fee": "0.00",
                "shipping_type": "A",
                "shipping_type_text": "Domestic Shipping",
                "shipping_status": "T",
                "wished_delivery_date": "",
                "wished_delivery_time": null,
                "wished_carrier_id": null,
                "return_confirmed_date": null,
                "total_supply_price": "27000",
                "additional_order_info_list": [
                    {
                        "id": "1",
                        "name": "addtional info1",
                        "value": "lorem ipsu",
                        "input_type": "A",
                        "product_type": "A",
                        "applied_product_list": [
                            "iPhone X"
                        ]
                    },
                    {
                        "id": "2",
                        "name": "addtional info2",
                        "value": "Green",
                        "input_type": "A",
                        "product_type": "A",
                        "applied_product_list": [
                            "iPhone X"
                        ]
                    }
                ],
                "store_pickup": "F",
                "easypay_name": "",
                "loan_status": null,
                "shipping_message": ""
            },
            {
                "shop_no": "1",
                "currency": "KRW",
                "order_id": "20170711-0000014",
                "market_id": "self",
                "market_order_info": null,
                "buyer_name": "John Doe",
                "buyer_email": "sample@sample.com",
                "buyer_phone": "02-0000-0000",
                "buyer_cellphone": "010-0000-0000",
                "member_id": "sampleid",
                "member_authentication": "T",
                "customer_group_no_when_ordering": 1,
                "billing_name": "123",
                "bank_code": "bank_26",
                "bank_code_name": "Sample Bank",
                "payment_method": "card",
                "payment_method_name": "Card",
                "payment_method_icon": "<img src='\/\/img.echosting.cafe24.com\/icon\/ico_pay_card.gif' alt='Card' title='Card'>",
                "payment_gateway_name": "",
                "paid": "T",
                "order_date": "2018-07-04T11:21:35+09:00",
                "first_order": "F",
                "payment_date": "2018-07-04T11:21:35+09:00",
                "order_from_mobile": "F",
                "order_price_amount": "10000.00",
                "use_escrow": "F",
                "membership_discount_amount": "0.00",
                "app_discount_amount": "0.00",
                "actual_payment_amount": "10000.00",
                "mileage_spent_amount": "0.00",
                "bank_account_no": "12312422234",
                "market_customer_id": null,
                "payment_amount": "10000.00",
                "cancel_date": null,
                "inflow_name": "Zig Zag",
                "inflow_id": "zigzag",
                "order_place_name": "Naver Pay",
                "order_place_id": "NCHECKOUT",
                "payment_confirmation": null,
                "postpay_commission": "0.00",
                "postpay": "F",
                "shipping_fee": "0.00",
                "shipping_type": "A",
                "shipping_type_text": "Domestic Shipping",
                "shipping_status": "M",
                "wished_delivery_date": "",
                "wished_delivery_time": null,
                "wished_carrier_id": null,
                "return_confirmed_date": null,
                "total_supply_price": "9000",
                "additional_order_info_list": [],
                "store_pickup": "F",
                "easypay_name": "",
                "loan_status": null,
                "shipping_message": ""
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 注文 閲覧権限 (READ_ORDER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    items
    embed

    品目別注文エンティティ(Item Entity)


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

    receivers
    embed

    受取人情報エンティティ(Receiver Entity)


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

    buyer
    embed

    주문자정보 엔티티 (Buyer Entity)


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

    shop_no

    ショップ番号

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

    DEFAULT 1

    start_date
    Required

    Date
    timezone

    検索開始日

    検索を開始する基準日

    ※ APIの性能を保証するため、検索期間は最近3カ月間まで検索可能

    end_date
    Required

    Date
    timezone

    検索終了日

    検索を終了する基準日
    検索開始日と一緒に使用しなければならない。

    ※ APIの性能を保証するため、最近3カ月間の注文のみ検索可能

    order_id

    Order ID

    注文番号

    注文番号

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

    order_status

    注文ステータス

    注文ステータス。注文ステータス別にそれぞれのコードがある。

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

    N00:入金前
    N10:商品準備中
    N20:発送準備中
    N21:出荷待ち
    N22:配送保留
    N30:配送中
    N40:配送完了
    C00:キャンセル申込
    C10:キャンセル受付-管理者
    C34:キャンセル処理中-返金前
    C36:キャンセル処理中-返金保留
    C40:キャンセル完了
    C47:入金前キャンセル-購入者
    C48:入金前キャンセル-自動キャンセル
    C49:入金前キャンセル-管理者
    R00:返品申込
    R10:返品受付
    R12:返品保留
    R30:返品処理中-回収前
    R34:返品処理中-返金前
    R36:返品処理中-返金保留
    R40:返品完了-返金完了
    E00:交換申込
    E10:交換受付
    E12:交換保留
    E20:交換準備
    E30:交換処理中-回収前
    E32:交換処理中-入金前
    E34:交換処理中-返金前
    E36:交換処理中-返金保留
    E40:交換完了

    member_type

    会員/非会員

    会員の有無。会員と非会員、それぞれのコードがある。

    2:会員
    3:非会員

    group_no

    会員ランク番号

    会員ランク

    buyer_name

    注文者名

    注文者の名前。入金者または受取人の名前と異なる場合がある。

    receiver_name

    受取人名

    受取人の名前。注文者または入金者の名前と違う場合がある。

    receiver_address

    受取人の住所

    受取人の住所。注文者または入金者の住所と違う場合がある。

    member_id

    会員ID

    会員ID

    product_no

    商品番号

    商品番号

    product_code

    商品コード

    商品コード

    date_type

    検索日付のタイプ

    検索するための日付タイプ基準。基本値は注文日に設定されている。

    order_date: 주문일
    pay_date: 결제일
    shipbegin_date: 배송시작일
    shipend_date: 배송완료일
    cancel_date: 주문취소일
    place_date: 발주일
    updatereceiver_date: 수령자정보 수정일
    cancel_complete_date: 취소완료일
    exchange_complete_date: 교환완료일
    return_complete_date: 반품완료일

    DEFAULT order_date

    supplier_id

    供給会社のID

    limit

    Max : [500]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    Count all orders

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/orders/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/orders/count?shop_no=1&start_date=2017-01-01&end_date=2017-12-31&order_status=N10,N20&date_type=pay_date' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    基本スペック

    Property Description
    SCOPE 注文 閲覧権限 (READ_ORDER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    start_date
    Required

    Date
    timezone

    検索開始日

    検索を始める基準日

    end_date
    Required

    Date
    timezone

    検索終了日

    検索を終了する基準日
    検索開始日と必ずペアで使用すること。

    order_id

    Order ID

    注文番号

    注文番号

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

    order_status

    注文ステータス

    注文ステータス。注文ステータス別にそれぞれのコードがある。

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

    N00:入金前
    N10:商品準備中
    N20:発送準備中
    N21:出荷待ち
    N22:配送保留
    N30:配送中
    N40:配送完了
    C00:キャンセル申込
    C10:キャンセル受付-管理者
    C34:キャンセル処理中-返金前
    C36:キャンセル処理中-返金保留
    C40:キャンセル完了
    C47:入金前キャンセル-購入者
    C48:入金前キャンセル-自動キャンセル
    C49:入金前キャンセル-管理者
    R00:返品申込
    R10:返品受付
    R12:返品保留
    R30:返品処理中-回収前
    R34:返品処理中-返金前
    R36:返品処理中-返金保留
    R40:返品完了-返金完了
    E00:交換申込
    E10:交換受付
    E12:交換保留
    E20:交換準備
    E30:交換処理中-回収前
    E32:交換処理中-入金前
    E34:交換処理中-返金前
    E36:交換処理中-返金保留
    E40:交換完了

    member_type

    会員/非会員

    会員の有無。会員と非会員、それぞれのコードがある。

    2:会員
    3:非会員

    group_no

    会員ランク番号

    会員ランク

    buyer_name

    注文者名

    注文者の名前。入金者または受取人の名前と異なる場合がある。

    receiver_name

    受取人名

    受取人の名前。注文者または入金者の名前と違う場合がある。

    receiver_address

    受取人の住所

    受取人の住所。注文者または入金者の住所と違う場合がある。

    member_id

    会員ID

    会員ID

    product_no

    商品番号

    商品番号

    product_code

    商品コード

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

    date_type

    検索日付のタイプ

    検索するための日付タイプ基準。基本値は注文日に設定されている。

    order_date: 주문일
    pay_date: 결제일
    shipbegin_date: 배송시작일
    shipend_date: 배송완료일
    cancel_date: 주문취소일
    place_date: 발주일
    updatereceiver_date: 수령자정보 수정일
    cancel_complete_date: 취소완료일
    exchange_complete_date: 교환완료일
    return_complete_date: 반품완료일

    DEFAULT order_date

    supplier_id

    供給会社のID

    Orders buyer

    Orders buyer properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    member_id

    주문자 아이디

    注文者ID

    member_group_no

    주문당시 주문자 회원 등급 번호

    name

    주문자명

    email

    주문자 이메일

    会員のメールアドレス

    phone

    주문자 일반 전화

    cellphone

    주문자 휴대 전화

    customer_notification

    고객 알림

    お客様へのお知らせ

    updated_date

    timezone

    수정일

    user_id

    주문자 수정자 ID

    注文者情報を修正した人のID

    user_name

    주문자 수정자 명

    注文者情報を修正した人の名前

    order_id

    Order ID

    주문번호

    Get an orders buyer

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/orders/{#id}/buyer'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/orders/20180903-0000243/buyer' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "buyer": {
            "shop_no": 1,
            "member_id": "sampleid",
            "member_group_no": 1,
            "name": "Floyd Mayweather",
            "email": "sample@gmail.com",
            "phone": "02-0000-0000",
            "cellphone": "010-0000-0000",
            "customer_notification": "Customer Notify Sample",
            "updated_date": "2018-09-03T17:20:49+09:00",
            "user_id": "sampleid",
            "user_name": "John Doe"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 注文 閲覧権限 (READ_ORDER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    order_id
    Required

    Order ID

    주문번호

    Update an orders buyer

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/orders/{#id}/buyer'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/orders/20180903-0000243/buyer' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "name": "Floyd Mayweather",
            "email": "sample@gmail.com",
            "phone": "02-0000-0000",
            "cellphone": "010-0000-0000",
            "customer_notification": "Customer Notify Sample"
        }
    }'
    

    Response example:

    {
        "buyer": {
            "shop_no": 1,
            "order_id": "20180903-0000243",
            "name": "Floyd Mayweather",
            "email": "sample@gmail.com",
            "phone": "02-0000-0000",
            "cellphone": "010-0000-0000",
            "customer_notification": "Customer Notify Sample"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 注文 投稿権限 (WRITE_ORDER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    order_id
    Required

    Order ID

    주문번호

    name

    주문자명

    email

    Email

    주문자 이메일

    会員のメールアドレス

    phone

    주문자 일반 전화

    cellphone

    주문자 휴대 전화

    customer_notification

    고객 알림

    お客様へのお知らせ

    Orders items

    品目別注文(Items)はショップの顧客が注文時に購入した品目の情報です。ショップの品目はショップで販売する商品の基本単位で、品目別注文では購入した商品の品目情報と共に購入時に選択したオプション、注文数量などの情報を追加で確認することができます。
    品目別注文番号は下位 Entityで、注文(Order)の下位でしか使えません。
    品目別注文(Items)の{#id}は「item_no」です。

    Orders items properties

    Attribute Description
    shop_no

    ショップ番号

    DEFAULT 1

    item_no

    品目別注文ID

    品目別注文番号のID

    order_item_code

    品目別注文コード

    品目別注文番号のコード

    variant_code

    品目コード

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

    product_no

    商品番号

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

    product_code

    商品コード

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

    eng_product_name

    英語商品名

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

    option_id

    商品オプションID

    商品オプションのID

    option_value

    オプション値

    注文した商品のオプション値

    option_value_default

    基本オプション値

    基本オプション値

    additional_option_value

    追加入力オプション値

    追加入力オプション値

    product_name

    商品名

    商品の名前。商品名は商品を区分する一番基礎的な情報で、検索情報になる。

    product_name_default

    基本商品名

    基本商品名

    product_price

    商品販売価格

    商品の販売価格。マルチショップを運営する場合には販売価格をショッピング別通貨単位で換算して表示

    option_price

    オプション追加価格

    オプション別に追加価格がある場合、その追加価格

    additional_discount_price

    商品追加割引金額

    商品に対する追加割引金額

    app_item_discount_amount

    앱 상품할인금액

    quantity

    数量

    注文した商品の数量

    supplier_product_name

    供給会社の商品名

    供給会社の商品名

    supplier_transaction_type

    供給会社の取引タイプ

    供給会社の取引タイプ

    D:直接登録型
    P:手数料型

    supplier_id

    供給会社のID

    供給会社のID

    supplier_name

    供給会社名

    供給会社の名前

    tracking_no

    送り状番号

    送り状番号

    shipping_code

    配送番号

    配送番号。品目別注文番号を配送準備中に処理すると、システムにより自動的に付与される番号

    post_express_flag

    ゆうパック連動

    ゆうパック連動ステータス

    order_status

    注文ステータス

    注文ステータス。注文ステータス別にそれぞれのコードがある。

    order_status_additional_info

    注文ステータスの追加情報

    注文ステータスの追加情報

    status_code

    現在の処理ステータスコード

    現在の処理ステータスのコード

    N1:正常
    N2:交換商品
    C1:入金前のキャンセル
    C2:配送前のキャンセル
    C3:返品
    E1:交換

    status_text

    現在の処理ステータス

    現在の処理ステータスに関する説明

    open_market_status

    モール型ECサイト連動ステータス値

    モール型ECサイト連動ステータス値

    bundled_shipping_type

    モール型ECサイト連動ステータス値

    配送対象の注文に対してまとめて配送するタイプ

    N: 단일 주문 일반 배송(Normal)
    C:복합 주문 결합 배송(Combination)

    shipping_company_id

    配送会社ID

    配送会社のID

    shipping_company_name

    配送会社名

    配送会社の名前

    shipping_company_code

    配送会社コード

    配送会社のコード。配送会社別に固有コードがある。

    product_bundle

    セット商品の有無

    セット商品の有無

    T:セット商品
    F:セット商品ではない

    product_bundle_no

    분리형 세트상품번호

    分離型セット商品の番号
    一体型セット商品の番号はproduct_noに表示される。

    product_bundle_name

    분리형 세트상품명

    分離型セット商品の名前
    一体型セット商品の名前はproduct_nameに表示される。

    product_bundle_name_default

    분리형 세트상품명(기본)

    分離型セット商品の名前
    一体型セット商品の名前はproduct_nameに表示される。

    product_bundle_type

    セット商品のタイプ

    セット商品のタイプ

    C:一体型
    S:分離型

    was_product_bundle

    セット品目別注文の分離設定

    セット商品の品目注文番号を分離するかどうかを設定

    T:分離履歴ある
    F:分離履歴ない

    original_bundle_item_no

    分離したセット商品の既存の品目別注文番号

    分離されたセット商品の既存の品目別注文番号

    naver_pay_order_id

    NAVER Pay商品別注文番号

    Naver Pay注文の商品別注文番号

    naver_pay_claim_status

    NAVER Payクレームタイプ

    Naver Pay注文のクレームタイプ

    PAYMENT_WAITING:入金待ち
    PAYED:決済完了
    DELIVERING:配送中
    DELIVERED:配送完了
    PURCHASE_DECIDED:購入確定
    EXCHANGED:交換
    CANCELED:キャンセル
    RETURNED:返品
    CANCELED_BY_NOPAYMENT:未入金キャンセル
    NOT_YET:発注未確認
    OK:発注確認
    CANCEL:発注確認の解除
    CANCEL_REQUEST:キャンセル申込
    CANCELING:キャンセル処理中
    CANCEL_DONE:キャンセル処理完了
    CANCEL_REJECT:キャンセル取消
    RETURN_REQUEST:返品申込
    COLLECTING:回収処理中
    COLLECT_DONE:回収完了
    RETURN_DONE:返品完了
    RETURN_REJECT:返品取消
    EXCHANGE_REQUEST:交換申込
    COLLECTING:回収処理中
    COLLECT_DONE:回収完了
    EXCHANGE_REDELIVERING:交換後に再配送中
    EXCHANGE_DONE:交換完了
    EXCHANGE_REJECT:交換拒否
    PURCHASE_DECISION_HOLDBACK:購入確定保留
    PURCHASE_DECISION_HOLDBACK_REDELIVERING:購入確定保留後に再配送中
    PURCHASE_DECISION_REQUEST:購入確定申込
    PURCHASE_DECISION_HOLDBACK_RELEASE:購入確定保留の解除
    ADMIN_CANCELING:職権キャンセル中
    ADMIN_CANCEL_DONE:職権キャンセル完了

    individual_shipping_fee

    個別送料

    個別送料

    shipping_fee_type

    送料タイプ

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

    T:無料
    F:着払い
    D:等差(金額)
    M:条件(金額)
    I:固定
    N:比例(数量)
    W:等差(重さ)
    C:等差(数量)
    X:基本配送

    shipping_fee_type_text

    送料タイプ

    送料タイプの説明

    payment_info_id

    決済情報ID

    決済情報ID

    original_item_no

    既存の品目別注文ID

    既存の品目別注文ID

    store_pickup

    店舗受取の設定

    実店舗で受け取る商品かどうかを設定

    T:店舗にて受取り
    F:店舗にて受取りではない

    ordered_date

    timezone

    注文日

    注文日

    shipped_date

    timezone

    配送開始日

    配送開始日

    delivered_date

    timezone

    配送完了日

    配送完了日

    cancel_date

    timezone

    注文キャンセル日

    注文のキャンセル日

    return_request_date

    timezone

    返品申込日

    返品申込日

    return_date

    timezone

    返品完了日

    返品完了日

    cancel_request_date

    timezone

    キャンセル申込日

    注文の取消申込日

    refund_date

    timezone

    返金完了日

    返金完了日

    exchange_request_date

    timezone

    交換申込日

    交換申込日

    exchange_date

    timezone

    交換完了日

    交換完了日

    product_material

    商品素材

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

    product_material_eng

    英語商品素材

    商品素材の英語説明

    cloth_fabric

    生地

    商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。

    product_weight

    商品重量

    商品の全体重量(kg)。配送のために商品の重量だけでなく、ボックスと包装の重量も含めた重量を記載する必要がある。

    volume_size

    商品容積

    商品の体積

    volume_size_weight

    商品の容積・重量

    商品の体積と重量

    clearance_category

    海外通関用商品区分

    clearance_category_info

    海外通関用商品情報

    clearance_category_code

    海外通関コード

    hs_code

    HSコード

    通関のためのHSコード

    one_plus_n_event

    1+Nイベントの有無

    1個購入時にN個を提供するイベントの設定

    origin_place

    原産国情報

    商品の原産国

    gift

    プレミアムの有無

    商品がプレミアムかどうかを設定

    T:プレミアム
    F:プレミアムではない

    List all orders items

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/orders/{#id}/items'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/orders/20170710-0000013/items' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "items": [
            {
                "shop_no": "1",
                "item_no": "1",
                "order_item_code": "20170710-0000013-01",
                "variant_code": "P000000N000A",
                "product_no": "14",
                "product_code": "P000000N",
                "eng_product_name": null,
                "option_id": "000A",
                "option_value": "",
                "option_value_default": "",
                "additional_option_value": "",
                "product_name": "iPhone X",
                "product_name_default": "iPhone X",
                "product_price": "30000.00",
                "option_price": "0.00",
                "additional_discount_price": "0.00",
                "app_item_discount_amount": "0.00",
                "quantity": "1",
                "supplier_product_name": "",
                "supplier_transaction_type": "D",
                "supplier_id": "S0000000",
                "supplier_name": "Apple",
                "tracking_no": "12345678",
                "shipping_code": "D-20170710-0000013-00",
                "post_express_flag": null,
                "order_status": "N40",
                "order_status_additional_info": null,
                "status_code": "N1",
                "status_text": "Shipping Complete",
                "open_market_status": "",
                "bundled_shipping_type": "N",
                "shipping_company_id": "2",
                "shipping_company_name": "DHL",
                "shipping_company_code": "0001",
                "product_bundle": "F",
                "product_bundle_no": "0",
                "product_bundle_name": null,
                "product_bundle_name_default": null,
                "product_bundle_type": "C",
                "was_product_bundle": null,
                "original_bundle_item_no": null,
                "naver_pay_order_id": null,
                "naver_pay_claim_status": "PAYMENT_WAITING",
                "individual_shipping_fee": "0.00",
                "shipping_fee_type": "X",
                "shipping_fee_type_text": "Free",
                "payment_info_id": "0",
                "original_item_no": "",
                "store_pickup": "F",
                "ordered_date": "2017-07-10 15:55:51",
                "shipped_date": "2017-07-10 15:56:52",
                "delivered_date": "2017-07-10 15:57:05",
                "cancel_date": null,
                "return_request_date": null,
                "return_date": null,
                "cancel_request_date": null,
                "refund_date": null,
                "exchange_request_date": null,
                "exchange_date": null,
                "product_material": null,
                "product_material_eng": null,
                "cloth_fabric": null,
                "product_weight": "1.00",
                "volume_size": null,
                "volume_size_weight": null,
                "clearance_category_code": null,
                "clearance_category_code_info": null,
                "clearance_category_code_base": null,
                "hs_code": "",
                "one_plus_n_event": null,
                "origin_place": " ",
                "gift": "F"
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 注文 閲覧権限 (READ_ORDER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    注文番号

    Orders receivers

    受取人情報(Receivers)は注文した商品を受け取る人の名前、連絡先、住所情報です。
    受取人情報は下位Entityで、注文(Order)の下位でしか使えません。

    Orders receivers properties

    Attribute Description
    shop_no

    ショップ番号

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

    name

    受取人名

    name_furigana

    受取人名(フリガナ)

    phone

    電話番号

    cellphone

    受取人の携帯電話番号

    virtual_phone_no

    受取人の安心番号

    zipcode

    郵便番号

    address1

    基本住所

    address2

    詳細住所

    name_en

    受取人名(ローマ字)

    city_en

    受取人の都市(ローマ字)

    state_en

    受取人の住所(ローマ字)

    street_en

    受取人の住所 (ローマ字)

    country_code

    国コード

    国コード

    country_name

    国名

    国名

    country_name_en

    国名(ローマ字)

    国名(ローマ字)

    List all orders receivers

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/orders/{#id}/receivers'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/orders/20170710-0000013/receivers' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "receivers": [
            {
                "shop_no": 1,
                "name": "John Doe",
                "name_furigana": "John Doe",
                "phone": "02-0000-0000",
                "cellphone": "010-0000-0000",
                "virtual_phone_no": null,
                "zipcode": "06258",
                "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
                "address2": "Professional Construction Hall",
                "name_en": null,
                "city_en": null,
                "state_en": null,
                "street_en": null,
                "country_code": "",
                "country_name": null,
                "country_name_en": null
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 注文 閲覧権限 (READ_ORDER)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    注文番号

    Origin

    原産国(Origin)は商品が生産された地域を意味します。原産国は国外配送などに重要なデータです。カフェ24は多数の原産国をコード化しているため、原産国検索APIで原産国コード情報を確認することができます。

    Origin properties

    Attribute Description
    origin_place_no

    原産国番号

    origin_place_name

    原産国名

    foreign

    海外

    List all origin

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/origin'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/origin' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "origin": [
            {
                "origin_place_no": "1",
                "origin_place_name": [
                    "Gangwon",
                    "Gangneung-si"
                ],
                "foreign": "F"
            },
            {
                "origin_place_no": "2",
                "origin_place_name": [
                    "Gangwon",
                    "Goseong-gun"
                ],
                "foreign": "F"
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 販売カテゴリ 閲覧権限 (READ_COLLECTION)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    origin_place_no

    原産国番号

    origin_place_name

    Max Length : [50]

    原産国名

    foreign

    海外

    limit

    Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    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]

    英語商品名

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

    supply_product_name

    Max Length : [250]

    供給会社の商品名

    供給会社が登録した商品の名前。供給会社が商品を区分するために任意で入力することができる。商品名には影響しない。

    model_name

    Max Length : [100]

    モデル名

    商品のモデル名

    price

    商品販売価格

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

    retail_price

    商品の消費者価格

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

    supply_price

    商品原価

    商品の原価。原価に売上総利益率を加えて販売価格を計算することができる。APIで原価は参照の目的でしか使われない。

    display

    表示ステータス

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

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

    selling

    販売ステータス

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

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

    product_condition

    商品ステータス

    販売する商品のステータス表示

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

    product_used_month

    Max : [2147483647]

    中古商品の使用月数

    summary_description

    Max Length : [255]

    商品要約説明

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

    product_tag

    Max Length : [200]

    商品検索キーワード

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

    margin_rate

    Min : [-999.99]~Max : [999.99]

    売上総利益率

    商品の原価に加えて販売価格を計算するための売上総利益率。APIでその値は参照の目的でしか使われない。

    tax_type

    課税区分

    商品の課税情報

    消費税込みのタイプ
    課税商品 = 税金が賦課される商品
    免税商品 = 税金が免除される商品。加工されていない農/水/畜産物、練炭、図書類、保険、女性専用などの商品で、課税事業者として登録しなければならない。
    零細商品 = 付加価値税が0%適用される輸出向け外貨稼ぎ商品

    A:課税商品
    B:免税商品
    C:ゼロ課税商品

    tax_amount

    Min : [0]~Max : [100]

    税率

    課税商品の場合、その商品に適用される消費税率を明示する。
    消費税は国家及び地域によって異なることがある。

    price_content

    Max Length : [20]

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

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

    buy_limit_type

    購入制限

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

    N:会員のみ購入でき
    購入ボタンを表示しない
    M:会員のみ購入でき
    購入ボタンを表示する
    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」と表示されます。

    mileage_amount

    ポイント設定情報

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

    except_member_mileage

    会員ランク追加付与を除く

    会員ランク設定画面で商品購入時のポイントを設定した場合、その設定がチェックされている商品はポイント付与対象から除かれる

    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)使用

    supplier_code

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

    供給会社のコード

    供給会社を登録すると自動生成されるコードで、商品に特定供給会社を指定する時に使う。

    made_date

    製造日

    商品を製造した製造日

    release_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]

    アイコン

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

    hscode

    HSコード

    海外配送時に関税を賦課するために使うHSコード。国際配送時に通関のために必ず正確な番号を入力しなければならない。

    ※ HSコード : 世界貿易機関(WTO)及び世界関税機構(WCO)が貿易統計及び関税分類の目的で輸出入商品を数字コードでカテゴリ化したもので、輸入時の税金賦課と輸出品の統制及び統計のための分類法

    product_weight

    商品重量

    商品の全体重量(kg)。配送のために商品の重量だけでなく、ボックスと包装の重量も含めた重量を記載する必要がある。

    product_material

    商品素材

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

    created_date

    timezone

    作成日

    商品が生成された日時

    updated_date

    timezone

    修正日

    商品が修正された日時

    english_product_material

    英語商品素材

    商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。

    cloth_fabric

    生地

    商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。

    woven:織物(woven)
    knit:編物(knit)

    list_icon

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

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

    ※ 在庫切れアイコン

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

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

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

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

    select_one_by_option

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

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

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

    approve_status

    承認申込結果

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

    classification_code

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

    独自カテゴリコード

    独自カテゴリを登録すると自動生成されるコードで、商品に特定の独自カテゴリを指定する場合に使う。

    入力しない場合は基本の独自カテゴリ(C000000A)使用

    sold_out

    在庫切れ状況

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

    additional_price

    販売価格の追加金額

    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:分離型セット

    country_hscode

    国別HSコード

    海外配送時に関税を賦課するために使うHSコード。国際配送時に通関のために必ず正確な番号を入力しなければならない。

    国別にHSコードの標準が異なるため、各国に合ったコードを入力しなければならない。

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

    simple_description

    商品簡略説明

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

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

    tags

    商品タグEntity


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

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

    options

    商品オプションEntity


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

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

    shipping_fee_by_product

    個別配送の設定

    送料を商品別に払わせるか共通送料を払わせるかを設定

    個別送料を使わない場合は共通送料を使う。

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

    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_eng

    海外通関用商品区分(英語名)

    海外通関時に通関用商品区分情報として使う情報。日本語名の入力時に入力した区分名が自動翻訳された項目

    翻訳された英語名が海外送状の商品名に含まれて送られる。

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

    clearance_category_kor

    海外通関用商品区分(日本語名)

    海外通関時に通関用商品区分情報として使う情報。英語に自動翻訳されて海外送状の商品名情報に含まれて送られる。

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

    clearance_category_code

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

    海外通関コード

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

    origin_place_code

    原産国コード

    商品の原産国コード

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

    additional_information

    追加項目

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

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

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

    image_upload_type

    画像アップロードタイプ

    画像をアップロードする時、画像のアップロードタイプ
    「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード
    「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード

    ※ EC Globalは、FTPをサポートしていないため、Cは使用できません

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

    A:代表画像登録
    B:個別画像登録
    C:ウェブFTP登録

    main

    メイン表示

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

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

    relational_product

    関連商品

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

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

    List all products

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products' \
      -H 'Authorization: Bearer {access_token}' \
      -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",
                "supply_product_name": "iphone A1865 fdd lte",
                "model_name": "A1865",
                "price": "1000.00",
                "retail_price": "0.00",
                "supply_price": "9000.00",
                "display": "T",
                "selling": "F",
                "product_condition": "U",
                "product_used_month": 2,
                "summary_description": "This is Product Summary.",
                "margin_rate": "10.00",
                "tax_type": "A",
                "tax_amount": 10,
                "price_content": null,
                "buy_limit_type": "F",
                "buy_unit_type": "O",
                "buy_unit": 1,
                "order_quantity_limit_type": "O",
                "minimum_quantity": 1,
                "maximum_quantity": 0,
                "mileage_amount": null,
                "except_member_mileage": "F",
                "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",
                "supplier_code": "S0000000",
                "made_date": "",
                "release_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"
                ],
                "hscode": "4303101990",
                "product_weight": 1,
                "product_material": "",
                "created_date": "2018-01-18T11:19:27+09:00",
                "updated_date": "2018-01-19T11:19:27+09:00",
                "english_product_material": null,
                "cloth_fabric": null,
                "list_icon": {
                    "soldout_icon": true,
                    "recommend_icon": false,
                    "new_icon": false
                },
                "approve_status": "",
                "classification_code": "C000000A",
                "sold_out": "F",
                "additional_price": "0.00"
            },
            {
                "shop_no": 1,
                "product_no": 23,
                "product_code": "P000000W",
                "custom_product_code": "",
                "product_name": "iPhone X",
                "eng_product_name": "iPhone Ten",
                "supply_product_name": "iphone A1865 fdd lte",
                "model_name": "A1865",
                "price": 1000,
                "retail_price": 0,
                "supply_price": 0,
                "display": "T",
                "selling": "F",
                "product_condition": "U",
                "product_used_month": 2,
                "summary_description": "This is Product Summary.",
                "margin_rate": "10.00",
                "tax_type": "A",
                "tax_amount": 10,
                "price_content": null,
                "buy_limit_type": "F",
                "buy_unit_type": "O",
                "buy_unit": 1,
                "order_quantity_limit_type": "O",
                "minimum_quantity": 1,
                "maximum_quantity": 0,
                "mileage_amount": null,
                "except_member_mileage": "F",
                "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",
                "supplier_code": "S0000000",
                "made_date": "",
                "release_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"
                ],
                "hscode": "4303101990",
                "product_weight": 1,
                "product_material": "",
                "created_date": "2018-01-18T11:19:27+09:00",
                "updated_date": "2018-01-19T11:19:27+09:00",
                "english_product_material": null,
                "cloth_fabric": null,
                "list_icon": {
                    "soldout_icon": true,
                    "recommend_icon": false,
                    "new_icon": false
                },
                "approve_status": "C",
                "classification_code": "C000000A",
                "sold_out": "F",
                "additional_price": "0.00"
            }
        ]
    }
    

    基本スペック

    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://{mallid}.cafe24api.com/api/v2/admin/products/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/count' \
      -H 'Authorization: Bearer {access_token}' \
      -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://{mallid}.cafe24api.com/api/v2/admin/products/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20' \
      -H 'Authorization: Bearer {access_token}' \
      -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",
            "supply_product_name": "iphone A1865 fdd lte",
            "model_name": "A1865",
            "price": "1000.00",
            "retail_price": "0.00",
            "supply_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,
            "country_hscode": {
                "JPN": "430310011",
                "CHN": "43031020"
            },
            "selling": "F",
            "product_condition": "U",
            "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"
                ]
            },
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "price_content": null,
            "buy_limit_type": "F",
            "buy_unit_type": "O",
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "mileage_amount": null,
            "except_member_mileage": "F",
            "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",
            "supplier_code": "S000000A",
            "made_date": "",
            "release_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,
            "hscode": "4303101990",
            "product_weight": 1,
            "product_material": "",
            "shipping_fee_by_product": "T",
            "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"
                }
            ],
            "created_date": "2018-01-18T11:19:27+09:00",
            "updated_date": "2018-01-19T11:19:27+09:00",
            "english_product_material": null,
            "clearance_category_eng": "Necklaces",
            "clearance_category_kor": "주얼리 > 목걸이",
            "clearance_category_code": "ACAB0000",
            "cloth_fabric": null,
            "list_icon": {
                "soldout_icon": true,
                "recommend_icon": true,
                "new_icon": true
            },
            "additional_information": [
                {
                    "key": "custom_option1",
                    "name": "gift option",
                    "value": "Yes"
                }
            ],
            "image_upload_type": "A",
            "classification_code": "C000000A",
            "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",
            "additional_price": "0.00"
        }
    }
    

    基本スペック

    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パラメーターを使って照会することができる。

    Create a product

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/products'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "display": "T",
            "selling": "T",
            "product_condition": "U",
            "product_used_month": 2,
            "add_category_no": [
                {
                    "category_no": 27,
                    "recommend": "F",
                    "new": "T"
                },
                {
                    "category_no": 28,
                    "recommend": "T",
                    "new": "F"
                }
            ],
            "custom_product_code": "",
            "product_name": "iPhone X",
            "eng_product_name": "iPhone Ten",
            "model_name": "A1865",
            "price": 10000,
            "retail_price": 0,
            "supply_price": 9000,
            "has_option": "T",
            "option": [
                {
                    "name": "Color",
                    "value": [
                        "Red",
                        "Blue",
                        "Green"
                    ]
                },
                {
                    "name": "Size",
                    "value": [
                        "X",
                        "L",
                        "M",
                        "S"
                    ]
                }
            ],
            "image_upload_type": "A",
            "detail_image": "\/web\/product\/big\/201511\/30_shop1_638611.jpg",
            "manufacturer_code": "M0000000",
            "supplier_code": "S0000000",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "icon": [
                "icon_01_01",
                "icon_02_01"
            ],
            "buy_limit_type": "F",
            "buy_unit_type": "O",
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "summary_description": "This is Product Summary.",
            "simple_description": "This is Product Description.",
            "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.",
            "hscode": "4303101990",
            "relational_product": [
                {
                    "product_no": 9,
                    "interrelated": "T"
                },
                {
                    "product_no": 10,
                    "interrelated": "F"
                }
            ],
            "shipping_scope": "A",
            "shipping_fee_by_product": "T",
            "shipping_method": "01",
            "shipping_period": {
                "minimum": 4,
                "maximum": 10
            },
            "shipping_area": "All around world",
            "shipping_fee_type": "D",
            "clearance_category_code": "ACAB0000",
            "shipping_rates": [
                {
                    "shipping_rates_min": 2000,
                    "shipping_rates_max": 4000,
                    "shipping_fee": 5000
                },
                {
                    "shipping_rates_min": 4000,
                    "shipping_rates_max": 6000,
                    "shipping_fee": 2500
                }
            ],
            "product_material": "Aluminum",
            "english_product_material": "Aluminum",
            "cloth_fabric": "knit",
            "classification_code": "C000000A",
            "additional_price": "1100.00",
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "prepaid_shipping_fee": "P",
            "origin_classification": "F",
            "origin_place_no": 1798,
            "additional_image": [
                "201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                "201810\/e1ab68969d69287a828438c7684b14c4.jpg"
            ]
        }
    }'
    

    Response example:

    {
        "product": {
            "shop_no": 1,
            "product_no": 28,
            "category": [
                {
                    "category_no": 27,
                    "recommend": "F",
                    "new": "T"
                },
                {
                    "category_no": 28,
                    "recommend": "T",
                    "new": "F"
                }
            ],
            "product_code": "P00000BB",
            "custom_product_code": "",
            "product_name": "iPhone X",
            "eng_product_name": "iPhone Ten",
            "model_name": "A1865",
            "price": "10000.00",
            "retail_price": "0.00",
            "supply_price": "9000.00",
            "display": "T",
            "selling": "T",
            "product_condition": "U",
            "product_used_month": 2,
            "buy_limit_type": "F",
            "buy_unit_type": "O",
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "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.",
            "simple_description": "This is Product Description.",
            "summary_description": "This is Product Summary.",
            "detail_image": "http:\/\/{domain}\/web\/product\/big\/201511\/30_shop1_638611.jpg",
            "has_option": "T",
            "manufacturer_code": "M0000000",
            "supplier_code": "S000000A",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "icon": [
                "icon_01_01",
                "icon_02_01"
            ],
            "hscode": "4303101990",
            "shipping_fee_by_product": "T",
            "shipping_method": "01",
            "shipping_period": {
                "minimum": 4,
                "maximum": 10
            },
            "shipping_scope": "A",
            "shipping_area": "All around world",
            "shipping_fee_type": "D",
            "shipping_rates": [
                {
                    "shipping_rates_min": "2000.00",
                    "shipping_rates_max": "4000.00",
                    "shipping_fee": "5000.00"
                },
                {
                    "shipping_rates_min": "4000.00",
                    "shipping_rates_max": "6000.00",
                    "shipping_fee": "2500.00"
                }
            ],
            "prepaid_shipping_fee": "P",
            "clearance_category_code": "ACAB0000",
            "image_upload_type": "A",
            "relational_product": [
                {
                    "product_no": 9,
                    "interrelated": "T"
                },
                {
                    "product_no": 10,
                    "interrelated": "F"
                }
            ],
            "product_material": "Aluminum",
            "english_product_material": "Aluminum",
            "cloth_fabric": "knit",
            "classification_code": "C000000A",
            "additional_price": "1100.00",
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "origin_classification": "F",
            "origin_place_no": 1798,
            "created_date": "2018-05-29T14:23:51+09:00",
            "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"
                }
            ]
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    display

    表示ステータス

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

    DEFAULT F

    selling

    販売ステータス

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

    DEFAULT F

    product_condition

    商品ステータス

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

    DEFAULT N

    product_used_month

    Max : [2147483647]

    中古商品の使用月数

    商品状態(product_condition)が中古である場合、該当商品の使用月数

    add_category_no

    追加カテゴリ番号

    カテゴリ番号を使って表示したいカテゴリに商品登録

    custom_product_code

    Max Length : [40]

    独自商品コード

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

    product_name
    Required

    Max Length : [250]

    商品名

    eng_product_name

    Max Length : [250]

    英語商品名

    model_name

    Max Length : [100]

    モデル名

    price
    Required

    Max : [2147483647]

    商品販売価格

    retail_price

    Max : [2147483647]

    商品の消費者価格

    supply_price
    Required

    Max : [2147483647]

    商品原価

    商品の原価。原価に売上総利益率を加えて販売価格を計算することができる。APIで原価は参照の目的でしか使われない。

    has_option

    オプション使用の設定

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

    DEFAULT F

    option

    オプション

    修正するオプション名とオプション値を入力

    manufacturer_code

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

    メーカーコード

    DEFAULT M0000000

    supplier_code

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

    供給会社のコード

    DEFAULT S0000000

    expiration_date

    Array Max : [2]

    有効期間

    description

    商品詳細説明

    mobile_description

    モバイル商品詳細説明

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

    summary_description

    Max Length : [255]

    商品要約説明

    simple_description

    商品簡略説明

    product_tag

    Max Length : [200]

    商品検索キーワード

    payment_info

    商品決済ガイド

    shipping_info

    商品配送ガイド

    exchange_info

    交換・返品ガイド

    service_info

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

    icon

    Array Max : [5]

    アイコン

    hscode

    Max Length : [20]

    HSコード

    配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力

    shipping_scope

    配送情報

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

    ※ショッピングモールがEC Globalモールの場合は必須で入力する必要がある。

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

    DEFAULT A

    shipping_method

    配送方法

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

    DEFAULT 01

    shipping_fee_by_product

    個別配送の設定

    T:個別配送
    F:基本配送

    DEFAULT F

    shipping_area

    Max Length : [255]

    配送地域

    DEFAULT 전국지역

    shipping_period

    Array Max : [2]

    配送期間

    shipping_fee_type

    送料タイプ

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

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

    DEFAULT T

    shipping_rates

    送料金額

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

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

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

    prepaid_shipping_fee

    送料前払いの設定

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

    DEFAULT B

    clearance_category_code

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

    海外通関コード

    配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力

    detail_image

    詳細画像

    list_image

    一覧画像

    tiny_image

    縮小一覧画像

    small_image

    縮小画像

    image_upload_type

    画像アップロードタイプ

    画像をアップロードする時、画像のアップロードタイプ
    「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード
    「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード

    ※ EC Globalは、FTPをサポートしていないため、Cは使用できません

    A:代表画像登録
    B:個別画像登録
    C:ウェブFTP登録

    DEFAULT A

    additional_information

    追加項目

    buy_unit_type

    購入単位のタイプ

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

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

    DEFAULT O

    buy_unit

    Max : [2147483647]

    購入単位

    DEFAULT 1

    order_quantity_limit_type

    注文数量の制限基準

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

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

    DEFAULT O

    minimum_quantity

    Max : [2147483647]

    最小注文数量

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

    DEFAULT 1

    maximum_quantity

    Max : [2147483647]

    最大注文数量

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

    最大注文数を「制限なし」と入力するには「0」と入力します。

    origin_classification

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

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

    DEFAULT F

    origin_place_no

    原産国番号

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

    DEFAULT 1798

    origin_place_value

    Max Length : [30]

    原産国のその他の情報

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

    main

    メイン表示

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

    relational_product

    関連商品

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

    product_material

    商品素材

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

    english_product_material

    英語商品素材

    商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。

    cloth_fabric

    生地

    商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。

    woven:織物(woven)
    knit:編物(knit)

    classification_code

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

    独自カテゴリ

    additional_price

    Max : [2147483647]

    販売価格の追加金額

    販売価格の計算時に商品の原価と売上総利益率に加えて追加計算される金額。APIでその金額は参照の目的でしか使われない。

    margin_rate

    Min : [-999.99]~Max : [999.99]

    売上総利益率

    商品の原価に加えて販売価格を計算するための売上総利益率。APIでその値は参照の目的でしか使われない。

    tax_type

    課税区分

    商品の課税情報

    消費税込みのタイプ
    課税商品 = 税金が賦課される商品
    免税商品 = 税金が免除される商品。加工されていない農/水/畜産物、練炭、図書類、保険、女性専用などの商品で、課税事業者として登録しなければならない。
    零細商品 = 付加価値税が0%適用される輸出向け外貨稼ぎ商品

    A:課税商品
    B:免税商品
    C:ゼロ課税商品

    DEFAULT A

    tax_amount

    Min : [0]~Max : [100]

    税率

    課税商品の場合、その商品に適用される消費税率を明示する。
    消費税は国家及び地域によって異なることがある。

    additional_image

    追加画像

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

    追加画像は、最大20個まで登録可能できる。

    Update a product

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "display": "T",
            "selling": "T",
            "product_condition": "U",
            "product_used_month": 2,
            "add_category_no": [
                {
                    "category_no": 27,
                    "recommend": "F",
                    "new": "T"
                },
                {
                    "category_no": 28,
                    "recommend": "T",
                    "new": "F"
                }
            ],
            "delete_category_no": [
                27
            ],
            "custom_product_code": "",
            "product_name": "iPhone X",
            "eng_product_name": "iPhone Ten",
            "model_name": "A1865",
            "price": 10000,
            "retail_price": 0,
            "supply_price": 9000,
            "has_option": "F",
            "image_upload_type": "A",
            "detail_image": "\/web\/product\/big\/201511\/30_shop1_638611.jpg",
            "manufacturer_code": "M0000000",
            "supplier_code": "S0000000",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "icon": [
                "icon_01_01",
                "icon_02_01"
            ],
            "buy_limit_type": "F",
            "buy_unit_type": "O",
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "summary_description": "This is Product Summary.",
            "simple_description": "This is Product Description.",
            "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.",
            "hscode": "4303101990",
            "relational_product": [
                {
                    "product_no": 9,
                    "interrelated": "T"
                },
                {
                    "product_no": 10,
                    "interrelated": "F"
                }
            ],
            "shipping_scope": "A",
            "shipping_fee_by_product": "T",
            "shipping_method": "01",
            "shipping_period": {
                "minimum": 4,
                "maximum": 10
            },
            "shipping_area": "All around world",
            "shipping_fee_type": "D",
            "shipping_rates": [
                {
                    "shipping_rates_min": 2000,
                    "shipping_rates_max": 4000,
                    "shipping_fee": 5000
                },
                {
                    "shipping_rates_min": 4000,
                    "shipping_rates_max": 6000,
                    "shipping_fee": 2500
                }
            ],
            "product_material": "Aluminum",
            "english_product_material": "Aluminum",
            "cloth_fabric": "knit",
            "classification_code": "C000000A",
            "additional_price": "1100.00",
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "prepaid_shipping_fee": "P",
            "clearance_category_code": "ACAB0000",
            "origin_classification": "F",
            "origin_place_no": 1798,
            "additional_image": [
                "201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                "201810\/e1ab68969d69287a828438c7684b14c4.jpg"
            ]
        }
    }'
    

    Response example:

    {
        "product": {
            "shop_no": 1,
            "product_no": 7,
            "category": [
                {
                    "category_no": 27,
                    "recommend": "F",
                    "new": "T"
                },
                {
                    "category_no": 28,
                    "recommend": "T",
                    "new": "F"
                }
            ],
            "product_code": "P000000R",
            "custom_product_code": "",
            "product_name": "edu center product",
            "eng_product_name": "education center product",
            "model_name": "sample model",
            "price": "10000.00",
            "retail_price": "0.00",
            "supply_price": "9000.00",
            "display": "T",
            "selling": "T",
            "product_condition": "U",
            "product_used_month": 2,
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "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.",
            "simple_description": "This is Product Description.",
            "summary_description": "This is Product Summary.",
            "has_option": "F",
            "manufacturer_code": "M0000000",
            "supplier_code": "S000000A",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "icon": [
                "icon_01_01",
                "icon_02_01"
            ],
            "hscode": "4303101990",
            "shipping_fee_by_product": "T",
            "shipping_method": "01",
            "shipping_period": {
                "minimum": 4,
                "maximum": 10
            },
            "shipping_scope": "A",
            "shipping_area": "All around world",
            "shipping_fee_type": "D",
            "shipping_rates": [
                {
                    "shipping_rates_min": "2000.00",
                    "shipping_rates_max": "4000.00",
                    "shipping_fee": "5000.00"
                },
                {
                    "shipping_rates_min": "4000.00",
                    "shipping_rates_max": "6000.00",
                    "shipping_fee": "2500.00"
                }
            ],
            "prepaid_shipping_fee": "P",
            "clearance_category_code": "ACAB0000",
            "image_upload_type": "A",
            "detail_image": "http:\/\/{domain}\/web\/product\/big\/201511\/30_shop1_638611.jpg",
            "relational_product": [
                {
                    "product_no": 9,
                    "interrelated": "T"
                },
                {
                    "product_no": 10,
                    "interrelated": "F"
                }
            ],
            "product_material": "Aluminum",
            "english_product_material": "Aluminum",
            "cloth_fabric": "knit",
            "classification_code": "C000000A",
            "additional_price": "1100.00",
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "origin_classification": "F",
            "origin_place_no": 1798,
            "updated_date": "2018-05-29T14:23:51+09:00",
            "translated_additional_description": "This is a translated additional description of product.",
            "translated": "T",
            "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"
                }
            ]
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    display

    表示ステータス

    商品をショップに表示するかどうかを変更

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

    selling

    販売ステータス

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

    product_condition

    商品ステータス

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

    product_used_month

    Max : [2147483647]

    中古商品の使用月数

    商品状態(product_condition)が中古である場合、該当商品の使用月数

    add_category_no

    追加カテゴリ番号

    商品カテゴリ番号を入力してその商品に特定の商品カテゴリを追加登録

    delete_category_no

    削除されたカテゴリ番号

    商品カテゴリ番号を入力してその商品から特定の商品カテゴリを削除

    custom_product_code

    Max Length : [40]

    独自商品コード

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

    product_name

    Max Length : [250]

    商品名

    eng_product_name

    Max Length : [250]

    英語商品名

    model_name

    Max Length : [100]

    モデル名

    price

    Max : [2147483647]

    商品販売価格

    retail_price

    Max : [2147483647]

    商品の消費者価格

    supply_price

    Max : [2147483647]

    商品原価

    商品の原価。原価に売上総利益率を加えて販売価格を計算することができる。APIで原価は参照の目的でしか使われない。

    has_option

    オプション使用の設定

    F:オプション使用しない

    manufacturer_code

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

    メーカーコード

    supplier_code

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

    供給会社のコード

    expiration_date

    Array Max : [2]

    有効期間

    description

    商品詳細説明

    mobile_description

    モバイル商品詳細説明

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

    summary_description

    Max Length : [255]

    商品要約説明

    simple_description

    商品簡略説明

    product_tag

    Max Length : [200]

    商品検索キーワード

    payment_info

    商品決済ガイド

    shipping_info

    商品配送ガイド

    exchange_info

    交換・返品ガイド

    service_info

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

    icon

    Array Max : [5]

    アイコン

    hscode

    Max Length : [20]

    HSコード

    配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力

    shipping_scope

    配送情報

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

    shipping_method

    配送方法

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

    shipping_fee_by_product

    個別配送の設定

    T:個別配送
    F:基本配送

    shipping_area

    Max Length : [255]

    配送地域

    shipping_period

    Array Max : [2]

    配送期間

    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:送料

    prepaid_shipping_fee

    送料前払いの設定

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

    clearance_category_code

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

    海外通関コード

    配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力

    detail_image

    詳細画像

    list_image

    一覧画像

    tiny_image

    縮小一覧画像

    small_image

    縮小画像

    image_upload_type

    画像アップロードタイプ

    画像をアップロードする時、画像のアップロードタイプ
    「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード
    「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード

    ※ EC Globalは、FTPをサポートしていないため、Cは使用できません

    A:代表画像登録
    B:個別画像登録
    C:ウェブFTP登録

    additional_information

    追加項目

    buy_unit_type

    購入単位のタイプ

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

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

    buy_unit

    Max : [2147483647]

    購入単位

    order_quantity_limit_type

    注文数量の制限基準

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

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

    minimum_quantity

    Max : [2147483647]

    最小注文数量

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

    購入あたりの最小数量を変更する場合は、最大受注数量を一緒に変更する必要があります。

    maximum_quantity

    Max : [2147483647]

    最大注文数量

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

    購入あたりの最小数量を変更する場合は、最大受注数量を一緒に変更する必要があります。

    最大注文数を「制限なし」と入力するには「0」と入力します。

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

    main

    メイン表示

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

    relational_product

    関連商品

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

    product_material

    商品素材

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

    english_product_material

    英語商品素材

    商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。

    cloth_fabric

    生地

    商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。

    woven:織物(woven)
    knit:編物(knit)

    classification_code

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

    独自カテゴリ

    additional_price

    Max : [2147483647]

    販売価格の追加金額

    販売価格の計算時に商品の原価と売上総利益率に加えて追加計算される金額。APIでその金額は参照の目的でしか使われない。

    margin_rate

    Min : [-999.99]~Max : [999.99]

    売上総利益率

    商品の原価に加えて販売価格を計算するための売上総利益率。APIでその値は参照の目的でしか使われない。

    tax_type

    課税区分

    商品の課税情報

    消費税込みのタイプ
    課税商品 = 税金が賦課される商品
    免税商品 = 税金が免除される商品。加工されていない農/水/畜産物、練炭、図書類、保険、女性専用などの商品で、課税事業者として登録しなければならない。
    零細商品 = 付加価値税が0%適用される輸出向け外貨稼ぎ商品

    A:課税商品
    B:免税商品
    C:ゼロ課税商品

    tax_amount

    Min : [0]~Max : [100]

    税率

    課税商品の場合、その商品に適用される消費税率を明示する。
    消費税は国家及び地域によって異なることがある。

    additional_image

    追加画像

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

    追加画像は、最大20個まで登録可能できる。

    Delete a product

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/28' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "product": {
            "product_no": 28
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Products approve

    供給会社の商品承認機能を使っているショップでしか使えないAPIです。

    Products approve properties

    Attribute Description
    shop_no

    ショップ番号

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

    status

    ステータス

    供給会社が承認要求した商品の承認ステータス

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

    product_no
    Required

    商品番号

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

    Create a products approve

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/approve'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/approve' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "user_id": "supplytwo"
        }
    }'
    

    Response example:

    {
        "approve": {
            "shop_no": 1,
            "status": "N",
            "product_no": "7"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

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

    user_id
    Required

    供給会社の運営者ID

    承認を要求した供給会社のID

    Update a products approve

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/approve'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/approve' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "user_id": "supplytwo",
            "status": "C"
        }
    }'
    

    Response example:

    {
        "approve": {
            "shop_no": 1,
            "status": "C",
            "product_no": "7"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    user_id
    Required

    供給会社の運営者ID

    承認を要求した供給会社のID

    status
    Required

    ステータス

    供給会社が承認要求した商品の承認ステータス

    C:承認完了ステータス値
    R:承認拒否ステータス値
    I:検収進行中ステータス値

    Get products approve status

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/approve' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "approve": {
            "shop_no": 1,
            "status": "C",
            "product_no": "7"
        }
    }
    

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    Products cart

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

    Products cart properties

    Count all products cart

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/11/cart/count' \
      -H 'Authorization: Bearer {access_token}' \
      -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
    code

    デコ画像コード

    path

    꾸미기 이미지 URL

    use_show_date

    表示期間の使用の有無

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

    show_start_date

    timezone

    表示期間の開始日

    show_end_date

    timezone

    表示期間の終了日

    image_list

    デコ画像一覧

    List all decoration images

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/decorationimages' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "decorationimages": [
            {
                "code": "icon_01_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_01_01.gif"
            },
            {
                "code": "icon_02_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_02_01.gif"
            },
            {
                "code": "icon_05_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_05_01.gif"
            },
            {
                "code": "custom_1",
                "path": "\/web\/upload\/\/custom_1.gif"
            }
        ]
    }
    

    基本スペック

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

    List all products decoration images

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/decorationimages' \
      -H 'Authorization: Bearer {access_token}' \
      -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

    商品番号

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

    Add decoration images to a products

    Definition

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

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/decorationimages' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "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_3",
                    "image_vertical_position": "C",
                    "image_horizontal_position": "B"
                },
                {
                    "code": "image_custom_4",
                    "image_vertical_position": "L",
                    "image_horizontal_position": "T"
                }
            ]
        }
    }'
    

    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 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

    use_show_date

    表示期間の使用の有無

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

    show_start_date

    Date
    timezone

    表示期間の開始日

    show_end_date

    Date
    timezone

    表示期間の終了日

    image_list
    Required

    デコ画像一覧

    Update a products decorationimage

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/decorationimages' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "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_3",
                    "image_vertical_position": "C",
                    "image_horizontal_position": "B"
                },
                {
                    "code": "image_custom_4",
                    "image_vertical_position": "L",
                    "image_horizontal_position": "T"
                }
            ]
        }
    }'
    

    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 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    use_show_date

    表示期間の使用の有無

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

    show_start_date

    Date
    timezone

    表示期間の開始日

    show_end_date

    Date
    timezone

    表示期間の終了日

    image_list
    Required

    デコ画像一覧

    Delete a decoration images to a product

    Definition

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

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/decorationimages/icon_02_01' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "decorationimage": {
            "code": "icon_02_01"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    code
    Required

    デコ画像コード

    product_no
    Required

    商品番号

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

    Products discountprice

    Products discountprice properties

    Attribute Description
    pc_discount_price

    PC割引価格

    mobile_discount_price

    モバイル割引価格

    List all products discountprice

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/24/discountprice' \
      -H 'Authorization: Bearer {access_token}' \
      -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://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/hits/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/hits/count' \
      -H 'Authorization: Bearer {access_token}' \
      -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 icons

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

    Products icons properties

    Attribute Description
    code

    アイコンコード

    path

    アイコンURL

    List all products icons

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/icons' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "icons": [
            {
                "code": "icon_01_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_01_01.gif"
            },
            {
                "code": "icon_02_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_02_01.gif"
            },
            {
                "code": "icon_05_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_05_01.gif"
            },
            {
                "code": "custom_1",
                "path": "\/web\/upload\/\/custom_1.gif"
            }
        ]
    }
    

    基本スペック

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

    Products images

    商品画像(Products Images)は商品を販売するためにアップロードした商品の写真や絵を意味します。商品画像APIを使って商品詳細説明に使う画像や商品の画像をアップロードすることができます。
    商品の画像はBase64コードでエンコードしてアップロードできます。

    Products images properties

    Attribute Description
    path

    詳細画像

    詳細画像

    shop_no

    ショップ番号

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

    product_no

    商品番号

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

    detail_image

    詳細画像

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

    list_image

    一覧画像

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

    tiny_image

    縮小一覧画像

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

    small_image

    縮小画像

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

    Upload a image

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/products/images'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/images' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "image": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAXSURBVChTY1BQdvhPDB5ViBdTW6HDfwA+dpbJG+7kLwAAAABJRU5ErkJggg==\n"
        }
    }'
    

    Response example:

    {
        "image": {
            "path": "http:\/\/{domain}\/web\/upload\/NNEditor\/20180130\/12ecf27747401c8502ddd6b2e79e1e64.png"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    image
    Required

    詳細画像

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

    Upload product images

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/images'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/images' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "image_upload_type": "B",
            "detail_image": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX\/TQBcNTh\/AAAAAXRSTlPM0jRW\/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=",
            "list_image": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX\/TQBcNTh\/AAAAAXRSTlPM0jRW\/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=",
            "tiny_image": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX\/TQBcNTh\/AAAAAXRSTlPM0jRW\/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=",
            "small_image": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX\/TQBcNTh\/AAAAAXRSTlPM0jRW\/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII="
        }
    }'
    

    Response example:

    {
        "image": {
            "shop_no": 1,
            "product_no": 20,
            "detail_image": "http:\/\/{domain}\/web\/product\/big\/201801\/995feab7d359875e073ae82b48192a7b.jpeg",
            "list_image": "http:\/\/{domain}\/web\/product\/medium\/201801\/995feab7d359875e073ae82b48192a7b.jpeg",
            "tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201801\/995feab7d359875e073ae82b48192a7b.jpeg",
            "small_image": "http:\/\/{domain}\/web\/product\/small\/201801\/995feab7d359875e073ae82b48192a7b.jpeg"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    detail_image

    詳細画像

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

    list_image

    一覧画像

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

    tiny_image

    縮小一覧画像

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

    small_image

    縮小画像

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

    image_upload_type
    Required

    画像アップロードタイプ

    画像のタイプが代表画像か個別画像か、アップロードタイプを指定することができる。代表画像(A)としてアップロードする場合、詳細画像(detail_image)に画像をアップロードすると残りの画像にもすべて反映される。

    A:代表画像登録
    B:個別画像登録

    Delete a products image

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/images'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/images' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "image": {
            "product_no": 20
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Products memos

    商品メモは商品に添付する簡単なメモで、商品に関する特異事項を書いたり運営者同士のコミュニケーションツールとして活用することができます。
    商品メモは下位Entityで、商品(Products)の下位でしか使えません。

    Products memos properties

    Attribute Description
    memo_no

    メモ番号

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

    author_id

    Max Length : [20]

    作成者ID

    メモを作成した管理者のID情報

    created_date

    timezone

    作成日

    メモを作成した時間

    memo

    メモ

    メモの内容。HTMLを使って登録できる。

    List all products memos

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/memos' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "memos": [
            {
                "memo_no": 4,
                "author_id": "subadmin1",
                "created_date": "2018-01-18T11:19:27+09:00",
                "memo": "This is a sample memo."
            },
            {
                "memo_no": 3,
                "author_id": "subadmin2",
                "created_date": "2018-01-18T11:19:27+09:00",
                "memo": "This is a sample memo."
            }
        ]
    }
    

    基本スペック

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

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    limit

    Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    Get a products memo

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/memos/12' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "memo": {
            "memo_no": 12,
            "author_id": "subadmin1",
            "created_date": "2018-01-18T11:19:27+09:00",
            "memo": "This is a sample memo."
        }
    }
    

    基本スペック

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

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    memo_no
    Required

    メモ番号

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

    Create a products memo

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/memos'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/memos' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "author_id": "subadmin1",
            "memo": "This is a sample memo."
        }
    }'
    

    Response example:

    {
        "memo": {
            "memo_no": 7,
            "author_id": "subadmin1",
            "created_date": "2018-01-18T11:19:27+09:00",
            "memo": "This is a sample memo."
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    author_id
    Required

    Max Length : [20]

    作成者ID

    メモを作成した管理者のID情報

    memo
    Required

    メモ

    メモの内容。HTMLを使って登録できる。

    Update a products memo

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/memos/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/memos/7' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "author_id": "subadmin2",
            "memo": "Curabitur mollis consequat ipsum ac."
        }
    }'
    

    Response example:

    {
        "memo": {
            "memo_no": 7,
            "author_id": "subadmin2",
            "created_date": "2018-01-18T11:19:27+09:00",
            "memo": "Curabitur mollis consequat ipsum ac."
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    memo_no
    Required

    メモ番号

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

    author_id
    Required

    Max Length : [20]

    作成者ID

    メモを作成した管理者のID情報

    memo
    Required

    メモ

    メモの内容。HTMLを使って登録できる。

    Delete a products memo

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/memos/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/memos/12' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "memo": {
            "memo_no": 12
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    memo_no
    Required

    メモ番号

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

    Products options

    Products options properties

    Attribute Description
    product_no
    Required

    商品番号

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

    shop_no

    ショップ番号

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

    has_option

    オプション使用の設定

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

    option_type

    オプション構成方式

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

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

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

    option_list_type

    オプション表示方式

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

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

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

    C:一体型
    S:分離型

    option_preset_code

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

    オプションセットコード

    商品連動型オプションを使う場合、オプションセットコード表示

    option

    オプション

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

    select_one_by_option

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

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

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

    option_preset_name

    連動型オプションセット名

    商品連動型オプションを使う場合、オプションセットの名前表示

    use_additional_option

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

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

    additional_option

    追加入力オプション

    use_attached_file_option

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

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

    attached_file_option

    ファイル添付オプション

    Create a products option

    商品オプション登録APIを使ってオプションを登録することができます。オプション登録APIでオプションを登録すると、品目は自動生成されます。

    Definition

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

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/24/options' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "has_option": "T",
            "option_type": "T",
            "option_list_type": "S",
            "option": [
                {
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_text": "Black"
                        },
                        {
                            "option_text": "Red"
                        }
                    ]
                }
            ],
            "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
            }
        }
    }'
    

    Response example:

    {
        "option": {
            "shop_no": 1,
            "product_no": 24,
            "has_option": "T",
            "option_type": "T",
            "option_list_type": "S",
            "option_preset_code": "",
            "option": [
                {
                    "option_code": "",
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_text": "Black",
                            "option_image_file": "",
                            "option_color": "",
                            "value_no": null
                        },
                        {
                            "option_text": "Red",
                            "option_image_file": "",
                            "option_color": "",
                            "value_no": null
                        }
                    ],
                    "required_option": "T",
                    "option_display_type": "S"
                }
            ],
            "select_one_by_option": "F",
            "option_preset_name": "",
            "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 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    has_option

    オプション使用の設定

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

    option_type

    オプション構成方式

    オプションを使う場合、オプションのタイプを入力

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

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

    option_list_type

    オプション表示方式

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

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

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

    S:組み合わせ分離選択型
    C:組み合わせ一体選択型

    option

    オプション

    商品のオプション名とオプション値を入力

    select_one_by_option

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

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

    T:使用する
    F:使用しない 「独立型だけに存在」をチェックするとオプション別に一つずつ選択値を処理

    option_preset_name

    連動型オプションセット名

    商品連動型オプションを使う場合、オプションセットの名前を入力

    use_additional_option

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

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

    additional_option

    追加入力オプション

    use_attached_file_option

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

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

    attached_file_option

    ファイル添付オプション

    Update a products option

    商品オプション修正APIはオプションを修正しながら品目を初期化しません。オプション名とオプション値、追加入力オプションとファイル添付オプションの修正のみ可能で、オプション項目の追加や削除はできません。

    オプションを追加または削除したい場合は、オプション削除APIで削除した後、再度登録しなければなりません。

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/24/options' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "option_list_type": "S",
            "original_option": [
                {
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_text": "Black"
                        },
                        {
                            "option_text": "Red"
                        }
                    ]
                },
                {
                    "option_name": "Size",
                    "option_value": [
                        {
                            "option_text": "Small"
                        },
                        {
                            "option_text": "Large"
                        }
                    ]
                }
            ],
            "option": [
                {
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_text": "Black"
                        },
                        {
                            "option_text": "Red"
                        }
                    ]
                },
                {
                    "option_name": "Size",
                    "option_value": [
                        {
                            "option_text": "Small"
                        },
                        {
                            "option_text": "Large"
                        }
                    ]
                }
            ],
            "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
            }
        }
    }'
    

    Response example:

    {
        "option": {
            "shop_no": 1,
            "product_no": 24,
            "has_option": "T",
            "option_type": "T",
            "option_list_type": "S",
            "option_preset_code": "",
            "option": [
                {
                    "option_code": "",
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_831549.gif",
                            "option_color": "#000000",
                            "option_text": "Black",
                            "value_no": null
                        },
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_831549.gif",
                            "option_color": "#007543",
                            "option_text": "Red",
                            "value_no": null
                        }
                    ],
                    "required_option": "T",
                    "option_display_type": "S"
                },
                {
                    "option_code": "",
                    "option_name": "Size",
                    "option_value": [
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_931549.gif",
                            "option_color": "#000000",
                            "option_text": "Small",
                            "value_no": null
                        },
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_931549.gif",
                            "option_color": "#007543",
                            "option_text": "Large",
                            "value_no": null
                        }
                    ],
                    "required_option": "T",
                    "option_display_type": "S"
                }
            ],
            "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 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    option_list_type

    オプション表示方式

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

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

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

    S:組み合わせ分離選択型
    C:組み合わせ一体選択型

    option_preset_code

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

    オプションセットコード

    商品連動型オプションを使う場合、オプションセットコード入力

    option

    オプション

    修正するオプション名とオプション値を入力

    original_option

    修正前のオプション値

    修正するオプション名とオプション値を入力。そのフィールドには修正するオプション名とオプション値を入力し、original_optionに入力したオプションがoptionに入力したオプション名とオプション値にアップデートされる。

    select_one_by_option

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

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

    T:使用する
    F:使用しない 「独立型だけに存在」をチェックするとオプション別に一つずつ選択値を処理

    option_preset_name

    連動型オプションセット名

    商品連動型オプションを使う場合、オプションセットの名前を入力

    use_additional_option

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

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

    additional_option

    追加入力オプション

    use_attached_file_option

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

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

    attached_file_option

    ファイル添付オプション

    Delete a products option

    Definition

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

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/24/options' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "option": {
            "product_no": 24
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    List all products option

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/options' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "option": {
            "shop_no": 1,
            "product_no": 7,
            "has_option": "T",
            "option_type": "E",
            "option_display_type": "S",
            "option_preset_code": "S000000A",
            "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",
            "option_preset_name": "",
            "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 seo

    SEOは検索エンジンの最適化(Search Engine Optimization)の略語で、SEO APIは検索エンジンで商品やショップがよりよく検索できるようにします。
    商品の下位Entityで、SEO APIは商品の検索エンジンの最適化設定ができます。

    Products seo properties

    Attribute Description
    shop_no

    ショップ番号

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

    meta_title

    ブラウザでのタイトル

    商品詳細ページのTitleタグに表示される情報。Titleタグはブラウザーに表示される情報で、検索エンジンで検索時に一番基本的な情報である。

    meta_author

    メタタグ1:Author

    商品詳細ページのタグに表示される情報。authorメタタグにはその商品を製造した人または登録した人を記入する。

    meta_description

    メタタグ2:Description

    商品詳細ページのタグに表示される情報。descriptionタグに検索結果ページで検索結果の下に表示される簡単な情報を入力することができる。

    meta_keywords

    メタタグ3:Keywords

    商品詳細ページのタグに表示される情報。keywordタグにその商品が検索されてほしいと思う検索キーワードを入力することができる。

    meta_alt

    商品画像Altテキスト

    商品画像に表示されるAltテキスト情報。Altテキストを入力しておくと検索エンジンで画像検索時に検索される可能性が高くなり、ブラウザーで画像の代わりに関連テキストを出力することができるため、ウェブのアクセス性にも有利である。

    search_engine_exposure

    検索エンジンへの表示設定

    商品を検索エンジンに表示するかどうかを設定。「表示しない」に設定する場合、その商品が検索エンジンに表示されない。

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

    Get products seo

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/seo' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "seo": {
            "shop_no": 1,
            "meta_title": "product title",
            "meta_author": "This is Author",
            "meta_description": "This is Description.",
            "meta_keywords": "This is Keyword.",
            "meta_alt": "image1, image2",
            "search_engine_exposure": "T"
        }
    }
    

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Update a products seo

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/seo'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/seo' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "meta_title": "Updated title",
            "meta_author": "Updated Author",
            "meta_description": "Updated Description",
            "meta_keywords": "Updated Keywords",
            "meta_alt": "Upadted Alt Text",
            "search_engine_exposure": "T"
        }
    }'
    

    Response example:

    {
        "seo": {
            "shop_no": 1,
            "meta_title": "Updated title",
            "meta_author": "Updated Author",
            "meta_description": "Updated Description",
            "meta_keywords": "Updated Keywords",
            "meta_alt": "Upadted Alt Text",
            "search_engine_exposure": "T"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    meta_title

    ブラウザでのタイトル

    商品詳細ページのTitleタグに表示される情報。Titleタグはブラウザーに表示される情報で、検索エンジンで検索時に一番基本的な情報である。

    meta_author

    メタタグ1:Author

    商品詳細ページのタグに表示される情報。authorメタタグにはその商品を製造した人または登録した人を記入する。

    meta_description

    メタタグ2:Description

    商品詳細ページのタグに表示される情報。descriptionタグに検索結果ページで検索結果の下に表示される簡単な情報を入力することができる。

    meta_keywords

    メタタグ3:Keywords

    商品詳細ページのタグに表示される情報。keywordタグにその商品が検索されてほしいと思う検索キーワードを入力することができる。

    meta_alt

    商品画像Altテキスト

    商品画像に表示されるAltテキスト情報。Altテキストを入力しておくと検索エンジンで画像検索時に検索される可能性が高くなり、ブラウザーで画像の代わりに関連テキストを出力することができるため、ウェブのアクセス性にも有利である。

    search_engine_exposure

    検索エンジンへの表示設定

    商品を検索エンジンに表示するかどうかを設定。「表示しない」に設定する場合、その商品が検索エンジンに表示されない。

    Products tags

    Products tags properties

    Attribute Description
    shop_no

    ショップ番号

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

    product_no

    商品番号

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

    tag

    商品タグ

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

    Create a products tag

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/tags'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/tags' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "tag": [
                "Tag1",
                "Tag2"
            ]
        }
    }'
    

    Response example:

    {
        "tag": {
            "shop_no": 1,
            "product_no": 7,
            "tag": [
                "Tag1",
                "Tag2"
            ]
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    tag
    Required

    商品タグ

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

    List all products tags

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/tags' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "tags": {
            "shop_no": 1,
            "tag": [
                "Tag1",
                "Tag2"
            ]
        }
    }
    

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Count all products tags

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/tags/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Delete a products tag

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/tags/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/tags/Tag1' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "tag": {
            "product_no": 7,
            "tag": "Tag1"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    tag

    商品タグ

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

    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

    オプション

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

    custom_variant_code

    Max Length : [40]

    独自商品コード

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

    display

    表示ステータス

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

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

    selling

    販売ステータス

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

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

    additional_amount

    追加金額

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

    inventories

    在庫Entity

    品目の在庫Entity

    duplicated_custom_variant_code

    独自品目コードの重複有無

    T:重複する
    F:重複しない

    product_no
    Required

    商品番号

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

    List all products variants

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/variants' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "variants": [
            {
                "shop_no": 1,
                "item_code": "P000000R000C",
                "option": [
                    {
                        "name": "Color",
                        "value": "Blue"
                    },
                    {
                        "name": "Size",
                        "value": "Small"
                    }
                ],
                "custom_variant_code": "",
                "display": "T",
                "selling": "T",
                "additional_amount": "0.00"
            },
            {
                "shop_no": 1,
                "item_code": "P000000R000D",
                "option": [
                    {
                        "name": "Color",
                        "value": "Red"
                    },
                    {
                        "name": "Size",
                        "value": "Small"
                    }
                ],
                "custom_variant_code": "",
                "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://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/variants/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/variants/P000000R000C' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "variant": {
            "shop_no": 1,
            "variant_code": "P000000R000C",
            "option": [
                {
                    "name": "Color",
                    "value": "Black"
                }
            ],
            "custom_variant_code": "",
            "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パラメーターを使って照会することができる。

    Update a products variant

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/16/variants/P000000P000A' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "custom_variant_code": "OPTION_CUSTOM_CODE",
            "display": "T",
            "selling": "F",
            "additional_amount": -1000,
            "quantity": 15,
            "use_inventory": "T",
            "important_inventory": "A",
            "inventory_control_type": "B",
            "display_soldout": "T"
        }
    }'
    

    Response example:

    {
        "variant": {
            "shop_no": 1,
            "variant_code": "P000000R000A",
            "option": [
                {
                    "name": "Color",
                    "value": "Black"
                }
            ],
            "custom_variant_code": "OPTION_CUSTOM_CODE",
            "duplicated_custom_variant_code": "F",
            "display": "T",
            "selling": "F",
            "additional_amount": -1000,
            "inventories": {
                "shop_no": 1,
                "variant_code": "P000000R000A",
                "quantity": 15,
                "use_inventory": "T",
                "important_inventory": "A",
                "inventory_control_type": "B",
                "display_soldout": "T"
            }
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    variant_code
    Required

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

    商品品目コード

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

    custom_variant_code

    Max Length : [40]

    独自商品コード

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

    display

    表示ステータス

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

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

    selling

    販売ステータス

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

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

    additional_amount

    追加金額

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

    quantity

    数量

    use_inventory

    在庫使用の設定

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

    important_inventory

    重要在庫の有無

    A:一般在庫
    B:重要在庫

    inventory_control_type

    在庫数量チェックの基準

    A:注文基準
    B:決済基準

    display_soldout

    在庫切れ表示の設定

    T:在庫切れ表示を使用する
    F:在庫切れ表示を使用しない

    Delete a products variant

    Definition

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

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/16/variants/P000000P000A' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "variant": {
            "product_no": 16,
            "variant_code": "P000000P000A"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    variant_code
    Required

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

    商品品目コード

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

    Update products variants

    一つの商品に対する複数の品目を同時に修正できる品目修正(マルチ)APIです。

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/16/variants' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": [
            {
                "variant_code": "P000000P000B",
                "custom_variant_code": "OPTION_CUSTOM_CODE",
                "display": "T",
                "selling": "F",
                "additional_amount": -1000,
                "quantity": 15,
                "use_inventory": "T",
                "important_inventory": "A",
                "inventory_control_type": "A",
                "display_soldout": "T"
            },
            {
                "variant_code": "P000000P000C",
                "custom_variant_code": "OPTION_CUSTOM_CODE",
                "display": "T",
                "selling": "F",
                "additional_amount": -1000,
                "quantity": 15,
                "use_inventory": "T",
                "important_inventory": "A",
                "inventory_control_type": "A",
                "display_soldout": "T"
            }
        ]
    }'
    

    Response example:

    {
        "variants": [
            {
                "shop_no": 1,
                "variant_code": "P000000P000B",
                "custom_variant_code": "OPTION_CUSTOM_CODE",
                "option": [
                    {
                        "name": "Color",
                        "value": "Black"
                    }
                ],
                "display": "T",
                "selling": "F",
                "additional_amount": -1000,
                "inventories": {
                    "shop_no": 1,
                    "variant_code": "P000000P000B",
                    "quantity": 15,
                    "use_inventory": "T",
                    "important_inventory": "A",
                    "inventory_control_type": "B",
                    "display_soldout": "T"
                }
            },
            {
                "shop_no": 1,
                "variant_code": "P000000P000C",
                "custom_variant_code": "OPTION_CUSTOM_CODE",
                "option": [
                    {
                        "name": "Color",
                        "value": "Red"
                    }
                ],
                "display": "T",
                "selling": "F",
                "additional_amount": -1000,
                "inventories": {
                    "shop_no": 1,
                    "variant_code": "P000000P000B",
                    "quantity": 15,
                    "use_inventory": "T",
                    "important_inventory": "A",
                    "inventory_control_type": "B",
                    "display_soldout": "T"
                }
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    variant_code
    Required

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

    商品品目コード

    custom_variant_code

    Max Length : [40]

    独自商品コード

    display

    表示ステータス

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

    selling

    販売ステータス

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

    additional_amount

    追加金額

    quantity

    数量

    use_inventory

    在庫使用の設定

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

    important_inventory

    重要在庫の有無

    A:一般在庫
    B:重要在庫

    inventory_control_type

    在庫数量チェックの基準

    A:注文基準
    B:決済基準

    display_soldout

    在庫切れ表示の設定

    T:在庫切れ表示を使用する
    F:在庫切れ表示を使用しない

    Products variants inventories

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

    Products variants inventories properties

    Attribute Description
    shop_no

    ショップ番号

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

    variant_code

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

    品目コード

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

    use_inventory

    在庫使用の設定

    品目に対して在庫管理を使うかどうかを設定。在庫管理を使う場合、在庫数を入力することができる。在庫管理を使わない場合、その商品は在庫と関係なく販売可能で、在庫数、在庫数チェック基準、在庫切れ表示の設定を使うことができない。

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

    important_inventory

    重要在庫の有無

    在庫を重要管理するかどうかを設定。ショップでは検索するための区分データとして使う。

    A:一般在庫
    B:重要在庫

    inventory_control_type

    在庫数量チェックの基準

    在庫数量をどの時点で差し引くかという基準。銀行振込のように決済時点と注文時点が異なる場合は在庫を差し引く基準をそれぞれ設定することができる。

    注文基準: 注文した時点で在庫を差し引く。銀行振込の場合は入金が完了しなくても在庫を差し引く。
    決済基準: 決済した時点で在庫を差し引く。銀行振込の場合は入金が完了した後、在庫を差し引く。

    A:注文基準
    B:決済基準

    display_soldout

    在庫切れ表示の設定

    在庫がすべて販売された場合、その品目を在庫切れと表示するかどうかの設定。在庫切れと表示されると注文ができない。すべての品目が在庫切れになる場合はその商品に在庫切れアイコンが表示される。
    「表示しない」を選択すると在庫がすべて販売されても注文が可能で、在庫がマイナス(-)と表記される。

    T:在庫切れ表示を使用する
    F:在庫切れ表示を使用しない

    quantity

    数量

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

    List all products variants inventory

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/variants/P000000R000C/inventories' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "inventory": {
            "shop_no": 1,
            "variant_code": "P000000R000C",
            "use_inventory": "T",
            "important_inventory": "A",
            "inventory_control_type": "B",
            "display_soldout": "F",
            "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]

    品目コード

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

    Update a products variants inventory

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/variants/P00000GR000A/inventories' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "use_inventory": "T",
            "important_inventory": "A",
            "inventory_control_type": "A",
            "display_soldout": "T",
            "quantity": 3
        }
    }'
    

    Response example:

    {
        "inventory": {
            "shop_no": 1,
            "variant_code": "P00000GR000A",
            "use_inventory": "T",
            "important_inventory": "A",
            "inventory_control_type": "A",
            "display_soldout": "T",
            "quantity": 3
        }
    }
    

    基本スペック

    Property Description
    SCOPE 商品 投稿権限 (WRITE_PRODUCT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    variant_code
    Required

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

    品目コード

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

    use_inventory

    在庫使用の設定

    品目に対して在庫管理を使うかどうかを設定。在庫管理を使う場合、在庫数を入力することができる。在庫管理を使わない場合、その商品は在庫と関係なく販売可能で、在庫数、在庫数チェック基準、在庫切れ表示の設定を使うことができない。

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

    important_inventory

    重要在庫の有無

    在庫を重要管理するかどうかを設定。ショップでは検索するための区分データとして使う。

    A:一般在庫
    B:重要在庫

    inventory_control_type

    在庫数量チェックの基準

    在庫数量をどの時点で差し引くかという基準。銀行振込のように決済時点と注文時点が異なる場合は在庫を差し引く基準をそれぞれ設定することができる。

    注文基準: 注文した時点で在庫を差し引く。銀行振込の場合は入金が完了しなくても在庫を差し引く。
    決済基準: 決済した時点で在庫を差し引く。銀行振込の場合は入金が完了した後、在庫を差し引く。

    A:注文基準
    B:決済基準

    display_soldout

    在庫切れ表示の設定

    在庫がすべて販売された場合、その品目を在庫切れと表示するかどうかの設定。在庫切れと表示されると注文ができない。すべての品目が在庫切れになる場合はその商品に在庫切れアイコンが表示される。
    「表示しない」を選択すると在庫がすべて販売されても注文が可能で、在庫がマイナス(-)と表記される。

    T:在庫切れ表示を使用する
    F:在庫切れ表示を使用しない

    quantity

    数量

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

    Reports salesvolume

    販売数量(SalesVolume)はショップの商品が販売された数量を意味します。販売数量は定期的に集計及びアップデートされるため、リアルタイムで反映されないことがあります。

    Reports salesvolume properties

    Attribute Description
    shop_no

    ショップ番号

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

    collection_date

    精算収集日付

    販売量の統計が収集された収集日

    collection_hour

    精算収集時間

    販売量の統計が収集された収集時間

    product_price

    商品販売価格

    商品の価格

    product_option_price

    商品オプション価格

    品目のオプション追加価格

    settle_count

    決済完了数量

    検索期間にその品目の決済が完了した数量

    exchane_product_count

    交換完了数量

    検索期間にその品目が交換された数量

    cancel_product_count

    キャンセル完了数量

    検索期間にその品目がキャンセルされた数量

    return_product_count

    返品完了数量

    検索期間にその品目が返品された数量

    updated_date

    timezone

    最終データ更新時間

    販売数量統計データが更新された時間表示

    variants_code

    品目コード

    品目のコード

    product_no

    商品番号

    total_sales

    販売件数の合計

    検索期間にその品目が販売された総数

    Get sales volume

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/reports/salesvolume'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/reports/salesvolume?variants_code=P0000BKE000A&product_no=16&start_date=2018-10-27 14:10:00&end_date=2018-10-28 14:10:59' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "salesvolume": [
            {
                "shop_no": "1",
                "collection_date": "2018-10-27",
                "collection_hour": "12",
                "product_price": "10000.00",
                "product_option_price": "0.00",
                "settle_count": "2",
                "exchane_product_count": "0",
                "cancel_product_count": "0",
                "return_product_count": "0",
                "updated_date": "2018-10-27T14:51+09:00",
                "product_no": 16,
                "variants_code": "P0000BKE000A",
                "change_cancel_product_count": "0",
                "total_sales": "2"
            },
            {
                "shop_no": "1",
                "collection_date": "2018-10-27",
                "collection_hour": "12",
                "product_price": "10000.00",
                "product_option_price": "0.00",
                "settle_count": "23",
                "exchane_product_count": "0",
                "cancel_product_count": "0",
                "return_product_count": "0",
                "updated_date": "2018-10-27T14:51+09:00",
                "product_no": 16,
                "variants_code": "P0000BKE000B",
                "change_cancel_product_count": "0",
                "total_sales": "23"
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 売上統計 閲覧権限 (READ_SALESREPORT)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no

    商品番号

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

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

    variants_code

    品目コード

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

    category_no

    カテゴリ番号

    販売数量の中で特定カテゴリで販売された数量の検索

    mobile

    モバイル/PC

    販売数量の中でモバイルウェブで販売された数量の検索

    T:モバイル
    F:その外

    delivery_type

    配送タイプ

    販売数量の中で国内または海外配送数量の検索

    A:国内
    B:海外

    customer_group_no

    会員ランク番号

    販売数量のうち、特定会員ランクで注文された数量の検索

    supplier_id

    Max Length : [20]

    供給会社のID

    販売数量の中で特定の供給会社のIDで登録された数量の検索

    start_date
    Required

    Date
    timezone

    検索開始日

    販売数量を検索する検索開始日(注文日基準)
    検索終了日と必ずペアで使用すること。

    end_date
    Required

    Date
    timezone

    検索終了日

    販売数量を検索する検索終了日(注文日基準)
    検索開始日と必ずペアで使用すること。

    Reviews

    Review de Talk(Reviews)は商品やサービスを利用したショップの顧客がレビューを書くサービスを意味します。Review de Talk APIを使うためにはまずショップで Review de Talkサービスを使っているか確認する必要があります。

    Reviews properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    product_no

    상품번호

    review_no

    리뷰 번호

    order_id

    Order ID

    주문 번호

    nickname

    작성자 별명

    title

    리뷰 제목

    content

    리뷰 내용

    content_text_length

    리뷰글 텍스트 길이

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    writer

    작성자명

    writing_id

    작성자 회원 아이디

    created_date

    Date
    timezone

    작성일자

    comment_count

    댓글 갯수

    like_count

    Min : [0]

    좋아요 횟수

    share_count

    Min : [0]

    SNS 공유 횟수

    hit_count

    Min : [0]

    조회수

    additional_information

    추가 항목

    images

    첨부 이미지

    レビューに添付する画像

    tags

    해시태그

    rating

    평점

    use_share

    SNS 공유 여부

    レビューのSNSシェアの有無

    T : 공유함
    F : 공유안함

    display

    게시 여부

    レビューの掲示の有無

    T : 게시함
    F : 게시안함

    deleted

    삭제 여부

    T : 삭제됨
    F : 삭제되지 않음

    Create a review

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/reviews'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "writing_id": "user",
            "input_channel": "P",
            "content": "#recommend #popular product.",
            "item_code": "P000000J000A",
            "images": [
                "https:\/\/reviewtalktalk.poxo.com\/sampleid\/2016\/10\/20\/6660b56b72d3633c83744eb4d4b53209.PNG",
                "https:\/\/reviewtalktalk.poxo.com\/sampleid\/2016\/10\/26\/c5fd9f37eab7a37eb4aed1f0ee38879e.jpg"
            ],
            "additional_information": [
                "170~180",
                "95"
            ],
            "order_id": "20180116-0000026",
            "use_share": "F",
            "product_no": 10,
            "rating": "4.0",
            "tags": [
                "recommend",
                "popular"
            ]
        }
    }'
    

    Response example:

    {
        "review": {
            "shop_no": 1,
            "product_no": 10,
            "review_no": 106,
            "order_id": "20180116-0000026",
            "nickname": "",
            "title": "#recommend #popular product.",
            "content": "#recommend #popular product.",
            "content_text_length": 28,
            "input_channel": "P",
            "writer": "John Doe",
            "writing_id": "user",
            "created_date": "2018-01-22T10:46:51+09:00",
            "comment_count": 0,
            "like_count": 0,
            "share_count": 0,
            "hit_count": 0,
            "additional_information": [
                {
                    "item_name": "Height",
                    "item_value": "170~180"
                },
                {
                    "item_name": "Size",
                    "item_value": "95"
                }
            ],
            "images": [
                {
                    "name": "39a9e7d3892c58034cd2357f74e5b04f.PNG",
                    "size": 143543,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/5358112ce7e01d423597ccd51eeb415a.PNG",
                    "thumb": {
                        "size": 222879,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/5358112ce7e01d423597ccd51eeb415a.PNG",
                        "width": 300,
                        "height": 409,
                        "tiny": {
                            "size": 12104,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/5358112ce7e01d423597ccd51eeb415a.PNG"
                        }
                    }
                },
                {
                    "name": "82c5736941ee04e49a172f620b3f1685.jpg",
                    "size": 83742,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/820ca38030768fc4dcc88789f75341c3.jpg",
                    "thumb": {
                        "size": 7779,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/820ca38030768fc4dcc88789f75341c3.jpg",
                        "width": 300,
                        "height": 200,
                        "tiny": {
                            "size": 1983,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/820ca38030768fc4dcc88789f75341c3.jpg"
                        }
                    }
                }
            ],
            "tags": [
                "recommend",
                "popular"
            ],
            "rating": 4,
            "use_share": "F",
            "display": "T",
            "deleted": "F"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 掲示板 投稿権限 (WRITE_COMMUNITY)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    writing_id
    Required

    작성자 회원 아이디

    product_no
    Required

    상품번호

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

    order_id

    Order ID

    주문번호

    item_code
    Required

    품목코드

    レビューを作成する商品の品目コード

    content
    Required

    Max Length : [2000]

    리뷰 내용

    rating

    평점

    DEFAULT 5

    additional_information

    추가항목

    images

    첨부 이미지

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    DEFAULT P

    use_share

    SNS 공유 여부

    T : 공유함
    F : 공유안함

    List all reviews

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/reviews'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "reviews": [
            {
                "shop_no": 1,
                "product_no": 10,
                "review_no": 1,
                "order_id": "20180116-0000001",
                "nickname": "",
                "title": "#recommend #popular product.",
                "content": "#recommend #popular product.",
                "content_text_length": 28,
                "input_channel": "P",
                "writer": "John Doe",
                "writing_id": "user1",
                "created_date": "2018-01-17T17:57:40+09:00",
                "comment_count": 0,
                "like_count": 0,
                "share_count": 0,
                "hit_count": 0,
                "additional_information": [
                    {
                        "item_name": "Height",
                        "item_value": "170~180"
                    },
                    {
                        "item_name": "Size",
                        "item_value": "95"
                    }
                ],
                "images": [
                    {
                        "name": "39a9e7d3892c58034cd2357f74e5b04f.PNG",
                        "size": 143543,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/5358112ce7e01d423597ccd51eeb415a.PNG",
                        "thumb": {
                            "size": 222879,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/5358112ce7e01d423597ccd51eeb415a.PNG",
                            "width": 300,
                            "height": 409,
                            "tiny": {
                                "size": 12104,
                                "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/5358112ce7e01d423597ccd51eeb415a.PNG"
                            }
                        }
                    },
                    {
                        "name": "82c5736941ee04e49a172f620b3f1685.jpg",
                        "size": 83742,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/820ca38030768fc4dcc88789f75341c3.jpg",
                        "thumb": {
                            "size": 7779,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/820ca38030768fc4dcc88789f75341c3.jpg",
                            "width": 300,
                            "height": 200,
                            "tiny": {
                                "size": 1983,
                                "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/820ca38030768fc4dcc88789f75341c3.jpg"
                            }
                        }
                    }
                ],
                "tags": [
                    "recommend",
                    "popular"
                ],
                "rating": 3.5,
                "use_share": "F",
                "display": "T",
                "deleted": "T"
            },
            {
                "shop_no": 1,
                "product_no": 12,
                "review_no": 2,
                "order_id": "20180108-0000039",
                "nickname": "",
                "title": "Good Product.",
                "content": "Good!",
                "content_text_length": 8,
                "input_channel": "P",
                "writer": "John Doe",
                "writing_id": "user1",
                "created_date": "2018-01-08T11:46:56+09:00",
                "comment_count": 0,
                "like_count": 0,
                "share_count": 0,
                "hit_count": 0,
                "additional_information": "",
                "images": null,
                "tags": [],
                "rating": 1.5,
                "use_share": "T",
                "display": "T",
                "deleted": "F"
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 掲示板 閲覧権限 (READ_COMMUNITY)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no

    리뷰 번호

    writing_id

    작성자 회원 아이디

    会員ID

    created_start_date

    Date
    timezone

    작성일 검색 시작일

    レビュー作成日基準検索の検索開始日
    検索終了日と必ずペアで使用すること。

    created_end_date

    Date
    timezone

    작성일 검색 종료일

    レビュー作成日基準検索の検索終了日
    検索開始日と必ずペアで使用すること。

    deleted

    삭제된 리뷰글 여부

    レビューが削除されたどうかの区分

    T : 삭제됨
    F : 삭제되지 않음

    DEFAULT F

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    has_comment

    댓글이 작성된 리뷰만 검색

    T : 댓글이 작성된 리뷰만 검색
    F : 댓글이 작성되지 않은 리뷰만 검색

    has_image

    이미지가 첨부된 리뷰만 검색

    T : 이미지가 첨부된 리뷰만 검색
    F : 이미지가 첨부되지 않은 리뷰만 검색

    search_key

    검색 대상 항목

    writer : 작성자명
    writing_id : 작성자 회원 아이디
    content : 리뷰 내용
    product_no : 상품 번호
    product_name : 상품명
    product_code : 상품 코드

    keyword

    검색어

    mileage

    적립금 지급 여부

    todo : 지급안함
    done : 지급함

    limit

    Min : [1]

    목록에 표시 할 목록 갯수

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

    DEFAULT 50

    offset

    Min : [0]

    목록을 가져올 시작 위치

    検索結果の開始位置

    Get a review

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "review": {
            "shop_no": 1,
            "product_no": 10,
            "review_no": 1,
            "order_id": "20180116-0000001",
            "nickname": "",
            "title": "#recommend #popular product.",
            "content": "#recommend #popular product.",
            "content_text_length": 16,
            "input_channel": "P",
            "writer": "John Doe",
            "writing_id": "user1",
            "created_date": "2018-01-17T17:57:40+09:00",
            "comment_count": 0,
            "like_count": 0,
            "share_count": 0,
            "hit_count": 0,
            "additional_information": [
                {
                    "item_name": "Height",
                    "item_value": "170~180"
                },
                {
                    "item_name": "Size",
                    "item_value": "95"
                }
            ],
            "images": [
                {
                    "name": "39a9e7d3892c58034cd2357f74e5b04f.PNG",
                    "size": 143543,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/5358112ce7e01d423597ccd51eeb415a.PNG",
                    "thumb": {
                        "size": 222879,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/5358112ce7e01d423597ccd51eeb415a.PNG",
                        "width": 300,
                        "height": 409,
                        "tiny": {
                            "size": 12104,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/5358112ce7e01d423597ccd51eeb415a.PNG"
                        }
                    }
                },
                {
                    "name": "82c5736941ee04e49a172f620b3f1685.jpg",
                    "size": 83742,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/820ca38030768fc4dcc88789f75341c3.jpg",
                    "thumb": {
                        "size": 7779,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/820ca38030768fc4dcc88789f75341c3.jpg",
                        "width": 300,
                        "height": 200,
                        "tiny": {
                            "size": 1983,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/820ca38030768fc4dcc88789f75341c3.jpg"
                        }
                    }
                }
            ],
            "tags": [
                "recommend",
                "popular"
            ],
            "rating": 2.5,
            "use_share": "F",
            "display": "T",
            "deleted": "T"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 掲示板 閲覧権限 (READ_COMMUNITY)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    Count all reviews

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    基本スペック

    Property Description
    SCOPE 掲示板 閲覧権限 (READ_COMMUNITY)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    writing_id

    작성자 회원 아이디

    会員ID

    created_start_date

    Date
    timezone

    작성일 검색 시작일

    レビュー作成日基準検索の検索開始日
    検索終了日と必ずペアで使用すること。

    created_end_date

    Date
    timezone

    작성일 검색 종료일

    レビュー作成日基準検索の検索終了日
    検索開始日と必ずペアで使用すること。

    deleted

    삭제된 리뷰글 여부

    レビューが削除されたどうかの区分

    T : 삭제됨
    F : 삭제되지 않음

    DEFAULT F

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    has_comment

    댓글이 작성된 리뷰만 검색

    T : 댓글이 작성된 리뷰만 검색
    F : 댓글이 작성되지 않은 리뷰만 검색

    has_image

    이미지가 첨부된 리뷰만 검색

    T : 이미지가 첨부된 리뷰만 검색
    F : 이미지가 첨부되지 않은 리뷰만 검색

    search_key

    검색 대상 항목

    writer : 작성자명
    writing_id : 작성자 회원 아이디
    content : 리뷰 내용
    product_no : 상품 번호
    product_name : 상품명
    product_code : 상품 코드

    keyword

    검색어

    mileage

    적립금 지급 여부

    todo : 지급안함
    done : 지급함

    Update a review

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "content": "#cool #best product review.",
            "rating": "3.0",
            "images": [
                "https:\/\/reviewtalktalk.poxo.com\/sampleid\/2016\/10\/20\/6660b56b72d3633c83744eb4d4b53209.PNG",
                "https:\/\/reviewtalktalk.poxo.com\/sampleid\/2016\/10\/26\/c5fd9f37eab7a37eb4aed1f0ee38879e.jpg"
            ],
            "additional_information": [
                "170~180",
                "95"
            ],
            "use_share": "T",
            "product_no": 10,
            "tags": [
                "cool",
                "best"
            ]
        }
    }'
    

    Response example:

    {
        "review": {
            "shop_no": 1,
            "product_no": 10,
            "review_no": 1,
            "order_id": "20180116-0000001",
            "nickname": "",
            "title": "#cool #best product review.",
            "content": "#cool #best product review.",
            "content_text_length": 27,
            "input_channel": "P",
            "writer": "John Doe",
            "writing_id": "user1",
            "created_date": "2018-01-17T17:57:40+09:00",
            "comment_count": 0,
            "like_count": 0,
            "share_count": 0,
            "hit_count": 0,
            "additional_information": [
                {
                    "item_name": "Height",
                    "item_value": "170~180"
                },
                {
                    "item_name": "Size",
                    "item_value": "95"
                }
            ],
            "images": [
                {
                    "name": "39a9e7d3892c58034cd2357f74e5b04f.PNG",
                    "size": 143543,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/5358112ce7e01d423597ccd51eeb415a.PNG",
                    "thumb": {
                        "size": 222879,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/5358112ce7e01d423597ccd51eeb415a.PNG",
                        "width": 300,
                        "height": 409,
                        "tiny": {
                            "size": 12104,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/5358112ce7e01d423597ccd51eeb415a.PNG"
                        }
                    }
                },
                {
                    "name": "82c5736941ee04e49a172f620b3f1685.jpg",
                    "size": 83742,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/820ca38030768fc4dcc88789f75341c3.jpg",
                    "thumb": {
                        "size": 7779,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/820ca38030768fc4dcc88789f75341c3.jpg",
                        "width": 300,
                        "height": 200,
                        "tiny": {
                            "size": 1983,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/820ca38030768fc4dcc88789f75341c3.jpg"
                        }
                    }
                }
            ],
            "tags": [
                "cool",
                "best"
            ],
            "rating": 3,
            "use_share": "T",
            "display": "T",
            "deleted": "T"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 掲示板 投稿権限 (WRITE_COMMUNITY)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    content

    Max Length : [2000]

    리뷰 내용

    rating

    평점

    additional_information

    추가항목

    images

    첨부 이미지

    レビューに添付する画像

    use_share

    SNS 공유 여부

    レビューのSNSシェアの有無

    T : 공유함
    F : 공유안함

    Delete a review

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "review": {
            "review_no": 1
        }
    }
    

    基本スペック

    Property Description
    SCOPE 掲示板 投稿権限 (WRITE_COMMUNITY)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    Reviews comments

    コメント(Comments)はレビューに対する他の顧客やショップ運営者の反応を示します。コメントはレビューに属する下位Entityです。

    Reviews comments properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    review_no

    리뷰 번호

    comment_no

    댓글 번호

    content

    댓글 내용

    writer

    작성자명

    nickname

    작성자 별명

    ip

    IP

    작성자의 IP 주소

    writing_id

    작성자 회원 아이디

    created_date

    Date
    timezone

    작성 일자

    Create a reviews comment

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}/comments'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1/comments' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "writing_id": "user1",
            "content": "sample comment."
        }
    }'
    

    Response example:

    {
        "comment": {
            "shop_no": 1,
            "review_no": 1,
            "comment_no": 11,
            "content": "sample comment.",
            "writer": "John Doe",
            "nickname": "Cool john dude",
            "ip": "127.0.0.1",
            "writing_id": "user1",
            "created_date": "2018-01-22T15:51:39+09:00"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 掲示板 投稿権限 (WRITE_COMMUNITY)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    writing_id

    작성자 회원 아이디

    content
    Required

    댓글 내용

    List all reviews comments

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}/comments'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1/comments' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "comments": [
            {
                "shop_no": 1,
                "review_no": 1,
                "comment_no": 12,
                "content": "sample comment.",
                "writer": "John Doe",
                "nickname": "Cool john dude",
                "ip": "127.0.0.1",
                "writing_id": "user1",
                "created_date": "2018-01-22T15:52:51+09:00"
            },
            {
                "shop_no": 1,
                "review_no": 1,
                "comment_no": 11,
                "content": "sample comment.",
                "writer": "John Doe",
                "nickname": "Cool john dude",
                "ip": "127.0.0.1",
                "writing_id": "user1",
                "created_date": "2018-01-22T15:51:39+09:00"
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE 掲示板 閲覧権限 (READ_COMMUNITY)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    limit

    Min : [1]

    목록에 표시 할 목록 갯수

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

    DEFAULT 50

    offset

    Min : [0]

    목록을 가져올 시작 위치

    検索結果の開始位置

    Get a reviews comment

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}/comments/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1/comments/11' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "comment": {
            "shop_no": 1,
            "review_no": 1,
            "comment_no": 11,
            "content": "sample comment.",
            "writer": "John Doe",
            "nickname": "Cool john dude",
            "ip": "127.0.0.1",
            "writing_id": "user1",
            "created_date": "2018-01-22T15:51:39+09:00"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 掲示板 閲覧権限 (READ_COMMUNITY)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    comment_no
    Required

    댓글 번호

    Update a reviews comment

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}/comments/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1/comments/11' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "content": "modify sample comment."
        }
    }'
    

    Response example:

    {
        "comment": {
            "shop_no": 1,
            "review_no": 1,
            "comment_no": 11,
            "content": "modify sample comment.",
            "writer": "John Doe",
            "nickname": "Cool john dude",
            "ip": "127.0.0.1",
            "writing_id": "user1",
            "created_date": "2018-01-22T15:51:39+09:00"
        }
    }
    

    基本スペック

    Property Description
    SCOPE 掲示板 投稿権限 (WRITE_COMMUNITY)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    comment_no
    Required

    댓글 번호

    content
    Required

    댓글 내용

    Delete a reviews comment

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}/comments/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1/comments/11' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "comment": {
            "review_no": 1,
            "comment_no": 11
        }
    }
    

    基本スペック

    Property Description
    SCOPE 掲示板 投稿権限 (WRITE_COMMUNITY)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    comment_no
    Required

    댓글 번호

    Scripttags

    スクリプト(Scripttags)はアプリでショップの特定画面(Page)に遠隔でスクリプトを設置するために使うAPIです。スクリプトAPIを使ってショップのデザインを変更せずにショップの画面に機能を簡単に追加することができます。

    スクリプト(Scripttags)の{#id}は「script no」です。

    Scripttags properties

    Attribute Description
    shop_no

    ショップ番号

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

    script_no

    scriptの固有番号

    スクリプトの固有番号

    client_id

    Client ID

    スクリプトを設置したClientのID

    src

    URL

    原本script経路

    設置するスクリプトの原本経路(絶対経路)

    display_location

    画面経路

    スクリプトを表示する「画面経路」。画面経路は画面のページ経路ではなく、ショップの各ページに付与された特定の役割を意味する。
    (例: 商品カテゴリ(product_list)にスクリプトを挿入する場合、ショップで商品カテゴリとして使われるすべてのページにスクリプトが表示される)

    画面の役割はそのページに使われたモジュールによって自動付与される。任意のページに商品カテゴリモジュールを追加すると、そのページは「商品カテゴリ」の役割として認識される。ショップ管理者画面の「デザイン管理 > ショップ環境設定 > 画面経路 > 画面経路設定」で各ページに付与された画面の役割を検索・設定することができる。

    「all」の場合、すべてのページにスクリプトが適用される。

    画面経路コード表

    skin_no

    スキン番号

    スクリプトを適用するデザイン番号

    created_date

    timezone

    作成日

    スクリプトの設置日

    updated_date

    timezone

    修正日

    スクリプトの修正日

    List all scripttags

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/scripttags'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/scripttags' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "scripttags": [
            {
                "shop_no": 1,
                "script_no": "1509432821494844",
                "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
                "src": "https:\/\/js-aplenty.com\/bar.js",
                "display_location": [
                    "BOARD_FREE_LIST"
                ],
                "skin_no": [
                    1,
                    2
                ],
                "created_date": "2017-10-31T15:53:41+09:00",
                "updated_date": "2017-11-03T18:05:32+09:00"
            },
            {
                "shop_no": 1,
                "script_no": "1509699932016345",
                "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
                "src": "https:\/\/js-aplenty.com\/bar.js",
                "display_location": [
                    "PRODUCT_LIST",
                    "PRODUCT_DETAIL"
                ],
                "skin_no": null,
                "created_date": "2017-11-03T18:05:32+09:00",
                "updated_date": "2017-11-03T18:05:32+09:00"
            }
        ]
    }
    

    基本スペック

    Property Description
    SCOPE アプリ 閲覧権限 (READ_APPLICATION)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    script_no

    scriptの固有番号

    スクリプトの固有番号の検索

    src

    URL

    原本script経路

    原本スクリプトの経路検索

    display_location

    画面経路

    スクリプトを表示する「画面経路」。画面経路は画面のページ経路ではなく、ショップの各ページに付与された特定の役割を意味する。
    (例: 商品カテゴリ(product_list)にスクリプトを挿入する場合、ショップで商品カテゴリとして使われるすべてのページにスクリプトが表示される)

    画面の役割はそのページに使われたモジュールによって自動付与される。任意のページに商品カテゴリモジュールを追加すると、そのページは「商品カテゴリ」の役割として認識される。ショップ管理者画面の「デザイン管理 > ショップ環境設定 > 画面経路 > 画面経路設定」で各ページに付与された画面の役割を検索・設定することができる。

    「all」の場合、すべてのページにスクリプトが適用される。

    画面経路コード表

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

    skin_no

    スキン番号

    スクリプトを適用するデザイン番号

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

    created_start_date

    Date
    timezone

    スクリプト設置日の検索開始日

    スクリプトを設置した日が該当日以後であるスクリプト検索
    検索終了日と必ずペアで使用すること。

    created_end_date

    Date
    timezone

    スクリプト設置日の検索終了日

    スクリプトを設置した日が該当日以後であるスクリプト検索
    検索終了日と必ずペアで使用すること。

    updated_start_date

    Date
    timezone

    スクリプト修正日の検索開始日

    スクリプトの修正日が該当日以後であるスクリプト検索
    検索終了日と必ずペアで使用すること。

    updated_end_date

    Date
    timezone

    スクリプト修正日の検索終了日

    スクリプトの修正日が該当日以前であるスクリプト検索
    検索開始日と必ずペアで使用すること。

    Count all scripttags

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    基本スペック

    Property Description
    SCOPE アプリ 閲覧権限 (READ_APPLICATION)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    script_no

    scriptの固有番号

    スクリプトの固有番号の検索

    src

    URL

    原本script経路

    原本スクリプトの経路検索

    display_location

    画面経路

    スクリプトを表示する「画面経路」。画面経路は画面のページ経路ではなく、ショップの各ページに付与された特定の役割を意味する。
    (例: 商品カテゴリ(product_list)にスクリプトを挿入する場合、ショップで商品カテゴリとして使われるすべてのページにスクリプトが表示される)

    画面の役割はそのページに使われたモジュールによって自動付与される。任意のページに商品カテゴリモジュールを追加すると、そのページは「商品カテゴリ」の役割として認識される。ショップ管理者画面の「デザイン管理 > ショップ環境設定 > 画面経路 > 画面経路設定」で各ページに付与された画面の役割を検索・設定することができる。

    「all」の場合、すべてのページにスクリプトが適用される。

    画面経路コード表

    skin_no

    スキン番号

    スクリプトを適用するデザイン番号

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

    created_start_date

    Date
    timezone

    スクリプト設置日の検索開始日

    スクリプトを設置した日が該当日以後であるスクリプト検索
    検索終了日と必ずペアで使用すること。

    created_end_date

    Date
    timezone

    スクリプト設置日の検索終了日

    スクリプトを設置した日が該当日以前であるスクリプト検索
    検索終了日と必ずペアで使用すること。

    updated_start_date

    Date
    timezone

    スクリプト修正日の検索開始日

    スクリプトの修正日が該当日以後であるスクリプト検索
    検索終了日と必ずペアで使用すること。

    updated_end_date

    Date
    timezone

    スクリプト修正日の検索終了日

    スクリプトの修正日が該当日以前であるスクリプト検索
    検索開始日と必ずペアで使用すること。

    Get a scripttag

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/1509699932016345' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "scripttag": {
            "shop_no": 1,
            "script_no": "1509699932016345",
            "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
            "src": "https:\/\/js-aplenty.com\/bar.js",
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ],
            "created_date": "2017-11-03T18:05:32+09:00",
            "updated_date": "2017-11-03T18:05:32+09:00"
        }
    }
    

    基本スペック

    Property Description
    SCOPE アプリ 閲覧権限 (READ_APPLICATION)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    script_no

    scriptの固有番号

    スクリプトの固有番号の検索

    Create a scripttag

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/scripttags'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/scripttags' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "src": "https:\/\/js-aplenty.com\/bar.js",
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ]
        }
    }'
    

    Response example:

    {
        "scripttag": {
            "shop_no": 1,
            "script_no": "1527128695613925",
            "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
            "src": "https:\\\/\\\/js-aplenty.com\\\/bar.js",
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ],
            "created_date": "2017-03-15T13:27:53+09:00",
            "updated_date": "2017-03-15T13:27:53+09:00"
        }
    }
    

    基本スペック

    Property Description
    SCOPE アプリ 投稿権限 (WRITE_APPLICATION)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    src
    Required

    URL

    原本script経路

    設置するスクリプトの原本経路(絶対経路)

    display_location
    Required

    画面経路

    スクリプトを表示する「画面経路」。画面経路は画面のページ経路ではなく、ショップの各ページに付与された特定の役割を意味する。
    (例: 商品カテゴリ(product_list)にスクリプトを挿入する場合、ショップで商品カテゴリとして使われるすべてのページにスクリプトが表示される)

    画面の役割はそのページに使われたモジュールによって自動付与される。任意のページに商品カテゴリモジュールを追加すると、そのページは「商品カテゴリ」の役割として認識される。ショップ管理者画面の「デザイン管理 > ショップ環境設定 > 画面経路 > 画面経路設定」で各ページに付与された画面の役割を検索・設定することができる。

    「all」の場合、すべてのページにスクリプトが適用される。

    画面経路コード表

    skin_no

    スキン番号

    スクリプトを適用するデザイン番号

    Update a scripttag

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/1509699932016345' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ]
        }
    }'
    

    Response example:

    {
        "scripttag": {
            "shop_no": 1,
            "script_no": "1509432821494844",
            "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
            "src": "https:\/\/js-aplenty.com\/bar.js",
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ],
            "created_date": "2017-10-31T15:53:41+09:00",
            "updated_date": "2017-11-06T10:33:57+09:00"
        }
    }
    

    基本スペック

    Property Description
    SCOPE アプリ 投稿権限 (WRITE_APPLICATION)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    script_no
    Required

    scriptの固有番号

    スクリプトの固有番号

    src

    URL

    原本script経路

    設置するスクリプトの原本経路(絶対経路)

    display_location

    画面経路

    スクリプトを表示する「画面経路」。画面経路は画面のページ経路ではなく、ショップの各ページに付与された特定の役割を意味する。
    (例: 商品カテゴリ(product_list)にスクリプトを挿入する場合、ショップで商品カテゴリとして使われるすべてのページにスクリプトが表示される)

    画面の役割はそのページに使われたモジュールによって自動付与される。任意のページに商