닫기

  • Store

  • Product

  • Order

  • Customer

  • Community

  • Design

  • Promotion

  • Application

  • Category

  • Collection

  • Supply

  • Shipping

  • Salesreport

  • Personal

  • Privacy

  • Mileage

  • Notification

    • API Index

    non-print

    Introduction

    Cafe24 API

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

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

    Request/Response Format

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

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

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

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

    Method

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

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

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

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

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

    Admin API Intro

    Admin API

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

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

    API Status Code

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

    How to use GET API

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

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

    1. 検索条件の追加

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

    5. Pagination

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

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

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

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


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

    6. 特定項目の検索

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

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

    7. サブリソースの検索

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

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

    API Limit

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

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

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

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

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

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

    X-Api-Call-Limit : 1/40

    Versioning

    Version 2021-03-01 (latest)

    以前のバージョンと互換されていない変更事項に対し、日付でバージョンを提供します。

    custom headers "X-Cafe24-Api-Version"を通してご希望のバージョンを指定することができ、バージョンを保存しない場合、最新バージョンで動作します。

    例示コード(要求)

    Authentication

    Get Authentication Code

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

    • {mallid} : ショップのIDを入力します。

    • {client_id} : 開発者センターで作成したアプリのclient_idを入力します。

    • {state} : 偽変造を防止するために入力する値にコード返還時に同じ値が返還されます。

    • {redirect_uri} : 開発者センターで作成したアプリのRedirect URLを入力します。

    • {scope} : アクセストークンでアクセスするリソースサーバーの権限を入力することができます。

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

    例示コード(要求) 
    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}

    Get Access Token

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

    • {mallid}: ショップのIDを入力します。

    • {client_id}: 開発者センターで作成したアプリのclient_idを入力します。

    • {client_secret}: 開発者センターで作成したアプリのclient_secretを入力します。

    • {code}: 発行されたコードを入力します。

    • {redirect_uri}: 開発者センターで作成したアプリのRedirect URLを入力します。

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

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

    例示コード(要求)
    例示コード(応答) 
    HTTP/1.1 200 OK
{
    "access_token": "0iqR5nM5EJIq..........",
    "expires_at": "2021-03-01T14:00:00.000",
    "refresh_token": "JeTJ7XpnFC0P..........",
    "refresh_token_expires_at": "2021-03-15T12:00:00.000",
    "client_id": "BrIfqEKoPxeE..........",
    "mall_id": "yourmall",
    "user_id": "test",
    "scopes": [
        "mall.read_order",
        "mall.read_product",
        "mall.read_store",
        "...etc...",
    ],
    "issued_at": "2021-03-01T12:00:00.000"
}

    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)をもらうことができます。

    • {mallid} : ショップのIDを入力します。

    • {domain}:ショップのドメインを入力します。

    • {client_id} : 開発者センターで作成したアプリのclient_idを入力します。

    • {client_secret}: 開発者センターで作成したアプリのclient_secretを入力します。

    • {refresh_token}:トークン発行時にもらったrefresh_tokenを入力します。

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

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

    例示コード(要求)
    例示コード(応答) 
    HTTP/1.1 200 OK
{
    "access_token": "21EZes0dGSfN..........",
    "expires_at": "2021-03-01T15:50:00.000",
    "refresh_token": "xLlhWztQHBik............",
    "refresh_token_expires_at": "2021-03-15T13:50:00.000",
    "client_id": "BrIfqEKoPxeE..........",
    "mall_id": "yourmall",
    "user_id": "test",
    "scopes": [
        "mall.read_order",
        "mall.read_product",
        "mall.read_store",
        "...etc...",
    ],
    "issued_at": "2021-03-01T13:50:00.000"
}

    Store

    Coupons setting

    Endpoints 
    GET /api/v2/admin/coupons/setting
PUT /api/v2/admin/coupons/setting

    Coupons setting properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号
    use_coupon

    クーポンの使用

    T:사용함
    F:사용안함
    available_issue_type

    クーポンの使用制限

    A：注文書＋商品別クーポン使用
    O：注文書クーポンのみ使用
    P：商品別クーポンのみ使用
    allow_using_coupons_with_points

    ポイントの併用

    T：使用する
    F：使用しない
    allow_using_coupons_with_discounts

    割引併用

    A：クーポン＋会員ランク割引を同時使用
    C：クーポンのみ使用
    G：会員ランク割引のみ使用
    allow_using_product_and_order_coupons

    商品/注文書クーポンの併用

    T：使用する
    F：使用しない
    recover_coupon_setting

    クーポン返還の設定
    max_coupon_count

    クーポン使用枚数の制限
    use_additional_coupon

    追加クーポン

    T：使用する
    F：使用しない
    additional_coupon_no

    追加クーポンID
    show_coupon_to_non_members

    非会員の表示設定

    T：表示する
    F：表示しない
    show_group_coupon_to_non_members

    会員ランク割引が指定されたクーポンを含む

    T:含む
    F:含まない
    show_issued_coupon

    ダウンロード済みクーポンの表示有無

    T：表示する
    F：表示しない
    sorting_type

    並び替えの基準

    A：クーポン開始日
    B：クーポン終了日
    C：クーポン発行日
    D：割引額/ポイント
    E：割引/付与率
    download_image_type

    クーポンダウンロードボタンの画像(基本画像)

    1:TYPE1
    2:TYPE2
    3:TYPE3
    4:TYPE4
    5:TYPE5
    background_image_type

    クーポン画像(基本画像)

    1:TYPE1
    2:TYPE2
    3:TYPE3
    4:TYPE4
    5:TYPE5

    Get coupons setting

    GET /api/v2/admin/coupons/setting

    GET

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    Request Copy
    Response Copy

    Update a coupons setting

    PUT /api/v2/admin/coupons/setting

    PUT

    基本スペック

    Property Description
    SCOPE ショップの投稿権限 (mall.write_store)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    use_coupon

    クーポンの使用

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

    available_issue_type

    クーポンの使用制限

    A：注文書＋商品別クーポン使用
    O：注文書クーポンのみ使用
    P：商品別クーポンのみ使用

    allow_using_coupons_with_points

    ポイントの併用

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

    allow_using_coupons_with_discounts

    割引併用

    A：クーポン＋会員ランク割引を同時使用
    C：クーポンのみ使用
    G：会員ランク割引のみ使用

    allow_using_product_and_order_coupons

    商品/注文書クーポンの併用

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

    recover_coupon_setting

    クーポン返還の設定

    restore_viewpoint
    クーポン返還のタイミング

    A：キャンセル/交換/返品の受付時、B：キャンセル/交換/返品の完了時

    cancel_before_pay
    入金前キャンセル

    T：自動で返還する、F：自動で返還しない、M：返還の可否を確認する

    cancel_after_pay
    入金後キャンセル

    T：自動で返還する、F：自動で返還しない、M：返還の可否を確認する

    return
    返品

    T：自動で返還する、F：自動で返還しない、M：返還の可否を確認する

    exchange
    交換

    T：自動で返還する、F：自動で返還しない、M：返還の可否を確認する

    part
    一部キャンセル/返品/交換

    F：返還しない、M：返還の可否を確認する
    max_coupon_count

    クーポン使用枚数の制限

    product_per_product
    商品1点当たりのクーポン使用枚数の制限(商品クーポン)

    order_per_order
    注文1回当たりのクーポン使用枚数の制限(注文書クーポン)

    product_and_order_per_order
    注文1件当たりのクーポン使用枚数の制限(注文書＋商品クーポン)

    product_per_order
    注文1回当たりのクーポン使用枚数の制限(商品クーポン)

    product_and_order_per_day
    一日当たりのクーポン使用枚数の制限(注文書+商品クーポン)
    use_additional_coupon

    追加クーポン

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

    additional_coupon_no

    Array Max : [5]

    追加クーポンID

    coupon_no
    クーポンID
    show_coupon_to_non_members

    非会員の表示設定

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

    show_group_coupon_to_non_members

    会員ランク割引が指定されたクーポンを含む

    T:含む
    F:含まない

    show_issued_coupon

    ダウンロード済みクーポンの表示有無

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

    sorting_type

    並び替えの基準

    A：クーポン開始日
    B：クーポン終了日
    C：クーポン発行日
    D：割引額/ポイント
    E：割引/付与率

    download_image_type

    クーポンダウンロードボタンの画像(基本画像)

    1:TYPE1
    2:TYPE2
    3:TYPE3
    4:TYPE4
    5:TYPE5

    background_image_type

    クーポン画像(基本画像)

    1:TYPE1
    2:TYPE2
    3:TYPE3
    4:TYPE4
    5:TYPE5

    Request Copy
    Response Copy

    Currency

    「Currency」ではショップの貨幣/為替レートの情報などを確認することができます。

    Endpoints 
    GET /api/v2/admin/currency

    Currency properties

    Attribute Description
    exchange_rate

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

    基準通貨コード

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

    基準通貨シンボル

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

    決済通貨コード
    shop_currency_symbol

    決済通貨シンボル

    Get currency setting

    GET /api/v2/admin/currency

    GET

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 40
    Request Copy
    Response Copy

    Dashboard

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

    Endpoints 
    GET /api/v2/admin/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

    GET /api/v2/admin/dashboard

    GET

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    Request Copy
    Response Copy
    Endpoints 
    GET /api/v2/admin/menus
    Attribute Description
    shop_no

    ショップ番号
    mode

    メニューモード

    pro：プロモード
    smart：スマートモード
    mobile_admin：モバイル管理画面
    menu_no

    メニュー番号
    name

    メニュー名
    path

    メニュー経路
    contains_app_url

    アプリURLを含むかどうか

    T：含む
    F：含まない

    List all menus

    GET /api/v2/admin/menus

    GET

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    mode

    メニューモード

    pro：プロモード
    smart：スマートモード
    mobile_admin：モバイル管理画面

    DEFAULT pro

    menu_no

    メニュー番号

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

    contains_app_url

    アプリURLを含むかどうか

    T：含む
    F：含まない

    Request Copy
    Response Copy

    Mobile setting

    「Mobile setting」は、ショップのモバイルショップ設定に関するリソースです。

    Endpoints 
    GET /api/v2/admin/mobile/setting

    Mobile setting properties

    Attribute Description
    shop_no

    ショップ番号
    use_mobile_page

    モバイルショッピングモール有効

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

    モバイル用URLへのリダイレクト

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

    Get mobile setting

    GET /api/v2/admin/mobile/setting

    GET

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    Request Copy
    Response Copy

    Paymentgateway

    Endpoints 
    POST /api/v2/admin/paymentgateway
PUT /api/v2/admin/paymentgateway/{client_id}
DELETE /api/v2/admin/paymentgateway/{client_id}

    Paymentgateway properties

    Attribute Description
    shop_no

    ショップ番号
    partner_id

    決済代行会社が発行した加盟店ID
    client_id

    アプリクライアントID
    additional_information

    追加情報
    membership_fee_type

    料金タイプ

    PRE : 前払い
    PAD : 後払い
    FREE : 無料

    Create a paymentgateway

    POST /api/v2/admin/paymentgateway

    POST

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE ショップの投稿権限 (mall.write_store)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    partner_id
    Required

    Max Length : [50]

    決済代行会社が発行した加盟店ID

    additional_information

    Array Max : [5]

    追加情報

    key
    追加項目のキー

    value
    追加項目の値
    membership_fee_type

    Max Length : [4]

    料金タイプ

    PRE : 前払い
    PAD : 後払い
    FREE : 無料

    Request Copy
    Response Copy

    Update a paymentgateway

    PUT /api/v2/admin/paymentgateway/{client_id}

    PUT

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE ショップの投稿権限 (mall.write_store)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    client_id
    Required

    Max Length : [50]

    アプリクライアントID

    partner_id

    Max Length : [50]

    決済代行会社が発行した加盟店ID

    additional_information

    Array Max : [5]

    追加情報

    key
    追加項目のキー

    value
    追加項目の値
    membership_fee_type

    Max Length : [4]

    料金タイプ

    PRE : 前払い
    PAD : 後払い
    FREE : 無料

    Request Copy
    Response Copy

    Delete a paymentgateway

    DELETE /api/v2/admin/paymentgateway/{client_id}

    DELETE

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE ショップの投稿権限 (mall.write_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    client_id
    Required

    Max Length : [50]

    アプリクライアントID

    Request Copy
    Response Copy

    Paymentgateway paymentmethods

    Endpoints 
    GET /api/v2/admin/paymentgateway/{client_id}/paymentmethods
POST /api/v2/admin/paymentgateway/{client_id}/paymentmethods
PUT /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}
DELETE /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}

    Paymentgateway paymentmethods properties

    Attribute Description
    client_id

    アプリクライアントID
    payment_method_code

    決済方法コード
    payment_method

    決済方法

    card：クレジットカード
    tcash：口座振込
    icash：バーチャル口座
    cell：キャリア決済
    cvs：コンビニ
    deferpay：後払い
    payment_method_name

    決済方法名
    payment_method_url

    決済方法画像パス

    List all paymentgateway paymentmethods

    GET /api/v2/admin/paymentgateway/{client_id}/paymentmethods

    GET

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    client_id
    Required

    Max Length : [50]

    アプリクライアントID

    Request Copy
    Response Copy

    Create a paymentgateway paymentmethod

    POST /api/v2/admin/paymentgateway/{client_id}/paymentmethods

    POST

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE ショップの投稿権限 (mall.write_store)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    client_id
    Required

    Max Length : [50]

    アプリクライアントID

    payment_method_code
    Required

    Max Length : [50]

    決済方法コード

    payment_method
    Required

    決済方法

    card：クレジットカード
    tcash：口座振込
    icash：バーチャル口座
    cell：キャリア決済
    cvs：コンビニ
    deferpay：後払い

    payment_method_name
    Required

    Max Length : [50]

    決済方法名

    payment_method_url
    Required

    Max Length : [200]

    決済方法画像パス

    Request Copy
    Response Copy

    Update a paymentgateway paymentmethod

    PUT /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}

    PUT

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE ショップの投稿権限 (mall.write_store)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    client_id
    Required

    Max Length : [50]

    アプリクライアントID

    payment_method_code
    Required

    Max Length : [50]

    決済方法コード

    payment_method

    決済方法

    card：クレジットカード
    tcash：口座振込
    icash：バーチャル口座
    cell：キャリア決済
    cvs：コンビニ
    deferpay：後払い

    payment_method_name

    Max Length : [50]

    決済方法名

    payment_method_url

    Max Length : [200]

    決済方法画像パス

    Request Copy
    Response Copy

    Delete a paymentgateway paymentmethod

    DELETE /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}

    DELETE

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE ショップの投稿権限 (mall.write_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    client_id
    Required

    Max Length : [50]

    アプリクライアントID

    payment_method_code
    Required

    Max Length : [50]

    決済方法コード

    Request Copy
    Response Copy

    Products setting

    Endpoints 
    GET /api/v2/admin/products/setting

    Products setting properties

    Attribute Description
    shop_no

    ショップ番号
    calculate_price_based_on

    販売価格の計算基準

    S：仕入れ価格に対する売上総利益率
    A：販売価格に対する売上総利益率
    P：基本ショップの販売価格
    B：商品価格
    price_rounding_unit

    販売価格計算の切り捨て単位

    F : 切り捨てしない
    -2 : 0.01の位
    -1 : 0.1の位
    0 : 1の位
    1 : 10の位
    2 : 100の位
    3 : 1000の位
    price_rounding_rule

    販売価格計算の切り捨て方法

    L : 切り捨て
    U : 四捨五入
    C : 切り上げ

    Get products setting

    GET /api/v2/admin/products/setting

    GET

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    Request Copy
    Response Copy

    Shops

    マルチショップ(Shops)は二つ以上のショップを運営している場合、生成したマルチショップの情報です。マルチショップは最大5個まで生成可能で、それぞれ異なる言語と通貨で生成できるため、多国語ショップの運営時に使えます。

    Endpoints 
    GET /api/v2/admin/shops
GET /api/v2/admin/shops/{shop_no}

    Shops properties

    Attribute Description
    shop_no

    ショップ番号

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

    基本ショップの有無

    基本ショップの区分

    T:基本ショップ
    F:基本ショップではない
    shop_name

    Max Length : [255]

    ショップ名
    business_country_code

    事業者の拠点国・地域の国名コード

    business_country_code

    language_code

    言語コード

    マルチショップの基本言語コード

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

    Max Length : [20]

    基本言語名

    マルチショップの基本言語名
    currency_code

    Type : [A-Z]

    決済通貨コード

    マルチショップの決済通貨コード

    South Korean Won (KRW)
    United States Dollar (USD)
    Japanese Yen (JPY)
    Chinese Yuan (CNY)
    Taiwan Dollar (TWD)
    Euro (EUR)
    Brazilian Real (BRL)
    Vietnamese Dong (VND)
    currency_name

    決済通貨名

    マルチショップの決済通貨名
    reference_currency_code

    Type : [A-Z]

    参照通貨コード

    マルチショップの参照通貨コード

    South Korean Won (KRW)
    United States Dollar (USD)
    Japanese Yen (JPY)
    Chinese Yuan (CNY)
    reference_currency_name

    参照通貨名

    マルチショップの参照通貨名
    pc_skin_no

    PCショップのメインデザイン番号

    マルチショップのPCショップの代表デザイン番号。 現在ショップで使っているデザイン番号を示す。
    mobile_skin_no

    モバイルショップのメインデザイン番号

    モバイルショップの代表デザイン番号。現在ショップで使っているデザイン番号を示す。
    base_domain

    Max Length : [63]

    デフォルトドメイン

    基本的に提供されるドメイン
    primary_domain

    Max Length : [63]

    メインドメイン

    マルチショップの代表ドメイン
    slave_domain

    接続ドメイン

    ショップにつながっているドメイン
    active

    有効/無効

    マルチショップを有効にするか無効にするかを設定

    T:有効
    F:無効
    timezone

    時間帯(タイムゾーン)
    timezone_name

    時間帯情報
    date_format

    日付の表示形式

    年/月/日 : YYYY-MM-DD
    月/日/年 : MM-DD-YYYY
    日/月/年 : DD-MM-YYYY
    time_format

    時刻の表示形式

    時/分/秒 : hh:mm:ss
    時/分 : hh:mm

    List all shops

    GET /api/v2/admin/shops

    GET

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 40
    Request Copy
    Response Copy

    Get a shop

    GET /api/v2/admin/shops/{shop_no}

    GET

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no
    Required

    ショップ番号

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

    DEFAULT 1

    Request Copy
    Response Copy

    Sms setting

    「Sms setting」はショップのSMS設定に関するリソースです。

    Endpoints 
    GET /api/v2/admin/sms/setting

    Sms setting properties

    Attribute Description
    shop_no

    ショップ番号
    use_sms

    SMS使用の有無

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

    受信拒否した人の送信除外設定

    T : 除く F : 含む
    default_sender

    デフォルト送信番号
    unsubscribe_phone

    受信拒否番号(無料)
    send_method

    SMS送信方法

    S: 短文分割送信
    L: 長文送信(3件分差し引き)

    Get SMS Setting

    GET /api/v2/admin/sms/setting

    GET

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    Request Copy
    Response Copy

    Store

    商店(Store)はショップの名前、管理者情報、事業者登録番号、お客様サポートの電話番号など、ショップの基本的な情報を確認することができます。

    Endpoints 
    GET /api/v2/admin/store

    Store properties

    Attribute Description
    shop_no

    ショップ番号

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

    ショップ名
    mall_id

    ショップID

    ショップID。代表運営者のIDであると同時に、ショップのデフォルトドメイン(mallid.cafe24.com)に使う。
    base_domain

    デフォルトドメイン

    ショップの生成時に自動生成されるデフォルトドメインの情報。そのドメインでショップにアクセスできる。
    primary_domain

    メインドメイン

    ショップにつながっている代表ドメイン。代表ドメインがつながっている場合のみ表示される。
    company_registration_no

    事業者登録番号

    事業所が位置する国で発行されるショップの事業者登録番号
    company_name

    商号

    事業者登録時に登録した商号または法人名
    president_name

    代表者名

    事業者登録時に登録した代表者名
    company_condition

    業態

    事業者登録時に登録した業態
    company_line

    種目

    事業者登録時に登録した業種
    country

    事業所の国家情報

    事業所のある国名
    zipcode

    郵便番号

    事業所の郵便番号
    address1

    基本住所

    事業所住所(市区町村)
    address2

    詳細住所

    事業所住所(詳細住所)
    phone

    電話番号
    fax

    ファックス番号
    email

    メールアドレス
    notification_only_email

    送信専用メールアドレス
    mall_url

    ショップのアドレス
    mail_order_sales_registration

    通信販売業申告

    通信販売業として登録されているかどうかの表示

    T:報告する
    F:報告しない
    mail_order_sales_registration_number

    通信販売申告番号
    missing_report_reason_type

    通信販売業未申告事由

    通信販売業登録をしていない場合、その事由
    missing_report_reason

    通信販売業未申告事由の詳細内容

    通信販売業の不登録事由が「その他」の場合、詳細内容
    about_us_contents

    会社紹介

    ショップに対する簡単な紹介。ショップの会社概要画面に表示される。
    company_map_url

    アクセスマップ

    ショップの簡単なマップ。ショップの会社概要画面に表示される。
    customer_service_phone

    お客様サポートの電話番号(相談/注文）

    ショップの画面に表示されるお客様サポートの相談電話番号
    customer_service_email

    お客様サポートのメールアドレス(相談/注文）

    ショップの画面に表示されるお客様サポートの相談メールアドレス
    customer_service_fax

    お客様サポートのファックス番号

    ショップの画面に表示されるお客様サポートのファックス番号
    customer_service_sms

    お客様サポートのSMS受信番号

    ショップの画面に表示されるお客様サポートのSMS受信番号
    customer_service_hours

    お客様サポートの運営時間

    ショップの画面に表示されるお客様サポートの運営時間
    privacy_officer_name

    個人情報保護責任者名

    ショップの画面に表示される個人情報保護責任者の名前
    privacy_officer_position

    個人情報保護責任者の地位
    privacy_officer_department

    個人情報保護責任者の部署
    privacy_officer_phone

    個人情報保護責任者の連絡先

    ショップの画面に表示される個人情報保護責任者の電話番号
    privacy_officer_email

    個人情報保護責任者のメールアドレス

    ショップの画面に表示される個人情報保護責任者のメールアドレス
    contact_us_mobile

    サービスに関するお問い合わせのモバイル表示設定

    サービスに関するお問合せの内容をMobileに表示するかどうかを設定

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

    サービスに関するお問い合わせの内容

    商品詳細ページに表示されるサービスに関するお問合わせの内容

    Get a store

    GET /api/v2/admin/store

    GET

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    Request Copy
    Response Copy

    Store accounts

    Endpoints 
    GET /api/v2/admin/store/accounts

    Store accounts properties

    Attribute Description
    shop_no

    ショップ番号
    bank_account_id

    振込銀行のID
    bank_name

    銀行名
    bank_code

    Max Length : [50]

    銀行コード

    bank_code

    bank_account_no

    口座番号
    bank_account_holder

    口座名義
    use_account

    使用設定

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

    List all store accounts

    GET /api/v2/admin/store/accounts

    GET

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    Request Copy
    Response Copy

    Subscription shipments setting

    Endpoints 
    GET /api/v2/admin/subscription/shipments/setting
POST /api/v2/admin/subscription/shipments/setting
PUT /api/v2/admin/subscription/shipments/setting/{subscription_no}
DELETE /api/v2/admin/subscription/shipments/setting/{subscription_no}

    Subscription shipments setting properties

    Attribute Description
    shop_no

    ショップ番号
    subscription_no

    定期購入対象商品設定番号
    subscription_shipments_name

    定期購入対象商品設定グループ名
    product_binding_type

    定期購入対象商品設定

    A : 全商品
    P : 特定の商品
    C : 商品カテゴリ
    product_list

    適用商品
    category_list

    適用カテゴリ
    use_discount

    定期購入割引使用の有無

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

    割引基準

    P : 割引率
    W : 割引金額
    discount_values

    割引値
    related_purchase_quantity

    購入数と関係するかどうか

    T : 購入数による
    F : 購入数関係なし
    subscription_shipments_cycle_type

    配送周期オプション提供の有無

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

    配送周期

    1W : 1週
    2W : 2週
    3W : 3週
    4W : 4週
    1M : 1ヶ月
    2M : 2ヶ月
    3M : 3ヶ月
    4M : 4ヶ月
    5M : 5ヶ月
    6M : 6ヶ月
    1Y : 1年
    use_order_price_condition

    割引詳細設定を割引金額に設定したかどうか

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

    金額割引の基準として設定した金額
    include_regional_shipping_rate

    地域別送料の設定状況

    T:含む
    F:含まない

    List all subscription shipments setting

    GET /api/v2/admin/subscription/shipments/setting

    GET

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    subscription_no

    定期購入対象商品設定番号

    Request Copy
    Response Copy

    Create a subscription shipments setting

    POST /api/v2/admin/subscription/shipments/setting

    POST

    基本スペック

    Property Description
    SCOPE ショップの投稿権限 (mall.write_store)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    subscription_shipments_name
    Required

    Max Length : [255]

    定期購入対象商品設定グループ名

    product_binding_type
    Required

    定期購入対象商品設定

    A : 全商品
    P : 特定の商品
    C : 商品カテゴリ

    product_list

    Array Max : [10000]

    適用商品

    category_list

    Array Max : [1000]

    適用カテゴリ

    use_discount
    Required

    定期購入割引使用の有無

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

    discount_value_unit

    割引基準

    P : 割引率
    W : 割引金額

    discount_values

    Array Max : [20]

    割引値

    related_purchase_quantity

    購入数と関係するかどうか

    T : 購入数による
    F : 購入数関係なし

    subscription_shipments_cycle_type
    Required

    配送周期オプション提供の有無

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

    subscription_shipments_cycle
    Required

    配送周期

    1W : 1週
    2W : 2週
    3W : 3週
    4W : 4週
    1M : 1ヶ月
    2M : 2ヶ月
    3M : 3ヶ月
    4M : 4ヶ月
    5M : 5ヶ月
    6M : 6ヶ月
    1Y : 1年

    use_order_price_condition
    Required

    割引詳細設定を割引金額に設定したかどうか

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

    order_price_greater_than

    Max : [99999999999999]

    金額割引の基準として設定した金額

    include_regional_shipping_rate

    地域別送料の設定状況

    T:含む
    F:含まない

    Request Copy
    Response Copy

    Update a subscription shipments setting

    PUT /api/v2/admin/subscription/shipments/setting/{subscription_no}

    PUT

    基本スペック

    Property Description
    SCOPE ショップの投稿権限 (mall.write_store)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    subscription_no
    Required

    定期購入対象商品設定番号

    subscription_shipments_name

    Max Length : [255]

    定期購入対象商品設定グループ名

    product_binding_type

    定期購入対象商品設定

    A : 全商品
    P : 特定の商品
    C : 商品カテゴリ

    product_list

    Array Max : [10000]

    適用商品

    category_list

    Array Max : [1000]

    適用カテゴリ

    use_discount

    定期購入割引使用の有無

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

    discount_value_unit

    割引基準

    P : 割引率
    W : 割引金額

    discount_values

    Array Max : [20]

    割引値

    related_purchase_quantity

    購入数と関係するかどうか

    T : 購入数による
    F : 購入数関係なし

    subscription_shipments_cycle_type

    配送周期オプション提供の有無

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

    subscription_shipments_cycle

    配送周期

    1W : 1週
    2W : 2週
    3W : 3週
    4W : 4週
    1M : 1ヶ月
    2M : 2ヶ月
    3M : 3ヶ月
    4M : 4ヶ月
    5M : 5ヶ月
    6M : 6ヶ月
    1Y : 1年

    use_order_price_condition

    割引詳細設定を割引金額に設定したかどうか

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

    order_price_greater_than

    Max : [99999999999999]

    金額割引の基準として設定した金額

    include_regional_shipping_rate

    地域別送料の設定状況

    T:含む
    F:含まない

    Request Copy
    Response Copy

    Delete a subscription shipments setting

    DELETE /api/v2/admin/subscription/shipments/setting/{subscription_no}

    DELETE

    基本スペック

    Property Description
    SCOPE ショップの投稿権限 (mall.write_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    subscription_no
    Required

    定期購入対象商品設定番号

    Request Copy
    Response Copy

    Users

    副運営者(Users)はショップの代表管理者と共にショップの運営ができる運営者です。副運営者は代表管理者が付与した権限を持ってショップを運営することができます。

    Endpoints 
    GET /api/v2/admin/users
GET /api/v2/admin/users/{user_id}

    Users properties

    Attribute Description
    user_id

    副運営者ID

    副運営者のID
    user_name

    副運営者名

    副運営者の名前
    phone

    Phone Number

    電話番号

    副運営者の電話番号
    email

    Email

    メールアドレス

    副運営者のメールアドレス
    ip_restriction_type

    IPアクセス制限

    IPアクセス制限使用の設定

    A:使用する
    F:使用しない
    admin_type

    運営者区分

    代表運営者か副運営者かの区分

    P:代表運営者
    A:副運営者
    last_login_date

    timezone

    直近のアクセス日時
    shop_no

    Min : [1]

    ショップ番号

    詳細照会を行う際にのみ確認できる。
    nick_name

    運営者ニックネーム

    運営者のニックネーム

    詳細照会を行う際にのみ確認できる。
    nick_name_icon_type

    ニックネームアイコンのタイプ

    ニックネームアイコンの登録。直接登録またはサンプル登録ができる。

    詳細照会を行う際にのみ確認できる。

    D:直接アイコン登録
    S:サンプルアイコン登録
    nick_name_icon_url

    ニックネームアイコンのURL

    詳細照会を行う際にのみ確認できる。
    board_exposure_setting

    掲示板の表示設定

    詳細照会を行う際にのみ確認できる。
    memo

    メモ

    詳細照会を行う際にのみ確認できる。
    available

    使用設定

    詳細照会を行う際にのみ確認できる。

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

    ショップのアクセス権限

    詳細照会を行う際にのみ確認できる。

    T:許容する
    F:許容しない
    menu_access_authority

    メニューのアクセス権限

    詳細照会を行う際にのみ確認できる。
    detail_authority_setting

    詳細の閲覧設定

    詳細照会を行う際にのみ確認できる。
    ip_access_restriction

    IPアクセス制限

    詳細照会を行う際にのみ確認できる。
    access_permission

    アクセス許可の権限

    詳細照会を行う際にのみ確認できる。

    T:アクセス許容時間の設定と関係なく
    いつでも管理画面へのアクセスを許容する
    F:使用しない

    List all users

    GET /api/v2/admin/users

    GET

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    search_type

    検索タイプ

    member_id:会員ID
    name:お名前

    keyword

    検索キーワード

    Request Copy
    Response Copy

    Get an user

    GET /api/v2/admin/users/{user_id}

    GET

    基本スペック

    Property Description
    SCOPE ショップの閲覧権限 (mall.read_store)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    user_id

    副運営者ID

    Request Copy
    Response Copy

    Product

    Bundleproducts

    Endpoints 
    GET /api/v2/admin/bundleproducts
GET /api/v2/admin/bundleproducts/{product_no}
POST /api/v2/admin/bundleproducts
PUT /api/v2/admin/bundleproducts/{product_no}
DELETE /api/v2/admin/bundleproducts/{product_no}

    Bundleproducts properties

    Attribute Description
    shop_no

    ショップ番号

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

    商品番号

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

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

    商品コード

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

    セット商品の構成商品情報
    custom_product_code

    Max Length : [40]

    独自商品コード

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

    Max Length : [250]

    商品名

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

    Max Length : [250]

    英語商品名

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

    Max Length : [250]

    供給会社の商品名

    供給会社が登録した商品の名前。供給会社が商品を区分するために任意で入力することができる。商品名には影響しない。
    internal_product_name

    Max Length : [50]

    管理用商品名
    model_name

    Max Length : [100]

    モデル名

    商品のモデル名
    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]

    商品検索キーワード

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

    Max Length : [20]

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

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

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

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

    購入制限

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

    N:会員のみ購入でき
    購入ボタンを表示しない
    M:会員のみ購入でき
    購入ボタンを表示する
    F:購入を制限しない
    buy_group_list

    購入できる会員ランク
    repurchase_restriction

    再購入制限

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

    単独購入制限

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

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

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

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

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

    ポイント設定情報
    except_member_points

    会員ランク別の追加ポイントを付与しない

    T：会員ランク追加付与除外を設定する
    F：会員ランク追加付与除外を設定しない
    adult_certification

    年齢認証

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

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

    詳細画像

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

    一覧画像

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

    縮小一覧画像

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

    縮小画像

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

    Naver Payの使用有無

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

    Naver Pay販売タイプ

    C : Naver Pay + ショップ 同時販売 商品
    O : Naver Pay 専用商品
    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

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

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

    ※ 在庫切れアイコン

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

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

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

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

    在庫切れ状況

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

    商品の割引価格リソース


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

    デコ画像リソース


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

    特典リソース


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

    Array Max : [20]

    追加の画像リソース


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

    商品表示制限の範囲

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

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

    セット割引情報

    詳細照会を行う際にのみ確認できる。
    category

    カテゴリ番号

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

    詳細照会を行う際にのみ確認できる。
    project_no

    キャンペーン番号

    詳細照会を行う際にのみ確認できる。
    description

    商品詳細説明

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

    詳細照会を行う際にのみ確認できる。
    mobile_description

    モバイル商品詳細説明

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

    詳細照会を行う際にのみ確認できる。
    separated_mobile_description

    モバイル用登録

    詳細照会を行う際にのみ確認できる。

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

    Array Max : [20]

    追加画像

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

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

    詳細照会を行う際にのみ確認できる。
    payment_info

    商品決済ガイド

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

    詳細照会を行う際にのみ確認できる。
    shipping_info

    商品配送ガイド

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

    詳細照会を行う際にのみ確認できる。
    exchange_info

    交換・返品ガイド

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

    詳細照会を行う際にのみ確認できる。
    service_info

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

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

    詳細照会を行う際にのみ確認できる。
    country_hscode

    国別HSコード

    海外配送時に関税を賦課するために使うHSコード。国際配送時に通関のために必ず正確な番号を入力しなければならない。

    国別にHSコードの標準が異なるため、各国に合ったコードを入力しなければならない。

    詳細照会を行う際にのみ確認できる。
    simple_description

    商品簡略説明

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

    詳細照会を行う際にのみ確認できる。
    shipping_fee_by_product

    個別配送の設定

    送料を商品別に払わせるか共通送料を払わせるかを設定

    個別送料を使わない場合は共通送料を使う。

    詳細照会を行う際にのみ確認できる。

    T:使用する
    F:使用しない
    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]

    海外通関コード

    詳細照会を行う際にのみ確認できる。
    additional_information

    追加項目

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

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

    詳細照会を行う際にのみ確認できる。
    image_upload_type

    画像アップロードタイプ

    画像をアップロードする時、画像のアップロードタイプ
    「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード
    「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード

    ※ EC Globalは、FTPをサポートしていないため、Cは使用できません

    詳細照会を行う際にのみ確認できる。

    A:メイン画像登録
    B:個別画像登録
    C:ウェブFTP登録
    main

    メイン表示

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

    詳細照会を行う際にのみ確認できる。
    relational_product

    Array Max : [200]

    関連商品

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

    詳細照会を行う際にのみ確認できる。
    memos

    メモリソース


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

    詳細照会を行う際にのみ確認できる。
    hits

    商品閲覧数リソース


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

    詳細照会を行う際にのみ確認できる。
    seo

    商品Seo リソース


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

    詳細照会を行う際にのみ確認できる。
    tags

    商品タグリソース


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

    詳細照会を行う際にのみ確認できる。

    List all bundleproducts

    GET /api/v2/admin/bundleproducts

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    discountprice
    embed

    商品の割引価格リソース


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

    decorationimages
    embed

    デコ画像リソース


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

    benefits
    embed

    特典リソース


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

    additionalimages
    embed

    追加の画像リソース


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

    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no

    商品番号

    検索したい商品の番号

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

    display

    表示ステータス

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

    selling

    販売ステータス

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

    product_code

    商品コード

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

    product_tag

    商品検索キーワード

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

    custom_product_code

    独自商品コード

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

    product_name

    商品名

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

    eng_product_name

    英語商品名

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

    supply_product_name

    供給会社の商品名

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

    internal_product_name

    管理用商品名

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

    model_name

    モデル名

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

    price_min

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

    price_max

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

    created_start_date

    timezone

    商品登録日の検索開始日

    created_end_date

    timezone

    商品登録日の検索終了日

    updated_start_date

    timezone

    商品修正日の検索開始日

    updated_end_date

    timezone

    商品修正日の検索終了日

    category

    カテゴリ番号

    category_unapplied

    未適用カテゴリを検索

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

    include_sub_category

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

    T:含む

    product_weight

    商品重量

    additional_information_key

    追加項目の検索条件キー

    additional_information_value

    追加項目の検索条件値

    sort

    並べ替え順序の値

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

    order

    並べ替え順序

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

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    Request Copy
    Response Copy

    Get a bundleproduct

    GET /api/v2/admin/bundleproducts/{product_no}

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

    検索したい商品の番号

    discountprice
    embed

    商品の割引価格リソース


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

    decorationimages
    embed

    デコ画像リソース


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

    benefits
    embed

    特典リソース


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

    memos
    embed

    メモリソース


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

    hits
    embed

    商品閲覧数リソース


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

    seo
    embed

    商品Seo リソース


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

    tags
    embed

    商品タグリソース


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

    additionalimages
    embed

    追加の画像リソース


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

    Request Copy
    Response Copy

    Create a bundleproduct

    POST /api/v2/admin/bundleproducts

    POST

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_name
    Required

    Max Length : [250]

    商品名

    bundle_product_components
    Required

    セット商品の構成商品情報

    product_no
    セット商品の構成商品番号
    Required

    purchase_quantity
    セット商品の購入数
    Required
    bundle_product_sales
    Required

    セット割引情報

    discount_value
    セット商品の割引価格
    Required

    discount_type
    セット商品の割引タイプ
    Required

    P : パーセント、 V : 定額

    discount_round_unit
    セット商品割引の切り捨て単位

    F : 切り捨てしない、 -2 : 0.01の位、 -1 : 0.1の位、 0 : 1の位、 1 : 10の位、 2 : 100の位、 3 : 1000の位

    discount_round_type
    セット商品の切り捨て方法

    F : 切り捨て、 R : 四捨五入、 C : 切り上げ
    display

    表示ステータス

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

    DEFAULT F

    add_category_no

    追加カテゴリ番号

    カテゴリ番号を使って表示したいカテゴリに商品登録

    category_no
    カテゴリ番号
    Required

    recommend
    おすすめ商品カテゴリ登録
    DEFAULT F
    T：おすすめ商品を登録する、F：おすすめ商品を登録しない

    new
    新着商品カテゴリ登録    
    DEFAULT F
    T：新着商品を登録する、F：新着商品を登録しない
    custom_product_code

    Max Length : [40]

    独自商品コード

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

    eng_product_name

    Max Length : [250]

    英語商品名

    supply_product_name

    Max Length : [250]

    供給会社の商品名

    internal_product_name

    Max Length : [50]

    管理用商品名

    model_name

    Max Length : [100]

    モデル名

    use_naverpay

    Naver Payの使用有無

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    naverpay_type

    Naver Pay販売タイプ

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    product_weight

    Min : [0]~Max : [999999.99]

    商品重量

    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モールの場合は必須で入力する必要がある。

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

    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]

    配送地域

    shipping_period

    Array Max : [2]

    配送期間

    minimum
    期間設定の最小値
    DEFAULT 1

    maximum
    期間設定の最大値
    DEFAULT 7
    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

    送料前払いの設定

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    DEFAULT B

    clearance_category_code

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

    海外通関コード

    配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力
    clearance_category_code

    detail_image

    詳細画像

    list_image

    一覧画像

    tiny_image

    縮小一覧画像

    small_image

    縮小画像

    image_upload_type

    画像アップロードタイプ

    画像をアップロードする時、画像のアップロードタイプ
    「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード
    「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード

    ※ EC Globalは、FTPをサポートしていないため、Cは使用できません

    A:メイン画像登録
    B:個別画像登録
    C:ウェブFTP登録

    DEFAULT A

    additional_information

    追加項目

    key
    追加項目のキー
    Required

    value
    追加項目の値
    price_content

    Max Length : [20]

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

    buy_limit_by_product

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

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

    DEFAULT F

    buy_limit_type

    購入制限

    N:会員のみ購入でき
    購入ボタンを表示しない
    M:会員のみ購入でき
    購入ボタンを表示する
    F:購入を制限しない

    DEFAULT F

    buy_group_list

    購入できる会員ランク

    repurchase_restriction

    再購入制限

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

    DEFAULT F

    single_purchase_restriction

    単独購入制限

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

    DEFAULT F

    points_by_product

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

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

    DEFAULT F

    points_setting_by_payment

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

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

    points_amount

    ポイント設定情報

    except_member_points

    会員ランク別の追加ポイントを付与しない

    T：会員ランク追加付与除外を設定する
    F：会員ランク追加付与除外を設定しない

    DEFAULT F

    main

    メイン表示

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

    relational_product

    Array Max : [200]

    関連商品

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

    product_no
    商品番号
    Required

    interrelated
    関連商品の相互登録    
    Required

    T：相互登録、F：単独登録    
    product_material

    商品素材

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

    english_product_material

    英語商品素材

    商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。

    cloth_fabric

    生地

    商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。

    woven:織物(woven)
    knit:編物(knit)

    additional_image

    追加画像

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

    追加画像は、最大20個まで登録可能できる。

    adult_certification

    年齢認証

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    DEFAULT F

    exposure_limit_type

    商品表示制限の範囲

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

    DEFAULT A

    exposure_group_list

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

    Request Copy
    Response Copy

    Update a bundleproduct

    PUT /api/v2/admin/bundleproducts/{product_no}

    PUT

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    product_name

    Max Length : [250]

    商品名

    bundle_product_components

    セット商品の構成商品情報

    product_no
    セット商品の構成商品番号
    Required

    purchase_quantity
    セット商品の購入数
    Required
    bundle_product_sales

    セット割引情報

    discount_value
    セット商品の割引価格
    Required

    discount_type
    セット商品の割引タイプ
    Required

    P : パーセント、 V : 定額

    discount_round_unit
    セット商品割引の切り捨て単位

    F : 切り捨てしない、 -2 : 0.01の位、 -1 : 0.1の位、 0 : 1の位、 1 : 10の位、 2 : 100の位、 3 : 1000の位

    discount_round_type
    セット商品の切り捨て方法

    F : 切り捨て、 R : 四捨五入、 C : 切り上げ
    display

    表示ステータス

    商品をショップに表示するかどうかを変更

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

    product_condition

    商品ステータス

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

    product_used_month

    Max : [2147483647]

    中古商品の使用月数

    商品状態（product_condition）が中古である場合、該当商品の使用月数

    add_category_no

    追加カテゴリ番号

    商品カテゴリ番号を入力してその商品に特定の商品カテゴリを追加登録

    category_no
    カテゴリ番号
    Required

    recommend
    おすすめ商品カテゴリ登録
    DEFAULT F
    T：おすすめ商品を登録する、F：おすすめ商品を登録しない

    new
    新着商品カテゴリ登録    
    DEFAULT F
    T：新着商品を登録する、F：新着商品を登録しない
    delete_category_no

    削除されたカテゴリ番号

    商品カテゴリ番号を入力してその商品から特定の商品カテゴリを削除

    custom_product_code

    Max Length : [40]

    独自商品コード

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

    eng_product_name

    Max Length : [250]

    英語商品名

    supply_product_name

    Max Length : [250]

    供給会社の商品名

    internal_product_name

    Max Length : [50]

    管理用商品名

    model_name

    Max Length : [100]

    モデル名

    use_naverpay

    Naver Payの使用有無

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    naverpay_type

    Naver Pay販売タイプ

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    product_weight

    Min : [0]~Max : [999999.99]

    商品重量

    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]

    アイコン

    use_icon_exposure_term

    表示期間の使用の有無

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

    icon_exposure_begin_datetime

    表示期間の開始日

    icon_exposure_end_datetime

    表示期間の終了日

    hscode

    Max Length : [20]

    HSコード

    配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力

    shipping_scope

    配送情報

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    prepaid_shipping_fee

    送料前払いの設定

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

    C:着払い
    P:前払い
    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]

    配送期間

    minimum
    期間設定の最小値
    DEFAULT 1

    maximum
    期間設定の最大値
    DEFAULT 7
    shipping_fee_type

    送料タイプ

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

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

    shipping_rates

    送料金額

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

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

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

    clearance_category_code

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

    海外通関コード

    配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力
    clearance_category_code

    detail_image

    詳細画像

    list_image

    一覧画像

    tiny_image

    縮小一覧画像

    small_image

    縮小画像

    image_upload_type

    画像アップロードタイプ

    画像をアップロードする時、画像のアップロードタイプ
    「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード
    「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード

    ※ EC Globalは、FTPをサポートしていないため、Cは使用できません

    A:メイン画像登録
    B:個別画像登録
    C:ウェブFTP登録

    additional_information

    追加項目

    key
    追加項目のキー
    Required

    value
    追加項目の値
    price_content

    Max Length : [20]

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

    buy_limit_by_product

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

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

    buy_limit_type

    購入制限

    N:会員のみ購入でき
    購入ボタンを表示しない
    M:会員のみ購入でき
    購入ボタンを表示する
    F:購入を制限しない

    buy_group_list

    購入できる会員ランク

    repurchase_restriction

    再購入制限

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

    single_purchase_restriction

    単独購入制限

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

    points_by_product

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

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

    points_setting_by_payment

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

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

    points_amount

    ポイント設定情報

    except_member_points

    会員ランク別の追加ポイントを付与しない

    T：会員ランク追加付与除外を設定する
    F：会員ランク追加付与除外を設定しない

    main

    メイン表示

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

    relational_product

    Array Max : [200]

    関連商品

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

    product_no
    商品番号

    interrelated
    関連商品の相互登録    
    Required

    T：相互登録、F：単独登録    
    product_material

    商品素材

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

    english_product_material

    英語商品素材

    商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。

    cloth_fabric

    生地

    商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。

    woven:織物(woven)
    knit:編物(knit)

    additional_image

    追加画像

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

    追加画像は、最大20個まで登録可能できる。

    adult_certification

    年齢認証

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    exposure_limit_type

    商品表示制限の範囲

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

    exposure_group_list

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

    Request Copy
    Response Copy

    Delete a bundleproduct

    DELETE /api/v2/admin/bundleproducts/{product_no}

    DELETE

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Request Copy
    Response Copy

    Categories products

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

    Endpoints 
    GET /api/v2/admin/categories/{category_no}/products
GET /api/v2/admin/categories/{category_no}/products/count
POST /api/v2/admin/categories/{category_no}/products
PUT /api/v2/admin/categories/{category_no}/products
DELETE /api/v2/admin/categories/{category_no}/products/{product_no}

    Categories products properties

    Attribute Description
    shop_no

    ショップ番号
    product_no

    商品番号

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

    表示順序
    auto_sort

    「自動並べ替え」設定の有無
    sold_out

    在庫切れ状況
    fixed_sort

    「固定」設定の有無
    not_for_sale

    「販売しない」設定の有無
    display_group

    Min : [1]~Max : [3]

    商品カテゴリの詳細

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

    DEFAULT 1
    sequence

    Min : [1]~Max : [999998]

    表示順序

    List all categories products

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

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    display_group
    Required

    Min : [1]~Max : [3]

    商品カテゴリの詳細

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

    limit

    Min : [1]~Max : [50000]

    検索結果の最大件数

    DEFAULT 50000

    Request Copy
    Response Copy

    Count all categories products

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

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    display_group
    Required

    Min : [1]~Max : [3]

    商品カテゴリの詳細

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

    Request Copy
    Response Copy

    Create a categories product

    POST /api/v2/admin/categories/{category_no}/products

    POST

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    category_no
    Required

    カテゴリ番号

    display_group

    Min : [1]~Max : [3]

    商品カテゴリの詳細

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

    DEFAULT 1

    product_no
    Required

    商品番号

    Request Copy
    Response Copy

    Update a categories product

    PUT /api/v2/admin/categories/{category_no}/products

    PUT

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    display_group
    Required

    Min : [1]~Max : [3]

    商品カテゴリの詳細

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

    product_no
    Required

    商品番号

    sequence

    Min : [1]~Max : [999999]

    表示順序

    auto_sort

    「自動並べ替え」設定の有無

    T：自動並べ替えを使用する
    F：自動並べ替えを使用しない

    fixed_sort

    「固定」設定の有無

    T：表示順位固定を使用する
    F：表示順位固定を使用しない

    Request Copy
    Response Copy

    Delete a categories product

    DELETE /api/v2/admin/categories/{category_no}/products/{product_no}

    DELETE

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    category_no
    Required

    カテゴリ番号

    product_no
    Required

    商品番号

    display_group

    Min : [1]~Max : [3]

    商品カテゴリの詳細

    一般商品エリアで「表示しない」に処理する場合、おすすめ商品/新着商品エリアでも同時に非表示処理されます。

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

    DEFAULT 1

    Request Copy
    Response Copy

    Mains products

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

    Endpoints 
    GET /api/v2/admin/mains/{display_group}/products
GET /api/v2/admin/mains/{display_group}/products/count
POST /api/v2/admin/mains/{display_group}/products
PUT /api/v2/admin/mains/{display_group}/products
DELETE /api/v2/admin/mains/{display_group}/products/{product_no}

    Mains products properties

    Attribute Description
    shop_no

    ショップ番号

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

    商品番号
    product_name

    商品名
    fixed_sort

    「固定」設定の有無

    List all mains products

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

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_group
    Required

    メインカテゴリ番号

    Request Copy
    Response Copy

    Count all mains products

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

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_group
    Required

    メインカテゴリ番号

    Request Copy
    Response Copy

    Create a mains product

    POST /api/v2/admin/mains/{display_group}/products

    POST

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_group
    Required

    メインカテゴリ番号

    product_no
    Required

    商品番号

    Request Copy
    Response Copy

    Update a mains product

    PUT /api/v2/admin/mains/{display_group}/products

    PUT

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_group
    Required

    メインカテゴリ番号

    product_no
    Required

    商品番号

    要求した商品番号の順序で表示順位が指定される。

    fix_product_no

    表示順位固定商品の番号

    表示順位を固定したい商品番号を指定

    Request Copy
    Response Copy

    Delete a mains product

    DELETE /api/v2/admin/mains/{display_group}/products/{product_no}

    DELETE

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_group
    Required

    メインカテゴリ番号

    product_no
    Required

    商品番号

    Request Copy
    Response Copy

    Products

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

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

    Endpoints 
    GET /api/v2/admin/products
GET /api/v2/admin/products/count
GET /api/v2/admin/products/{product_no}
POST /api/v2/admin/products
PUT /api/v2/admin/products/{product_no}
DELETE /api/v2/admin/products/{product_no}

    Products properties

    Attribute Description
    shop_no

    ショップ番号

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

    商品番号

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

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

    商品コード

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

    Max Length : [40]

    独自商品コード

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

    Max Length : [250]

    商品名

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

    Max Length : [250]

    英語商品名

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

    Max Length : [250]

    供給会社の商品名

    供給会社が登録した商品の名前。供給会社が商品を区分するために任意で入力することができる。商品名には影響しない。
    internal_product_name

    Max Length : [50]

    管理用商品名
    model_name

    Max Length : [100]

    モデル名

    商品のモデル名
    price_excluding_tax

    商品価格(税別)
    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_by_product

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

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

    購入制限

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

    N:会員のみ購入でき
    購入ボタンを表示しない
    M:会員のみ購入でき
    購入ボタンを表示する
    F:購入を制限しない
    buy_group_list

    購入できる会員ランク
    repurchase_restriction

    再購入制限

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

    単独購入制限

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

    購入単位のタイプ

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

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

    購入単位

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

    注文数量の制限基準

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

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

    Max : [2147483647]

    最小注文数量

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

    Max : [2147483647]

    最大注文数量

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

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

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

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

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

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

    ポイント設定情報
    except_member_points

    会員ランク別の追加ポイントを付与しない

    T：会員ランク追加付与除外を設定する
    F：会員ランク追加付与除外を設定しない
    product_volume

    商品容積情報
    adult_certification

    年齢認証

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

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

    詳細画像

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

    一覧画像

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

    縮小一覧画像

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

    縮小画像

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

    オプション使用の設定

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

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

    オプション構成方式

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

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

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

    Naver Payの使用有無

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

    Naver Pay販売タイプ

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

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

    メーカーコード

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

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

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

    トレンドコード

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

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

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

    ブランドコード

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

    入力しない場合は独自ブランド(B0000000)使用
    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)」の場合、原産国として入力可能な情報
    made_in_code

    国名(原産国)コード
    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

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

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

    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

    商品の割引価格リソース


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

    デコ画像リソース


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

    特典リソース


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

    商品オプションリソース


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

    品目リソース


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

    海外通関用商品区分(英語名)

    海外通関時に通関用商品区分情報として使う情報。日本語名の入力時に入力した区分名が自動翻訳された項目

    翻訳された英語名が海外送状の商品名に含まれて送られる。
    clearance_category_kor

    海外通関用商品区分(日本語名)

    海外通関時に通関用商品区分情報として使う情報。英語に自動翻訳されて海外送状の商品名情報に含まれて送られる。
    clearance_category_code

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

    海外通関コード

    clearance_category_code

    additionalimages

    追加の画像リソース


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

    商品表示制限の範囲

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

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

    セット商品のタイプ

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

    メモリソース


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

    詳細照会を行う際にのみ確認できる。
    hits

    商品閲覧数リソース


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

    詳細照会を行う際にのみ確認できる。
    seo

    商品Seo リソース


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

    詳細照会を行う際にのみ確認できる。
    category

    カテゴリ番号

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

    詳細照会を行う際にのみ確認できる。
    project_no

    キャンペーン番号

    詳細照会を行う際にのみ確認できる。
    description

    商品詳細説明

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

    詳細照会を行う際にのみ確認できる。
    mobile_description

    モバイル商品詳細説明

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

    詳細照会を行う際にのみ確認できる。
    separated_mobile_description

    モバイル用登録

    詳細照会を行う際にのみ確認できる。

    T : 直接登録
    F : 商品説明と同一
    translated_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

    消費税表示メッセージ

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

    詳細照会を行う際にのみ確認できる。
    country_hscode

    国別HSコード

    海外配送時に関税を賦課するために使うHSコード。国際配送時に通関のために必ず正確な番号を入力しなければならない。

    国別にHSコードの標準が異なるため、各国に合ったコードを入力しなければならない。

    詳細照会を行う際にのみ確認できる。
    simple_description

    商品簡略説明

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

    詳細照会を行う際にのみ確認できる。
    tags

    商品タグリソース


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

    詳細照会を行う際にのみ確認できる。
    shipping_fee_by_product

    個別配送の設定

    送料を商品別に払わせるか共通送料を払わせるかを設定

    個別送料を使わない場合は共通送料を使う。

    詳細照会を行う際にのみ確認できる。

    T:使用する
    F:使用しない
    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:送料

    詳細照会を行う際にのみ確認できる。
    origin_place_code

    原産国コード

    商品の原産国コード

    詳細照会を行う際にのみ確認できる。
    additional_information

    追加項目

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

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

    詳細照会を行う際にのみ確認できる。
    image_upload_type

    画像アップロードタイプ

    画像をアップロードする時、画像のアップロードタイプ
    「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード
    「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード

    ※ EC Globalは、FTPをサポートしていないため、Cは使用できません

    詳細照会を行う際にのみ確認できる。

    A:メイン画像登録
    B:個別画像登録
    C:ウェブFTP登録
    main

    メイン表示

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

    詳細照会を行う際にのみ確認できる。
    relational_product

    Array Max : [200]

    関連商品

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

    詳細照会を行う際にのみ確認できる。
    translated_additional_description

    商品追加説明の翻訳情報

    詳細照会を行う際にのみ確認できる。

    List all products

    GET /api/v2/admin/products

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    discountprice
    embed

    商品の割引価格リソース


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

    decorationimages
    embed

    デコ画像リソース


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

    benefits
    embed

    特典リソース


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

    options
    embed

    商品オプションリソース


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

    variants
    embed

    品目リソース

    商品1点あたりの品目情報を100件まで照会可能
    独自商品コード(custom_product_code)または独自品目コード(custom_variant_code)のうち1件は必須入力
    Embedパラメーターを使って照会することができる。

    additionalimages
    embed

    追加の画像リソース


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

    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no

    商品番号

    検索したい商品の番号

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

    display

    表示ステータス

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

    selling

    販売ステータス

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

    product_name

    商品名

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

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

    product_code

    商品コード

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

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

    brand_code

    ブランドコード

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

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

    manufacturer_code

    メーカーコード

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

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

    supplier_code

    供給会社のコード

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

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

    trend_code

    トレンドコード

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

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

    product_tag

    商品検索キーワード

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

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

    custom_product_code

    独自商品コード

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

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

    custom_variant_code

    独自品目コード

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

    price_min

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

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

    price_max

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

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

    retail_price_min

    Min : [0]
    Max : [2147483647]

    商品の定価の検索最小値

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

    retail_price_max

    Min : [0]
    Max : [2147483647]

    商品の定価の検索最大値

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

    supply_price_min

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

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

    supply_price_max

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

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

    created_start_date

    timezone

    商品登録日の検索開始日

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

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

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

    created_end_date

    timezone

    商品登録日の検索終了日

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

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

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

    updated_start_date

    timezone

    商品修正日の検索開始日

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

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

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

    updated_end_date

    timezone

    商品修正日の検索終了日

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

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

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

    category

    カテゴリ番号

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

    eng_product_name

    英語商品名

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

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

    supply_product_name

    供給会社の商品名

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

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

    internal_product_name

    管理用商品名

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

    model_name

    モデル名

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

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

    product_condition

    商品ステータス

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

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

    origin_place_value

    原産国情報

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

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

    stock_quantity_max

    在庫数量の検索最大値

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

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

    stock_quantity_min

    在庫数量の検索最小値

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

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

    stock_safety_max

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

    stock_safety_min

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

    product_weight

    商品重量

    該当する重量の商品検索

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

    classification_code

    独自カテゴリ

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

    use_inventory

    在庫使用の設定

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

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

    category_unapplied

    未適用カテゴリを検索

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

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

    include_sub_category

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

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

    T:含む

    additional_information_key

    追加項目の検索条件キー

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

    additional_information_value

    追加項目の検索条件値

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

    approve_status

    承認ステータスの検索

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

    since_product_no

    Min : [0]
    Max : [2147483647]

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

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

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

    product_no
    sort
    order
    offset

    product_bundle

    セット商品の有無

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

    sort

    並べ替え順序の値

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

    order

    並べ替え順序

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

    offset

    Max : [5000]

    検索結果の開始位置

    検索結果の開始位置

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    Request Copy
    Response Copy

    Count all products

    GET /api/v2/admin/products/count

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no

    商品番号

    検索したい商品の番号

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

    display

    表示ステータス

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

    selling

    販売ステータス

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

    product_name

    商品名

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

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

    product_code

    商品コード

    商品コード

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

    brand_code

    ブランドコード

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

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

    manufacturer_code

    メーカーコード

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

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

    supplier_code

    供給会社のコード

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

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

    trend_code

    トレンドコード

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

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

    product_tag

    商品検索キーワード

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

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

    custom_product_code

    独自商品コード

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

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

    custom_variant_code

    独自品目コード

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

    price_min

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

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

    price_max

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

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

    retail_price_min

    Min : [0]
    Max : [2147483647]

    商品の定価の検索最小値

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

    retail_price_max

    Min : [0]
    Max : [2147483647]

    商品の定価の検索最大値

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

    supply_price_min

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

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

    supply_price_max

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

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

    created_start_date

    timezone

    商品登録日の検索開始日

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

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

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

    created_end_date

    timezone

    商品登録日の検索終了日

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

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

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

    updated_start_date

    timezone

    商品修正日の検索開始日

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

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

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

    updated_end_date

    timezone

    商品修正日の検索終了日

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

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

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

    category

    カテゴリ番号

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

    eng_product_name

    英語商品名

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

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

    supply_product_name

    供給会社の商品名

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

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

    internal_product_name

    管理用商品名

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

    model_name

    モデル名

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

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

    product_condition

    商品ステータス

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

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

    origin_place_value

    原産国情報

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

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

    stock_quantity_max

    在庫数量の検索最大値

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

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

    stock_quantity_min

    在庫数量の検索最小値

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

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

    stock_safety_max

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

    stock_safety_min

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

    product_weight

    商品重量

    該当する重量の商品検索

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

    classification_code

    独自カテゴリ

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

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

    use_inventory

    在庫使用の設定

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

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

    category_unapplied

    未適用カテゴリを検索

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

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

    include_sub_category

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

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

    T:含む

    additional_information_key

    追加項目の検索条件キー

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

    additional_information_value

    追加項目の検索条件値

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

    approve_status

    承認ステータスの検索

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

    since_product_no

    Min : [0]
    Max : [2147483647]

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

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

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

    product_no
    sort
    order
    offset

    product_bundle

    セット商品の有無

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

    Request Copy
    Response Copy

    Get a product

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

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

    検索したい商品の番号

    variants
    embed

    品目リソース


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

    memos
    embed

    メモリソース


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

    hits
    embed

    商品閲覧数リソース


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

    seo
    embed

    商品Seo リソース


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

    tags
    embed

    商品タグリソース


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

    options
    embed

    商品オプションリソース


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

    discountprice
    embed

    商品の割引価格リソース


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

    decorationimages
    embed

    デコ画像リソース


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

    benefits
    embed

    特典リソース


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

    additionalimages
    embed

    追加の画像リソース


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

    Request Copy
    Response Copy

    Create a product

    POST /api/v2/admin/products

    POST

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    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

    追加カテゴリ番号

    カテゴリ番号を使って表示したいカテゴリに商品登録

    category_no
    カテゴリ番号
    Required

    recommend
    おすすめ商品カテゴリ登録
    DEFAULT F
    T：おすすめ商品を登録する、F：おすすめ商品を登録しない

    new
    新着商品カテゴリ登録    
    DEFAULT F
    T：新着商品を登録する、F：新着商品を登録しない
    custom_product_code

    Max Length : [40]

    独自商品コード

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

    product_name
    Required

    Max Length : [250]

    商品名

    eng_product_name

    Max Length : [250]

    英語商品名

    supply_product_name

    Max Length : [250]

    供給会社の商品名

    internal_product_name

    Max Length : [50]

    管理用商品名

    model_name

    Max Length : [100]

    モデル名

    price_excluding_tax

    Min : [0]~Max : [2147483647]

    商品価格(税別)

    price

    Min : [0]~Max : [2147483647]

    商品販売価格

    retail_price

    Min : [0]~Max : [2147483647]

    商品の定価

    supply_price
    Required

    Min : [0]~Max : [2147483647]

    商品仕入れ価格

    商品の原価。原価に売上総利益率を加えて販売価格を計算することができる。APIで原価は参照の目的でしか使われない。

    has_option

    オプション使用の設定

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

    DEFAULT F

    options

    オプション

    name
    オプション名
    Required

    value
    オプション値
    Required
    use_naverpay

    Naver Payの使用有無

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    naverpay_type

    Naver Pay販売タイプ

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    manufacturer_code

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

    メーカーコード

    DEFAULT M0000000

    trend_code

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

    トレンドコード

    DEFAULT T0000000

    brand_code

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

    ブランドコード

    DEFAULT B0000000

    supplier_code

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

    供給会社のコード

    DEFAULT S0000000

    product_weight

    Min : [0]~Max : [999999.99]

    商品重量

    made_date

    製造日

    release_date

    発売開始日

    expiration_date

    Array Max : [2]

    有効期間

    start_date
    有効期間の開始日

    end_date
    有効期間の終了日
    description

    商品詳細説明

    mobile_description

    モバイル商品詳細説明

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

    summary_description

    Max Length : [255]

    商品要約説明

    simple_description

    商品簡略説明

    translated_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モールの場合は必須で入力する必要がある。

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    shipping_method

    配送方法

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

    shipping_fee_by_product

    個別配送の設定

    T:個別配送
    F:基本配送

    DEFAULT F

    shipping_area

    Max Length : [255]

    配送地域

    shipping_period

    Array Max : [2]

    配送期間

    minimum
    期間設定の最小値
    DEFAULT 1

    maximum
    期間設定の最大値
    DEFAULT 7
    shipping_fee_type

    送料タイプ

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

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

    shipping_rates

    Array Max : [200]

    送料金額

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

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

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

    shipping_rates_min
    送料を適用する範囲の開始値

    shipping_rates_max
    送料を適用する範囲の終了値

    shipping_fee
    送料
    prepaid_shipping_fee

    送料前払いの設定

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    clearance_category_code

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

    海外通関コード

    配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力
    clearance_category_code

    detail_image

    詳細画像

    list_image

    一覧画像

    tiny_image

    縮小一覧画像

    small_image

    縮小画像

    image_upload_type

    画像アップロードタイプ

    画像をアップロードする時、画像のアップロードタイプ
    「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード
    「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード

    ※ EC Globalは、FTPをサポートしていないため、Cは使用できません

    A:メイン画像登録
    B:個別画像登録
    C:ウェブFTP登録

    DEFAULT A

    additional_information

    追加項目

    key
    追加項目のキー
    Required

    value
    追加項目の値
    price_content

    Max Length : [20]

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

    buy_limit_by_product

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

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

    DEFAULT F

    buy_limit_type

    購入制限

    N:会員のみ購入でき
    購入ボタンを表示しない
    M:会員のみ購入でき
    購入ボタンを表示する
    F:購入を制限しない

    DEFAULT F

    buy_group_list

    購入できる会員ランク

    repurchase_restriction

    再購入制限

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

    DEFAULT F

    single_purchase_restriction

    単独購入制限

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

    DEFAULT F

    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」と入力します。

    points_by_product

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

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

    DEFAULT F

    points_setting_by_payment

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

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

    points_amount

    ポイント設定情報

    payment_method
    ポイント決済方法

    naverpay : Naver Pay、smilepay：SmilePay、kakaopay：Kakaopay、payco : PAYCO、paynow：Paynow、kpay：KPAY、icash：バーチャル口座、deposit：預り金、tcash：リアルタイム口座振替、cell：キャリア決済、 card：クレジットカード、mileage：ポイント、cash：銀行振込

    points_rate
    付与率

    points_unit_by_payment
    決済方法別のポイント付与単位

    P：百分率基準、W：ウォン基準
    except_member_points

    会員ランク別の追加ポイントを付与しない

    T：会員ランク追加付与除外を設定する
    F：会員ランク追加付与除外を設定しない

    DEFAULT F

    product_volume

    商品容積情報

    use_product_volume
    商品体積の使用有無

    product_width
    幅(W)

    product_height
    奥行(D)

    product_length
    高さ(H)
    origin_classification

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

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

    origin_place_no

    原産国番号

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

    origin_place_value

    Max Length : [30]

    原産国のその他の情報

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

    made_in_code

    国名(原産国)コード

    main

    メイン表示

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

    relational_product

    Array Max : [200]

    関連商品

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

    product_no
    商品番号
    Required

    interrelated
    関連商品の相互登録    
    Required

    T：相互登録、F：単独登録    
    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個まで登録可能できる。

    adult_certification

    年齢認証

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    DEFAULT F

    exposure_limit_type

    商品表示制限の範囲

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

    DEFAULT A

    exposure_group_list

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

    Request Copy
    Response Copy

    Update a product

    PUT /api/v2/admin/products/{product_no}

    PUT

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    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

    追加カテゴリ番号

    商品カテゴリ番号を入力してその商品に特定の商品カテゴリを追加登録

    category_no
    カテゴリ番号
    Required

    recommend
    おすすめ商品カテゴリ登録
    DEFAULT F
    T：おすすめ商品を登録する、F：おすすめ商品を登録しない

    new
    新着商品カテゴリ登録    
    DEFAULT F
    T：新着商品を登録する、F：新着商品を登録しない
    delete_category_no

    削除されたカテゴリ番号

    商品カテゴリ番号を入力してその商品から特定の商品カテゴリを削除

    custom_product_code

    Max Length : [40]

    独自商品コード

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

    product_name

    Max Length : [250]

    商品名

    eng_product_name

    Max Length : [250]

    英語商品名

    supply_product_name

    Max Length : [250]

    供給会社の商品名

    internal_product_name

    Max Length : [50]

    管理用商品名

    model_name

    Max Length : [100]

    モデル名

    price_excluding_tax

    Min : [0]~Max : [2147483647]

    商品価格(税別)

    price

    Min : [0]~Max : [2147483647]

    商品販売価格

    retail_price

    Min : [0]~Max : [2147483647]

    商品の定価

    supply_price

    Min : [0]~Max : [2147483647]

    商品仕入れ価格

    商品の原価。原価に売上総利益率を加えて販売価格を計算することができる。APIで原価は参照の目的でしか使われない。

    has_option

    オプション使用の設定

    F:オプション使用しない

    use_naverpay

    Naver Payの使用有無

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    naverpay_type

    Naver Pay販売タイプ

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    manufacturer_code

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

    メーカーコード

    trend_code

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

    トレンドコード

    brand_code

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

    ブランドコード

    supplier_code

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

    供給会社のコード

    product_weight

    Min : [0]~Max : [999999.99]

    商品重量

    made_date

    製造日

    release_date

    発売開始日

    expiration_date

    Array Max : [2]

    有効期間

    start_date
    有効期間の開始日

    end_date
    有効期間の終了日
    description

    商品詳細説明

    mobile_description

    モバイル商品詳細説明

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

    translated_description

    商品詳細説明の翻訳情報

    translated_additional_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]

    アイコン

    use_icon_exposure_term

    表示期間の使用の有無

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

    icon_exposure_begin_datetime

    表示期間の開始日

    icon_exposure_end_datetime

    表示期間の終了日

    hscode

    Max Length : [20]

    HSコード

    配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力

    shipping_scope

    配送情報

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

    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

    配送期間

    minimum
    期間設定の最小値
    DEFAULT 1

    maximum
    期間設定の最大値
    DEFAULT 7
    shipping_fee_type

    送料タイプ

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

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

    shipping_rates

    Array Max : [200]

    送料金額

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

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

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

    shipping_rates_min
    送料を適用する範囲の開始値

    shipping_rates_max
    送料を適用する範囲の終了値

    shipping_fee
    送料
    prepaid_shipping_fee

    送料前払いの設定

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    clearance_category_code

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

    海外通関コード

    配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力
    clearance_category_code

    detail_image

    詳細画像

    list_image

    一覧画像

    tiny_image

    縮小一覧画像

    small_image

    縮小画像

    image_upload_type

    画像アップロードタイプ

    画像をアップロードする時、画像のアップロードタイプ
    「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード
    「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード

    ※ EC Globalは、FTPをサポートしていないため、Cは使用できません

    A:メイン画像登録
    B:個別画像登録
    C:ウェブFTP登録

    additional_information

    追加項目

    key
    追加項目のキー
    Required

    value
    追加項目の値
    price_content

    Max Length : [20]

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

    buy_limit_by_product

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

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

    buy_limit_type

    購入制限

    N:会員のみ購入でき
    購入ボタンを表示しない
    M:会員のみ購入でき
    購入ボタンを表示する
    F:購入を制限しない

    buy_group_list

    購入できる会員ランク

    repurchase_restriction

    再購入制限

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

    single_purchase_restriction

    単独購入制限

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

    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」と入力します。

    points_by_product

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

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

    points_setting_by_payment

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

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

    points_amount

    ポイント設定情報

    payment_method
    ポイント決済方法

    naverpay : Naver Pay、smilepay：SmilePay、kakaopay：Kakaopay、payco : PAYCO、paynow：Paynow、kpay：KPAY、icash：バーチャル口座、deposit：預り金、tcash：リアルタイム口座振替、cell：キャリア決済、 card：クレジットカード、mileage：ポイント、cash：銀行振込

    points_rate
    付与率

    points_unit_by_payment
    決済方法別のポイント付与単位

    P：百分率基準、W：ウォン基準
    except_member_points

    会員ランク別の追加ポイントを付与しない

    T：会員ランク追加付与除外を設定する
    F：会員ランク追加付与除外を設定しない

    product_volume

    商品容積情報

    use_product_volume
    商品体積の使用有無

    product_width
    幅(W)

    product_height
    奥行(D)

    product_length
    高さ(H)
    origin_classification

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

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

    origin_place_no

    原産国番号

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

    origin_place_value

    Max Length : [30]

    原産国のその他の情報

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

    made_in_code

    国名(原産国)コード

    main

    メイン表示

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

    relational_product

    Array Max : [200]

    関連商品

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

    product_no
    商品番号

    interrelated
    関連商品の相互登録    
    Required

    T：相互登録、F：単独登録    
    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個まで登録可能できる。

    adult_certification

    年齢認証

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

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

    exposure_limit_type

    商品表示制限の範囲

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

    exposure_group_list

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

    Request Copy
    Response Copy

    Delete a product

    DELETE /api/v2/admin/products/{product_no}

    DELETE

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Request Copy
    Response Copy

    Products additionalimages

    「Products additionalimages」は商品の追加画像を照会できるサブリソースであり、「Products」の以下で使用できます。

    Endpoints 
    POST /api/v2/admin/products/{product_no}/additionalimages
PUT /api/v2/admin/products/{product_no}/additionalimages

    Products additionalimages properties

    Attribute Description
    shop_no

    ショップ番号
    additional_image

    追加画像

    Create a products additionalimage

    POST /api/v2/admin/products/{product_no}/additionalimages

    POST

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    additional_image
    Required

    追加画像

    Request Copy
    Response Copy

    Update a products additionalimage

    PUT /api/v2/admin/products/{product_no}/additionalimages

    PUT

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    additional_image
    Required

    追加画像

    Request Copy
    Response Copy

    Products approve

    供給会社の商品承認機能を使っているショップでしか使えないAPIです。

    Endpoints 
    GET /api/v2/admin/products/{product_no}/approve
POST /api/v2/admin/products/{product_no}/approve
PUT /api/v2/admin/products/{product_no}/approve

    Products approve properties

    Attribute Description
    shop_no

    ショップ番号

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

    ステータス

    供給会社が承認要求した商品の承認ステータス

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

    商品番号

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

    Get products approve status

    GET /api/v2/admin/products/{product_no}/approve

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    Request Copy
    Response Copy

    Create a products approve

    POST /api/v2/admin/products/{product_no}/approve

    POST

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

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

    user_id
    Required

    供給会社の運営者ID

    承認を要求した供給会社のID

    Request Copy
    Response Copy

    Update a products approve

    PUT /api/v2/admin/products/{product_no}/approve

    PUT

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    user_id
    Required

    供給会社の運営者ID

    承認を要求した供給会社のID

    status
    Required

    ステータス

    供給会社が承認要求した商品の承認ステータス

    C:承認完了ステータス値
    R:承認拒否ステータス値
    I:検収進行中ステータス値

    Request Copy
    Response Copy

    Products decorationimages

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

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

    Endpoints 
    GET /api/v2/admin/products/decorationimages
GET /api/v2/admin/products/{product_no}/decorationimages
POST /api/v2/admin/products/{product_no}/decorationimages
PUT /api/v2/admin/products/{product_no}/decorationimages
DELETE /api/v2/admin/products/{product_no}/decorationimages/{code}

    Products decorationimages properties

    Attribute Description
    code

    デコ画像コード
    path

    デコ画像URL
    shop_no

    ショップ番号
    use_show_date

    表示期間の使用の有無

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

    timezone

    表示期間の開始日
    show_end_date

    timezone

    表示期間の終了日
    image_list

    デコ画像一覧

    List all decoration images

    GET /api/v2/admin/products/decorationimages

    GET

    基本スペック

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

    List all products decoration images

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

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Request Copy
    Response Copy

    Select decoration images to a product

    POST /api/v2/admin/products/{product_no}/decorationimages

    POST

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    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

    デコ画像一覧

    code
    デコ画像コード

    path
    デコ画像URL

    image_horizontal_position
    デコ画像の表示位置(水平値)

    image_vertical_position
    デコ画像の表示位置(垂直値)
    Request Copy
    Response Copy

    Update a decoration images to a product

    PUT /api/v2/admin/products/{product_no}/decorationimages

    PUT

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    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

    デコ画像一覧

    code
    デコ画像コード

    path
    デコ画像URL

    image_horizontal_position
    デコ画像の表示位置(水平値)

    image_vertical_position
    デコ画像の表示位置(垂直値)
    Request Copy
    Response Copy

    Deselect a decoration images to a product

    DELETE /api/v2/admin/products/{product_no}/decorationimages/{code}

    DELETE

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    code
    Required

    デコ画像コード

    product_no
    Required

    商品番号

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

    Request Copy
    Response Copy

    Products discountprice

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

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

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

    Products discountprice properties

    Attribute Description
    pc_discount_price

    PC割引価格
    mobile_discount_price

    モバイル割引価格

    List all products discountprice

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

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    Request Copy
    Response Copy

    Products hits

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

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

    Count all products hits

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

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Request Copy
    Response Copy

    Products icons

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

    Endpoints 
    GET /api/v2/admin/products/icons
GET /api/v2/admin/products/{product_no}/icons
POST /api/v2/admin/products/{product_no}/icons
PUT /api/v2/admin/products/{product_no}/icons
DELETE /api/v2/admin/products/{product_no}/icons/{code}

    Products icons properties

    Attribute Description
    code

    商品アイコンコード
    path

    アイコンURL
    shop_no

    ショップ番号
    use_show_date

    表示期間の使用の有無

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

    timezone

    表示期間の開始日
    show_end_date

    timezone

    表示期間の終了日
    image_list

    商品アイコン一覧

    List all icons

    GET /api/v2/admin/products/icons

    GET

    基本スペック

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

    List all products icons

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

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Request Copy
    Response Copy

    Select product icons to a product

    POST /api/v2/admin/products/{product_no}/icons

    POST

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    image_list
    Required

    Array Max : [5]

    商品アイコン一覧

    code
    商品アイコンコード
    Required
    Request Copy
    Response Copy

    Update a product icons to a product

    PUT /api/v2/admin/products/{product_no}/icons

    PUT

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    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

    Array Max : [5]

    商品アイコン一覧

    code
    商品アイコンコード
    Required
    Request Copy
    Response Copy

    Deselect a product icons to a product

    DELETE /api/v2/admin/products/{product_no}/icons/{code}

    DELETE

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    code
    Required

    商品アイコンコード

    Request Copy
    Response Copy

    Products images

    商品画像(Products Images)は商品を販売するためにアップロードした商品の写真や絵を意味します。商品画像APIを使って商品詳細説明に使う画像や商品の画像をアップロードすることができます。
    商品の画像はBase64コードでエンコードしてアップロードできます。

    Endpoints 
    POST /api/v2/admin/products/images
POST /api/v2/admin/products/{product_no}/images
DELETE /api/v2/admin/products/{product_no}/images

    Products images properties

    Attribute Description
    path

    詳細画像
    shop_no

    ショップ番号

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

    商品番号

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

    詳細画像

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

    一覧画像

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

    縮小一覧画像

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

    縮小画像

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

    Upload Images

    POST /api/v2/admin/products/images

    POST

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 20

    要求スペック

    Parameter Description
    image
    Required

    詳細画像

    Request Copy
    Response Copy

    Upload product images

    POST /api/v2/admin/products/{product_no}/images

    POST

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    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:個別画像登録

    Request Copy
    Response Copy

    Delete a products image

    DELETE /api/v2/admin/products/{product_no}/images

    DELETE

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Request Copy
    Response Copy

    Products memos

    商品メモは商品に添付する簡単なメモで、商品に関する特異事項を書いたり運営者同士のコミュニケーションツールとして活用することができます。
    商品メモは下位Resourceで、商品(Products)の下位でしか使えません。

    Endpoints 
    GET /api/v2/admin/products/{product_no}/memos
GET /api/v2/admin/products/{product_no}/memos/{memo_no}
POST /api/v2/admin/products/{product_no}/memos
PUT /api/v2/admin/products/{product_no}/memos/{memo_no}
DELETE /api/v2/admin/products/{product_no}/memos/{memo_no}

    Products memos properties

    Attribute Description
    memo_no

    メモ番号

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

    Max Length : [20]

    作成者ID

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

    timezone

    作成日

    メモを作成した時間
    memo

    メモ

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

    List all products memos

    GET /api/v2/admin/products/{product_no}/memos

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Get a products memo

    GET /api/v2/admin/products/{product_no}/memos/{memo_no}

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    memo_no
    Required

    メモ番号

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

    Request Copy
    Response Copy

    Create a products memo

    POST /api/v2/admin/products/{product_no}/memos

    POST

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    author_id
    Required

    Max Length : [20]

    作成者ID

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

    memo
    Required

    メモ

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

    Request Copy
    Response Copy

    Update a products memo

    PUT /api/v2/admin/products/{product_no}/memos/{memo_no}

    PUT

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    memo_no
    Required

    メモ番号

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

    author_id
    Required

    Max Length : [20]

    作成者ID

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

    memo
    Required

    メモ

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

    Request Copy
    Response Copy

    Delete a products memo

    DELETE /api/v2/admin/products/{product_no}/memos/{memo_no}

    DELETE

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    memo_no
    Required

    メモ番号

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

    Request Copy
    Response Copy

    Products options

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

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

    Endpoints 
    GET /api/v2/admin/products/{product_no}/options
POST /api/v2/admin/products/{product_no}/options
PUT /api/v2/admin/products/{product_no}/options
DELETE /api/v2/admin/products/{product_no}/options

    Products options properties

    Attribute Description
    shop_no

    ショップ番号

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

    商品番号

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

    オプション使用の設定

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

    オプション構成方式

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

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

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

    オプション表示方式

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

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

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

    C:一体型
    S:分離型
    option_preset_code

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

    バリエーションコード

    商品連動型オプションを使う場合、オプションセットコード表示
    options

    オプション
    select_one_by_option

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

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

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

    連動型バリエーション名

    商品連動型オプションを使う場合、オプションセットの名前表示
    use_additional_option

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

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

    追加入力オプション
    use_attached_file_option

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

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

    ファイル添付オプション

    List all products options

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

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Request Copy
    Response Copy

    Create a products option

    POST /api/v2/admin/products/{product_no}/options

    POST

    商品オプション登録APIを使ってオプションを登録することができます。オプション登録APIでオプションを登録すると、品目は自動生成されます。

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    has_option

    オプション使用の設定

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

    option_type

    オプション構成方式

    オプションを使う場合、オプションのタイプを入力

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

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

    option_list_type

    オプション表示方式

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

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

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

    S:組み合わせ分離選択型
    C:組み合わせ一体選択型

    options

    オプション

    option_name
    オプション名
    Required

    option_value Array
    オプション値
    Required

    option_text
    オプション値

    option_image_file
    オプションボタンの画像    

    option_color
    カラーチップの色    

    option_display_type
    オプション表示方式
    DEFAULT S
    S：セレクトボックス、P：プレビュー、B：テキストボタン、R：ラジオボタン
    select_one_by_option

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

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

    T:使用する
    F:使用しない　「独立型だけに存在」をチェックするとオプション別に一つずつ選択値を処理

    option_preset_code

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

    バリエーションコード

    option_preset_name

    連動型バリエーション名

    商品連動型オプションを使う場合、オプションセットの名前を入力

    use_additional_option

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

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

    additional_options

    追加入力オプション

    additional_option_name
    追加入力オプション名    
    Required

    additional_option_text_length
    追加入力オプションの文字数制限
    Required

    1~30
    50
    100
    200

    required_additional_option
    追加入力オプションの必須設定    
    Required
    DEFAULT T
    T：必須、F：任意    
    use_attached_file_option

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

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

    attached_file_option

    ファイル添付オプション

    Request Copy
    Response Copy

    Update a products option

    PUT /api/v2/admin/products/{product_no}/options

    PUT

    商品オプション修正APIはオプションを修正しながら品目を初期化しません。オプション名とオプション値、追加入力オプションとファイル添付オプションの修正のみ可能で、オプション項目の追加や削除はできません。

    オプションを追加または削除したい場合は、オプション削除APIで削除した後、再度登録しなければなりません。

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    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]

    バリエーションコード

    商品連動型オプションを使う場合、オプションセットコード入力

    options

    オプション

    option_name
    オプション名
    Required

    option_value Array
    オプション値

    option_text
    オプション値

    option_image_file
    オプションボタンの画像    

    option_link_image
    オプション連動画像

    option_color
    カラーチップの色    

    option_display_type
    オプション表示方式
    DEFAULT S
    S：セレクトボックス、P：プレビュー、B：テキストボタン、R：ラジオボタン
    original_options

    修正前のオプション値

    option_name
    オプション名
    Required

    option_value Array
    オプション値
    Required

    option_text
    オプション値
    select_one_by_option

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

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

    T:使用する
    F:使用しない　「独立型だけに存在」をチェックするとオプション別に一つずつ選択値を処理

    option_preset_name

    連動型バリエーション名

    商品連動型オプションを使う場合、オプションセットの名前を入力

    use_additional_option

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

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

    additional_options

    追加入力オプション

    additional_option_name
    追加入力オプション名    
    Required

    additional_option_text_length
    追加入力オプションの文字数制限
    Required

    1~30
    50
    100
    200

    required_additional_option
    追加入力オプションの必須設定    
    Required
    DEFAULT T
    T：必須、F：任意    
    use_attached_file_option

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

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

    attached_file_option

    ファイル添付オプション

    Request Copy
    Response Copy

    Delete a products option

    DELETE /api/v2/admin/products/{product_no}/options

    DELETE

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    Request Copy
    Response Copy

    Products seo

    SEOは検索エンジンの最適化(Search Engine Optimization)の略語で、SEO APIは検索エンジンで商品やショップがよりよく検索できるようにします。
    商品の下位Resourceで、SEO APIは商品の検索エンジンの最適化設定ができます。

    Endpoints 
    GET /api/v2/admin/products/{product_no}/seo
PUT /api/v2/admin/products/{product_no}/seo

    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

    GET /api/v2/admin/products/{product_no}/seo

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Request Copy
    Response Copy

    Update a products seo

    PUT /api/v2/admin/products/{product_no}/seo

    PUT

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    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

    検索エンジンでの表示設定

    商品を検索エンジンに表示するかどうかを設定。「表示しない」に設定する場合、その商品が検索エンジンに表示されない。

    Request Copy
    Response Copy

    Products tags

    「Tags」は、商品を特定のキーワードで検索したときにその検索結果に商品を表示させる機能です。 商品名や商品詳細説明に含まれていないキーワードで商品を検索結果に表示させるためには、キーワードを追加することができます。

    検索キーワードはサブリソースであるため、「Products」の以下で使用可能です。

    Endpoints 
    GET /api/v2/admin/products/{product_no}/tags
GET /api/v2/admin/products/{product_no}/tags/count
POST /api/v2/admin/products/{product_no}/tags
DELETE /api/v2/admin/products/{product_no}/tags/{tag}

    Products tags properties

    Attribute Description
    shop_no

    ショップ番号

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

    商品タグ

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

    商品タグ
    product_no

    商品番号

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

    List all products tags

    GET /api/v2/admin/products/{product_no}/tags

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Request Copy
    Response Copy

    Count all products tags

    GET /api/v2/admin/products/{product_no}/tags/count

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Request Copy
    Response Copy

    Create a products tag

    POST /api/v2/admin/products/{product_no}/tags

    POST

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    tag
    Required

    商品タグ

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

    tags
    Required

    商品タグ

    Request Copy
    Response Copy

    Delete a products tag

    DELETE /api/v2/admin/products/{product_no}/tags/{tag}

    DELETE

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    tag

    商品タグ

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

    Request Copy
    Response Copy

    Products variants

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

    ● 在庫(Inventories)

    Endpoints 
    GET /api/v2/admin/products/{product_no}/variants
GET /api/v2/admin/products/{product_no}/variants/{variant_code}
PUT /api/v2/admin/products/{product_no}/variants/{variant_code}
PUT /api/v2/admin/products/{product_no}/variants
DELETE /api/v2/admin/products/{product_no}/variants/{variant_code}

    Products variants properties

    Attribute Description
    shop_no

    ショップ番号

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

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

    商品品目コード

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

    オプション
    custom_variant_code

    Max Length : [40]

    独自品目コード

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

    表示ステータス

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

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

    販売ステータス

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

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

    追加金額

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

    在庫使用の設定

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

    重要在庫の有無

    A:一般在庫
    B:重要在庫
    inventory_control_type

    在庫数量チェックの基準

    A:注文基準
    B:決済基準
    display_soldout

    在庫切れ表示の設定

    T:在庫切れ表示を使用する
    F:在庫切れ表示を使用しない
    quantity

    数量
    safety_inventory

    安全在庫数量
    inventories

    在庫リソース

    品目の在庫Resource
    duplicated_custom_variant_code

    独自品目コードの重複有無

    T:重複する
    F:重複しない
    product_no

    商品番号

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

    List all products variants

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

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    inventories
    embed

    在庫リソース

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

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

    Request Copy
    Response Copy

    Get a products variant

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

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    variant_code
    Required

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

    品目コード

    inventories
    embed

    在庫リソース


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

    Request Copy
    Response Copy

    Update a products variant

    PUT /api/v2/admin/products/{product_no}/variants/{variant_code}

    PUT

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    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:在庫切れ表示を使用しない

    safety_inventory

    安全在庫数量

    Request Copy
    Response Copy

    Update products variants(batch)

    PUT /api/v2/admin/products/{product_no}/variants

    PUT

    一つの商品に対する複数の品目を同時に修正できる品目修正(マルチ)APIです。

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 100

    要求スペック

    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:在庫切れ表示を使用しない

    safety_inventory

    安全在庫数量

    Request Copy
    Response Copy

    Delete a products variant

    DELETE /api/v2/admin/products/{product_no}/variants/{variant_code}

    DELETE

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    variant_code
    Required

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

    商品品目コード

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

    Request Copy
    Response Copy

    Products variants inventories

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

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

    Products variants inventories properties

    Attribute Description
    shop_no

    ショップ番号

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

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

    品目コード

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

    在庫使用の設定

    品目に対して在庫管理を使うかどうかを設定。在庫管理を使う場合、在庫数を入力することができる。在庫管理を使わない場合、その商品は在庫と関係なく販売可能で、在庫数、在庫数チェック基準、在庫切れ表示の設定を使うことができない。

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

    重要在庫の有無

    在庫を重要管理するかどうかを設定。ショップでは検索するための区分データとして使う。

    A:一般在庫
    B:重要在庫
    inventory_control_type

    在庫数量チェックの基準

    在庫数量をどの時点で差し引くかという基準。銀行振込のように決済時点と注文時点が異なる場合は在庫を差し引く基準をそれぞれ設定することができる。

    注文基準: 注文した時点で在庫を差し引く。銀行振込の場合は入金が完了しなくても在庫を差し引く。
    決済基準: 決済した時点で在庫を差し引く。銀行振込の場合は入金が完了した後、在庫を差し引く。

    A:注文基準
    B:決済基準
    display_soldout

    在庫切れ表示の設定

    在庫がすべて販売された場合、その品目を在庫切れと表示するかどうかの設定。在庫切れと表示されると注文ができない。すべての品目が在庫切れになる場合はその商品に在庫切れアイコンが表示される。
    「表示しない」を選択すると在庫がすべて販売されても注文が可能で、在庫がマイナス(-)と表記される。

    T:在庫切れ表示を使用する
    F:在庫切れ表示を使用しない
    quantity

    数量

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

    安全在庫数量

    Get products variants inventory

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

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    variant_code
    Required

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

    品目コード

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

    Request Copy
    Response Copy

    Update a products variants inventory

    PUT /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories

    PUT

    基本スペック

    Property Description
    SCOPE 商品の投稿権限 (mall.write_product)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    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

    数量

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

    safety_inventory

    安全在庫数量

    Request Copy
    Response Copy

    Order

    Cancellation

    Endpoints 
    GET /api/v2/admin/cancellation/{claim_code}
POST /api/v2/admin/cancellation
PUT /api/v2/admin/cancellation

    Cancellation properties

    Attribute Description
    shop_no

    ショップ番号

    詳細照会を行う際にのみ確認できる。
    order_id

    注文番号

    詳細照会を行う際にのみ確認できる。
    claim_code

    キャンセル番号

    詳細照会を行う際にのみ確認できる。
    claim_reason_type

    区分

    詳細照会を行う際にのみ確認できる。

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他
    claim_reason

    理由

    詳細照会を行う際にのみ確認できる。
    refund_method

    返金方式

    詳細照会を行う際にのみ確認できる。
    refund_reason

    備考

    詳細照会を行う際にのみ確認できる。
    order_price_amount

    商品購入金額

    詳細照会を行う際にのみ確認できる。
    refund_amount

    返金額

    詳細照会を行う際にのみ確認できる。
    shipping_fee

    送料

    詳細照会を行う際にのみ確認できる。
    return_ship_type

    返品送料の適用区分

    詳細照会を行う際にのみ確認できる。
    defer_commission

    後払い手数料

    詳細照会を行う際にのみ確認できる。
    partner_discount_amount

    提携割引のキャンセル金額

    詳細照会を行う際にのみ確認できる。
    add_discount_amount

    商品別追加割引の
    キャンセル金額

    詳細照会を行う際にのみ確認できる。
    member_grade_discount_amount

    会員ランク割引の
    キャンセル金額

    詳細照会を行う際にのみ確認できる。
    shipping_discount_amount

    送料割引のキャンセル金額

    詳細照会を行う際にのみ確認できる。
    coupon_discount_amount

    クーポン割引の
    キャンセル金額

    詳細照会を行う際にのみ確認できる。
    point_used

    使用済みポイントの返還額

    詳細照会を行う際にのみ確認できる。
    credit_used

    使用済み預り金の返還額

    詳細照会を行う際にのみ確認できる。
    undone

    取消しの有無

    詳細照会を行う際にのみ確認できる。

    T：取り消す
    F：取り消さない
    undone_reason_type

    取消し理由の区分

    詳細照会を行う際にのみ確認できる。

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他
    undone_reason

    取消しの理由

    詳細照会を行う際にのみ確認できる。
    expose_order_detail

    注文詳細の表示設定

    詳細照会を行う際にのみ確認できる。

    T：表示する
    F：表示しない
    exposed_undone_reason

    注文詳細に表示される取消しの理由

    詳細照会を行う際にのみ確認できる。
    items

    品目別注文コード

    詳細照会を行う際にのみ確認できる。
    status

    注文ステータス

    canceled:キャンセル完了
    recover_inventory

    在庫の回復

    T : 復元する
    F : 復元しない
    add_memo_too

    運営者メモに追加する

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

    Get a cancellation

    GET /api/v2/admin/cancellation/{claim_code}

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    claim_code
    Required

    キャンセル番号

    Request Copy
    Response Copy

    Create cancellation

    POST /api/v2/admin/cancellation

    POST

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 100

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    status
    Required

    注文ステータス

    canceled:キャンセル完了

    recover_inventory

    在庫の回復

    T : 復元する
    F : 復元しない

    DEFAULT F

    recover_coupon

    クーポン復元

    T : 復元する
    F : 復元しない

    DEFAULT F

    add_memo_too

    運営者メモに追加する

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

    DEFAULT F

    reason

    Max Length : [2000]

    キャンセル理由

    claim_reason_type

    キャンセル理由の区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他

    naverpay_cancel_reason_type

    Naver Payで注文した件のキャンセル理由の区分

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

    51 : 心変わり
    52 : カラーまたはサイズ変更
    53 : 誤注文
    54 : サービス・商品への不満
    55 : 配送遅延
    56 : 在庫切れ
    60 : 商品情報との不一致

    refund_method_code

    返金方式

    T : 現金
    F : クレジットカード
    M : ポイント
    G : 口座振込
    C : キャリア決済
    D : 預り金
    Z : 後払い
    O : 前払金
    I : コンビニ
    V : その他

    combined_refund_method

    複合 返金 方式

    T : 現金
    M : ポイント
    D : 預り金

    refund_bank_code

    返金先の銀行コード

    refund_bank_name

    Max Length : [250]

    返金先の銀行名

    refund_bank_account_no

    Max Length : [50]

    返金の口座番号

    refund_bank_account_holder

    Max Length : [15]

    返金先の口座名義

    items

    品目別注文コード

    order_item_code
    品目別注文コード
    Required

    quantity
    数量
    Required
    Request Copy
    Response Copy

    Update cancellation

    PUT /api/v2/admin/cancellation

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 10

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    claim_code
    Required

    キャンセル番号

    recover_inventory
    Required

    在庫の回復

    T : 復元する
    F : 復元しない

    undone
    Required

    取消しの有無

    T : 철회함

    add_memo_too
    Required

    運営者メモに追加する

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

    undone_reason_type
    Required

    取消し理由の区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他

    undone_reason

    Max Length : [2000]

    取消しの理由

    expose_order_detail
    Required

    注文詳細の表示設定

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

    exposed_undone_reason

    Max Length : [2000]

    注文詳細に表示される取消しの理由

    Request Copy
    Response Copy

    Cancellationrequests

    Endpoints 
    POST /api/v2/admin/cancellationrequests
PUT /api/v2/admin/cancellationrequests

    Cancellationrequests properties

    Attribute Description
    shop_no

    ショップ番号
    order_id

    注文番号
    items

    品目別注文一覧
    undone

    受付を拒否するかどうか
    order_item_code

    品目別注文コード

    Create cancellationrequests

    POST /api/v2/admin/cancellationrequests

    POST

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 100

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    reason_type
    Required

    キャンセル理由の区分

    A : お客様都合
    B : 配送遅延
    G : サービスへの不満
    I : その他

    reason
    Required

    Max Length : [2000]

    キャンセル理由

    refund_bank_code

    返金先の銀行コード

    refund_bank_name

    Max Length : [250]

    返金先の銀行名

    refund_bank_account_no

    Max Length : [50]

    返金の口座番号

    refund_bank_account_holder

    Max Length : [15]

    返金先の口座名義

    items

    品目別注文一覧

    order_item_code
    品目別注文コード
    Required

    quantity
    数量
    Required
    Request Copy
    Response Copy

    Update cancellationrequests

    PUT /api/v2/admin/cancellationrequests

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 100

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    order_item_code
    Required

    品目別注文コード

    undone
    Required

    受付を拒否するかどうか

    T：受付を拒否する

    reason_type

    理由の区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他

    reason

    Max Length : [2000]

    理由

    display_reject_reason

    注文詳細の表示設定

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

    DEFAULT F

    reject_reason

    Max Length : [2000]

    拒否の理由

    Request Copy
    Response Copy

    Cashreceipt

    Endpoints 
    GET /api/v2/admin/cashreceipt
POST /api/v2/admin/cashreceipt
PUT /api/v2/admin/cashreceipt/{cashreceipt_no}

    Cashreceipt properties

    Attribute Description
    cashreceipt_no

    現金領収証番号
    approval_no

    承認番号
    request_date

    申込日
    order_id

    注文番号
    member_id

    会員ID
    name

    要請者名
    order_price_amount

    商品購入金額
    vat

    消費税
    subtotal

    申込み金額合計
    order_status

    注文ステータス

    入金前：unpaid
    未配送：unshipped
    配送中：shipping
    出荷待ち：standby
    配送完了：shipped
    一部キャンセル：partially_canceled
    すべてキャンセル： canceled
    status

    処理ステータス

    申込み：request
    発行待ち：await_issuance
    発行：issued
    発行拒否：issuance_rejected
    申込み取消し：canceled_request
    発行取消し：canceled_issuance
    発行失敗：failed_issuance
    pg_name

    申込の決済代行会社
    cash_bill_no

    現金領収証の一連番号
    type

    発行タイプ

    個人：personal
    事業者： business
    company_registration_no

    事業者登録番号
    cellphone

    電話番号(携帯)
    tax_amount

    課税金額
    tax_free_amount

    免税金額
    supply_price

    仕入れ価格

    List all cashreceipt

    GET /api/v2/admin/cashreceipt

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    start_date
    Required

    Date
    timezone

    検索開始日

    end_date
    Required

    Date
    timezone

    検索終了日

    order_id

    Order ID

    注文番号

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

    approval_no

    Max Length : [9]

    承認番号

    name

    Max Length : [20]

    要請者名

    member_id

    Max Length : [20]

    会員ID

    status

    処理ステータス

    すべて：all
    申込み：request
    発行：issued
    申込み取消し：canceled_request
    発行取消し：canceled_issuance
    発行失敗： failed_issuance

    DEFAULT all

    limit

    Min : [1]~Max : [500]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Create a cashreceipt

    POST /api/v2/admin/cashreceipt

    POST

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    order_id
    Required

    Order ID

    注文番号

    type
    Required

    発行タイプ

    個人：personal
    事業者： business

    company_registration_no

    Business Number
    Max Length : [10]

    事業者登録番号

    cellphone

    Mobile
    Max Length : [11]

    電話番号(携帯)

    Request Copy
    Response Copy

    Update a cashreceipt

    PUT /api/v2/admin/cashreceipt/{cashreceipt_no}

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    cashreceipt_no
    Required

    Min : [1]

    現金領収証番号

    order_id
    Required

    Order ID

    注文番号

    type

    発行タイプ

    個人：personal
    事業者： business

    company_registration_no

    Business Number
    Max Length : [10]

    事業者登録番号

    cellphone

    Mobile
    Max Length : [11]

    電話番号(携帯)

    Request Copy
    Response Copy

    Cashreceipt cancellation

    Endpoints 
    PUT /api/v2/admin/cashreceipt/{cashreceipt_no}/cancellation

    Cashreceipt cancellation properties

    Attribute Description
    cashreceipt_no

    現金領収証番号
    order_id

    注文番号
    status

    処理ステータス

    申込み取消し：canceled_request
    発行取消し：canceled_issuance

    Update a cashreceipt cancellation

    PUT /api/v2/admin/cashreceipt/{cashreceipt_no}/cancellation

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    cashreceipt_no
    Required

    Min : [1]

    現金領収証番号

    order_id
    Required

    Order ID

    注文番号

    type
    Required

    取消しタイプ

    申込み取消し：request
    発行取消し： issue

    Request Copy
    Response Copy

    Collectrequests

    Endpoints 
    PUT /api/v2/admin/collectrequests/{request_no}

    Collectrequests properties

    Attribute Description
    shop_no

    ショップ番号
    request_no

    LIBSPECDATAREQUEST.NUMBER
    order_id

    注文番号
    order_item_code

    品目別注文コード
    shipping_company_name

    LIBSPECDATACOLLECT.SHIPPING.COMPANY.NAME
    collect_tracking_no

    LIBSPECDATACOLLECTION.TRACKING.NUMBER

    Update a collectrequest

    PUT /api/v2/admin/collectrequests/{request_no}

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 30
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    request_no
    Required

    LIBSPECDATAREQUEST.NUMBER

    collect_tracking_no
    Required

    Max Length : [30]

    LIBSPECDATACOLLECTION.TRACKING.NUMBER

    Request Copy
    Response Copy

    Exchange

    Endpoints 
    GET /api/v2/admin/exchange/{claim_code}

    Exchange properties

    Attribute Description
    shop_no

    ショップ番号

    詳細照会を行う際にのみ確認できる。
    order_id

    注文番号

    詳細照会を行う際にのみ確認できる。
    claim_code

    交換番号

    詳細照会を行う際にのみ確認できる。
    claim_reason_type

    区分

    詳細照会を行う際にのみ確認できる。

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他
    claim_reason

    理由

    詳細照会を行う際にのみ確認できる。
    claim_due_date

    交換処理の予定日

    詳細照会を行う際にのみ確認できる。
    receiver

    受取人

    詳細照会を行う際にのみ確認できる。
    reshipping_detail

    交換による再発送の情報

    詳細照会を行う際にのみ確認できる。
    pickup

    受取人の住所

    詳細照会を行う際にのみ確認できる。
    additional_payment

    追加決済

    詳細照会を行う際にのみ確認できる。
    return_invoice_no

    返品用送り状の送り状番号

    詳細照会を行う際にのみ確認できる。
    return_shipping_company_name

    返品に使用する配送会社名

    詳細照会を行う際にのみ確認できる。
    refund_method

    返金方式

    詳細照会を行う際にのみ確認できる。
    refund_reason

    備考

    詳細照会を行う際にのみ確認できる。
    order_price_amount

    商品購入金額

    詳細照会を行う際にのみ確認できる。
    refund_amount

    返金額

    詳細照会を行う際にのみ確認できる。
    shipping_fee

    送料

    詳細照会を行う際にのみ確認できる。
    return_ship_type

    返品送料の適用区分

    詳細照会を行う際にのみ確認できる。
    defer_commission

    後払い手数料

    詳細照会を行う際にのみ確認できる。
    partner_discount_amount

    提携割引のキャンセル金額

    詳細照会を行う際にのみ確認できる。
    add_discount_amount

    商品別追加割引の
    キャンセル金額

    詳細照会を行う際にのみ確認できる。
    member_grade_discount_amount

    会員ランク割引の
    キャンセル金額

    詳細照会を行う際にのみ確認できる。
    shipping_discount_amount

    送料割引のキャンセル金額

    詳細照会を行う際にのみ確認できる。
    coupon_discount_amount

    クーポン割引の
    キャンセル金額

    詳細照会を行う際にのみ確認できる。
    point_used

    使用済みポイントの返還額

    詳細照会を行う際にのみ確認できる。
    credit_used

    使用済み預り金の返還額

    詳細照会を行う際にのみ確認できる。
    undone

    取消しの有無

    詳細照会を行う際にのみ確認できる。

    T：取り消す
    F：取り消さない
    undone_reason_type

    取消し理由の区分

    詳細照会を行う際にのみ確認できる。

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他
    undone_reason

    取消しの理由

    詳細照会を行う際にのみ確認できる。
    expose_order_detail

    注文詳細の表示設定

    詳細照会を行う際にのみ確認できる。

    T：表示する
    F：表示しない
    exposed_undone_reason

    注文詳細に表示される取消しの理由

    詳細照会を行う際にのみ確認できる。
    items

    品目別注文エンティティ

    詳細照会を行う際にのみ確認できる。
    exchanged_items

    交換商品

    詳細照会を行う際にのみ確認できる。

    Get an exchange

    GET /api/v2/admin/exchange/{claim_code}

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    claim_code
    Required

    交換番号

    Request Copy
    Response Copy

    Orders

    Orders Resource関係図

    注文(order)はショップでショップの顧客が商品を購入するためにショップに要求した内訳です。ショップの運営者は決済済みの注文情報を見てショップの顧客に商品を配送します。注文情報には注文と決済を行った注文者の情報と商品を受け取る受取人の情報が含まれています。


    注文は下記のようなResourceを下位Resourceとして持っています。
    ● 品目別注文(Items)
    ● 受取人情報(Receivers)

    Endpoints 
    GET /api/v2/admin/orders
GET /api/v2/admin/orders/count
GET /api/v2/admin/orders/{order_id}
PUT /api/v2/admin/orders/{order_id}
PUT /api/v2/admin/orders

    Orders properties

    Attribute Description
    shop_no

    ショップ番号

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

    通貨単位

    マルチショップの通貨単位
    order_id

    注文番号
    market_id

    モール型ECサイトの区分値

    価格比較サイトを経由してモール型ECサイトなどで商品を購入する場合、そのサイトを区分するためのID
    market_order_info

    モール型ECサイトのその他の情報

    モール型ECサイトまたは注文経路に関するその他の情報
    member_id

    会員ID
    member_email

    会員メールアドレス
    member_authentication

    会員認証の有無

    会員認証の設定。設定によって会員は3つのタイプに分けられる。

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

    決済者名

    入金者の名前。注文者または受取人の名前と違う場合がある。
    bank_code

    銀行コード

    bank_code

    bank_code_name

    入金銀行名
    payment_method

    決済方法コード

    注文者が利用した決済方法のコード

    cash : 銀行振込
    card : クレジットカード
    cell : キャリア決済
    tcash : 口座振込
    icash : バーチャル口座
    prepaid : 前払い
    credit : 預り金
    point : ポイント
    pointfy : 総合ポイント
    cvs : コンビニ
    cod : 後払い
    coupon : クーポン
    market_discount : モール型ECサイト割引
    etc : その他
    payment_method_name

    決済方法名

    注文者が利用した決済方法の名前
    payment_gateway_name

    決済代行サービス名

    注文者が利用した決済代行会社の名前
    sub_payment_method_name

    海外決済方法名
    sub_payment_method_code

    海外決済方法のコード

    sub_payment_method_code

    paid

    決済の有無

    決済が完了したかどうかの表示

    T：決済
    F：未決済
    M：一部決済
    order_date

    timezone

    注文日
    first_order

    初注文の有無

    初めての注文であるかどうかの表示

    T:初注文
    F:初注文ではない
    payment_date

    timezone

    決済日
    order_from_mobile

    モバイル区分

    注文をモバイルで行ったかどうかの区分

    T:モバイル注文
    F:モバイル注文ではない
    use_escrow

    エスクロー使用設定

    エスクローを使ったかどうかを設定

    T：エスクローを使用する
    F：エスクローを使用しない
    group_no_when_ordering

    注文時の会員ランク
    initial_order_amount

    最初の注文金額
    actual_order_amount

    現在の注文金額
    bank_account_no

    口座番号

    注文件に対するショップの口座番号
    bank_account_owner_name

    口座名義
    market_seller_id

    ECサイト販売者ID
    payment_amount

    最終決済金額
    cancel_date

    timezone

    注文キャンセル日
    order_place_name

    注文ルートテキスト
    order_place_id

    注文ルート
    payment_confirmation

    後払いの入金確認可能の設定

    T:入金確認
    F:入金未確認
    commission

    決済手数料
    postpay

    後払い決済かどうか

    T:後払い決済
    F:後払い決済ではない
    admin_additional_amount

    運営者入力金額
    additional_shipping_fee

    追加送料
    international_shipping_insurance

    海外配送保険料
    additional_handling_fee

    海外配送付加金額
    shipping_type

    配送タイプ

    配送タイプ。国内配送か海外配送か両方とも可能かを設定

    A:国内
    B:海外
    shipping_type_text

    配送タイプ名

    配送タイプの説明。国内配送か海外配送か両方とも可能かを説明
    shipping_status

    配送ステータス

    F：配送前
    M：配送中
    T：配送完了
    W：配送保留
    X：発注前
    wished_delivery_date

    配送希望日
    wished_delivery_time

    配達希望時間
    wished_carrier_id

    希望配送会社コード
    wished_carrier_name

    希望配送会社名
    return_confirmed_date

    timezone

    返品承認日時
    total_supply_price

    仕入れ価格合計
    naver_point

    Naverポイント
    additional_order_info_list

    注文書の追加項目
    store_pickup

    店舗受取の設定

    T:店舗にて受取り
    F:店舗にて受取りではない
    easypay_name

    簡単決済の決済代行会社名
    loan_status

    与信状態

    OK : GOOD
    NG : NOT GOOD
    ER : ERROR
    subscription

    定期購入利用状況

    T : 利用中
    F : 非利用
    items

    品目別注文エンティティ


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

    受取人情報エンティティ


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

    注文者情報のリソース


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

    送料情報
    regional_surcharge_detail

    地域別送料情報
    return

    返品詳細リソース


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

    キャンセル詳細リソース


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

    交換詳細リソース


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

    複数配送注文かどうか

    T : 複数配送注文
    F : 複数配送注文ではない
    exchange_rate

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

    最初に使用した決済方法のコード

    cash : 銀行振込
    card : クレジットカード
    cell : キャリア決済
    tcash : 口座振込
    icash : バーチャル口座
    prepaid : 前払い
    credit : 預り金
    point : ポイント
    pointfy : 総合ポイント
    cvs : コンビニ
    cod : 後払い
    etc : その他
    naverpay_payment_information

    Naver Pay決済代行サービス(PG)の決済情報

    P：決済代行サービス(PG)決済
    N：Naver Pay決済
    customer_group_no_when_ordering

    注文時の会員ランク

    注文当時の会員ランク

    詳細照会を行う際にのみ確認できる。
    benefits

    特典リソース


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

    詳細照会を行う際にのみ確認できる。
    coupons

    クーポンリソース


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

    詳細照会を行う際にのみ確認できる。
    refunds

    返金詳細リソース


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

    詳細照会を行う際にのみ確認できる。
    process_status

    注文ステータス

    prepare：発送準備中
    prepareproduct：商品準備中
    hold：配送保留
    unhold：配送保留解除
    order_item_code

    品目別注文コード

    List all orders

    GET /api/v2/admin/orders

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    items
    embed

    品目別注文エンティティ


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

    receivers
    embed

    受取人情報エンティティ


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

    buyer
    embed

    注文者情報のリソース


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

    return
    embed

    返品詳細リソース


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

    cancellation
    embed

    キャンセル詳細リソース


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

    exchange
    embed

    交換詳細リソース


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

    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：交換受付
    N01：交換受付 - 交換商品
    E12：交換保留
    E20：交換準備
    E30：交換処理中 - 回収前
    E32：交換処理中 - 入金前
    E34：交換処理中 - 返金前
    E36：交換処理中 - 返金保留
    E40：交換完了

    member_type

    会員/非会員

    会員の有無。会員と非会員、それぞれのコードがある。

    2:会員
    3:非会員

    group_no

    会員ランク番号

    buyer_name

    注文者名

    注文者の名前。入金者または受取人の名前と異なる場合がある。

    receiver_name

    受取人名

    受取人の名前。注文者または入金者の名前と違う場合がある。

    name_furigana

    受取人名(フリガナ)

    receiver_address

    受取人の住所

    受取人の住所。注文者または入金者の住所と違う場合がある。

    member_id

    会員ID

    会員ID

    member_email

    会員メールアドレス

    product_no

    商品番号

    商品番号

    product_code

    商品コード

    商品コード

    date_type

    検索日付のタイプ

    検索するための日付タイプ基準。基本値は注文日に設定されている。

    order_date：注文日
    pay_date：決済日
    shipbegin_date：配送開始日
    shipend_date：配送完了日
    cancel_date：注文キャンセル日
    place_date：発注日
    updatereceiver_date：受取人情報変更日
    cancel_request_date：キャンセル申込日
    cancel_complete_date：キャンセル完了日
    exchange_request_date：交換申込日
    exchange_accept_date：交換受付日
    exchange_complete_date：交換完了日
    return_request_date：返品申込日
    return_accept_date：返品受付日
    return_complete_date：返品完了日

    DEFAULT order_date

    supplier_id

    供給会社のID

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

    order_place_id

    注文ルート

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

    cafe24：Cafe24
    mobile：モバイルウェブ
    mobile_d：モバイルアプリ
    NCHECKOUT：Naver Pay
    inpark：Interpark
    auction：Auction
    sk11st：11STREET
    gmarket：Gmarket
    coupang：coupang
    shopn：スマートストア

    buyer_cellphone

    注文者の電話番号(携帯)

    buyer_phone

    注文者の固定電話番号

    buyer_email

    注文者のメールアドレス

    inflow_path

    アクセスルート

    subscription

    定期購入利用状況

    T : 利用中
    F : 非利用

    market_cancel_request

    ECサイトキャンセル申込み有無

    T : キャンセル申込みされたECサイトからの注文

    payment_method

    決済方法コード

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

    cash : 銀行振込
    card : クレジットカード
    tcash : 口座振込
    cell : キャリア決済
    deferpay : 後払い
    cvs : コンビニ
    point : 前払い
    mileage : ポイント
    deposit : 預り金
    etc : その他

    payment_gateway_name

    決済代行サービス名

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

    market_seller_id

    ECサイト販売者ID

    discount_method

    割引タイプ

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

    point：ポイント
    credit：預り金
    coupon：クーポン
    market_discount：モール型ECサイト割引
    discount_code：割引コード

    discount_code

    割引コード

    carrier_id

    Min : [1]

    配送会社ID

    limit

    Min : [1]~Max : [500]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Count all orders

    GET /api/v2/admin/orders/count

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    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：交換受付
    N01：交換受付 - 交換商品
    E12：交換保留
    E20：交換準備
    E30：交換処理中 - 回収前
    E32：交換処理中 - 入金前
    E34：交換処理中 - 返金前
    E36：交換処理中 - 返金保留
    E40：交換完了

    member_type

    会員/非会員

    会員の有無。会員と非会員、それぞれのコードがある。

    2:会員
    3:非会員

    group_no

    会員ランク番号

    buyer_name

    注文者名

    注文者の名前。入金者または受取人の名前と異なる場合がある。

    receiver_name

    受取人名

    受取人の名前。注文者または入金者の名前と違う場合がある。

    name_furigana

    受取人名(フリガナ)

    receiver_address

    受取人の住所

    受取人の住所。注文者または入金者の住所と違う場合がある。

    member_id

    会員ID

    会員ID

    member_email

    会員メールアドレス

    product_no

    商品番号

    商品番号

    product_code

    商品コード

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

    date_type

    検索日付のタイプ

    検索するための日付タイプ基準。基本値は注文日に設定されている。

    order_date：注文日
    pay_date：決済日
    shipbegin_date：配送開始日
    shipend_date：配送完了日
    cancel_date：注文キャンセル日
    place_date：発注日
    updatereceiver_date：受取人情報変更日
    cancel_request_date：キャンセル申込日
    cancel_complete_date：キャンセル完了日
    exchange_request_date：交換申込日
    exchange_accept_date：交換受付日
    exchange_complete_date：交換完了日
    return_request_date：返品申込日
    return_accept_date：返品受付日
    return_complete_date：返品完了日

    DEFAULT order_date

    supplier_id

    供給会社のID

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

    order_place_id

    注文ルート

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

    cafe24：Cafe24
    mobile：モバイルウェブ
    mobile_d：モバイルアプリ
    NCHECKOUT：Naver Pay
    inpark：Interpark
    auction：Auction
    sk11st：11STREET
    gmarket：Gmarket
    coupang：coupang
    shopn：スマートストア

    buyer_cellphone

    注文者の電話番号(携帯)

    buyer_phone

    注文者の固定電話番号

    buyer_email

    注文者のメールアドレス

    inflow_path

    アクセスルート

    subscription

    定期購入利用状況

    T : 利用中
    F : 非利用

    market_cancel_request

    ECサイトキャンセル申込み有無

    T : キャンセル申込みされたECサイトからの注文

    payment_method

    決済方法コード

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

    cash : 銀行振込
    card : クレジットカード
    tcash : 口座振込
    cell : キャリア決済
    deferpay : 後払い
    cvs : コンビニ
    point : 前払い
    mileage : ポイント
    deposit : 預り金
    etc : その他

    payment_gateway_name

    決済代行サービス名

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

    market_seller_id

    ECサイト販売者ID

    discount_method

    割引タイプ

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

    point：ポイント
    credit：預り金
    coupon：クーポン
    market_discount：モール型ECサイト割引
    discount_code：割引コード

    discount_code

    割引コード

    carrier_id

    Min : [1]

    配送会社ID

    Request Copy
    Response Copy

    Get an order

    GET /api/v2/admin/orders/{order_id}

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    items
    embed

    品目別注文エンティティ


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

    receivers
    embed

    受取人情報エンティティ


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

    buyer
    embed

    注文者情報のリソース


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

    benefits
    embed

    特典リソース


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

    coupons
    embed

    クーポンリソース


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

    return
    embed

    返品詳細リソース


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

    cancellation
    embed

    キャンセル詳細リソース


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

    exchange
    embed

    交換詳細リソース


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

    refunds
    embed

    返金詳細リソース


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

    Request Copy
    Response Copy

    Update an order

    PUT /api/v2/admin/orders/{order_id}

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    process_status
    Required

    注文ステータス

    prepare：発送準備中
    prepareproduct：商品準備中
    hold：配送保留
    unhold：配送保留解除

    order_item_code

    品目別注文コード

    Request Copy
    Response Copy

    Update orders

    PUT /api/v2/admin/orders

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 100

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    process_status
    Required

    注文ステータス

    prepare：発送準備中
    prepareproduct：商品準備中
    hold：配送保留
    unhold：配送保留解除

    order_item_code

    品目別注文コード

    Request Copy
    Response Copy

    Orders autocalculation

    Endpoints 
    DELETE /api/v2/admin/orders/{order_id}/autocalculation

    Orders autocalculation properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1
    order_id

    注文番号

    Delete an orders autocalculation

    DELETE /api/v2/admin/orders/{order_id}/autocalculation

    DELETE

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    Request Copy
    Response Copy

    Orders benefits

    Endpoints 
    GET /api/v2/admin/orders/benefits

    Orders benefits properties

    Attribute Description
    shop_no

    ショップ番号
    order_id

    注文番号
    order_item_code

    品目別注文コード
    benefit_title

    特典タイプ
    benefit_name

    特典名
    benefit_code

    特典コード
    benefit_percent

    特典割合
    benefit_value

    特典金額

    List all orders benefits

    GET /api/v2/admin/orders/benefits

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

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

    limit

    Min : [1]~Max : [500]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Orders buyer

    「Buyer」は、注文者の名前、連絡先、住所などを表示します。 購入者情報はサブリソースであるため、「Order」の以下で使用可能です。

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/buyer
PUT /api/v2/admin/orders/{order_id}/buyer

    Orders buyer properties

    Attribute Description
    shop_no

    ショップ番号

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

    会員ID
    member_group_no

    注文当時の注文者の会員ランク番号
    name

    注文者名
    names_furigana

    注文者名のふりがな
    email

    注文者のメールアドレス

    会員のメールアドレス
    phone

    注文者の固定電話番号
    cellphone

    注文者の電話番号(携帯)
    customer_notification

    お客様へのお知らせ

    お客様へのお知らせ
    updated_date

    timezone

    修正日
    user_id

    注文者を変更した人のID

    注文者情報を修正した人のID
    user_name

    注文者を変更した人の名前

    注文者情報を修正した人の名前
    order_id

    Order ID

    注文番号

    Get an orders buyer

    GET /api/v2/admin/orders/{order_id}/buyer

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    Request Copy
    Response Copy

    Update an orders buyer

    PUT /api/v2/admin/orders/{order_id}/buyer

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    name

    注文者名

    email

    Email

    注文者のメールアドレス

    会員のメールアドレス

    phone

    注文者の固定電話番号

    cellphone

    注文者の電話番号(携帯)

    customer_notification

    お客様へのお知らせ

    お客様へのお知らせ

    Request Copy
    Response Copy

    Orders buyer history

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/buyer/history

    Orders buyer history properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号
    name

    注文者名
    email

    Email

    注文者のメールアドレス
    phone

    注文者の固定電話番号
    cellphone

    注文者の電話番号(携帯)
    customer_notification

    お客様へのお知らせ
    updated_date

    timezone

    修正日
    user_id

    注文者を変更した人のID
    user_name

    注文者を変更した人の名前

    List all orders buyer history

    GET /api/v2/admin/orders/{order_id}/buyer/history

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    Request Copy
    Response Copy

    Orders cancellation

    Endpoints 
    POST /api/v2/admin/orders/{order_id}/cancellation
PUT /api/v2/admin/orders/{order_id}/cancellation/{claim_code}

    Orders cancellation properties

    Attribute Description
    shop_no

    ショップ番号
    order_id

    注文番号
    status

    注文ステータス

    canceled:キャンセル完了
    claim_code

    キャンセル番号
    items

    品目別注文コード
    recover_inventory

    在庫の回復

    T : 復元する
    F : 復元しない
    undone

    取消しの有無

    T：取り消す
    F：取り消さない
    add_memo_too

    運営者メモに追加する

    T：使用する
    F：使用しない
    undone_reason_type

    取消し理由の区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他
    undone_reason

    取消しの理由
    expose_order_detail

    注文詳細の表示設定

    T：表示する
    F：表示しない
    exposed_undone_reason

    注文詳細に表示される取消しの理由

    Create an orders cancellation

    POST /api/v2/admin/orders/{order_id}/cancellation

    POST

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    payment_gateway_cancel

    決済代行会社の注文キャンセルを申込むかどうか

    T : キャンセルする
    F : キャンセルしない

    DEFAULT F

    status
    Required

    注文ステータス

    canceled:キャンセル完了

    recover_inventory

    在庫の回復

    T : 復元する
    F : 復元しない

    DEFAULT F

    recover_coupon

    クーポン復元

    T : 復元する
    F : 復元しない

    DEFAULT F

    add_memo_too

    運営者メモに追加する

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

    DEFAULT F

    reason

    Max Length : [2000]

    キャンセル理由

    claim_reason_type

    キャンセル理由の区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他

    naverpay_cancel_reason_type

    Naver Payで注文した件のキャンセル理由の区分

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

    51 : 心変わり
    52 : カラーまたはサイズ変更
    53 : 誤注文
    54 : サービス・商品への不満
    55 : 配送遅延
    56 : 在庫切れ
    60 : 商品情報との不一致

    refund_method_code

    返金方式

    T : 現金
    F : クレジットカード
    M : ポイント
    G : 口座振込
    C : キャリア決済
    D : 預り金
    Z : 後払い
    O : 前払金
    I : コンビニ
    V : その他

    combined_refund_method

    複合 返金 方式

    T : 現金
    M : ポイント
    D : 預り金

    refund_bank_code

    返金先の銀行コード

    refund_bank_name

    Max Length : [250]

    返金先の銀行名

    refund_bank_account_no

    Max Length : [50]

    返金の口座番号

    refund_bank_account_holder

    Max Length : [15]

    返金先の口座名義

    items

    品目別注文コード

    order_item_code
    品目別注文コード
    Required

    quantity
    数量
    Required
    Request Copy
    Response Copy

    Update an orders cancellation

    PUT /api/v2/admin/orders/{order_id}/cancellation/{claim_code}

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    claim_code
    Required

    キャンセル番号

    recover_inventory
    Required

    在庫の回復

    T : 復元する
    F : 復元しない

    undone
    Required

    取消しの有無

    T : 철회함

    add_memo_too
    Required

    運営者メモに追加する

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

    undone_reason_type
    Required

    取消し理由の区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他

    undone_reason

    Max Length : [2000]

    取消しの理由

    expose_order_detail
    Required

    注文詳細の表示設定

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

    exposed_undone_reason

    Max Length : [2000]

    注文詳細に表示される取消しの理由

    Request Copy
    Response Copy

    Orders coupons

    Endpoints 
    GET /api/v2/admin/orders/coupons

    Orders coupons properties

    Attribute Description
    shop_no

    ショップ番号
    order_id

    注文番号
    order_item_code

    品目別注文コード
    coupon_name

    クーポン名
    coupon_code

    クーポンID
    coupon_percent

    クーポン割合
    coupon_value

    クーポン金額

    List all orders coupons

    GET /api/v2/admin/orders/coupons

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

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

    limit

    Min : [1]~Max : [500]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Orders inflowgroups

    Endpoints 
    GET /api/v2/admin/orders/inflowgroups
POST /api/v2/admin/orders/inflowgroups
PUT /api/v2/admin/orders/inflowgroups/{inflow_group_id}
DELETE /api/v2/admin/orders/inflowgroups/{inflow_group_id}

    Orders inflowgroups properties

    Attribute Description
    inflow_group_id

    アクセスルートのサイトID
    inflow_group_name

    アクセスルートのサイト名

    List all orders inflowgroups

    GET /api/v2/admin/orders/inflowgroups

    GET

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40
    Request Copy
    Response Copy

    Create an orders inflowgroup

    POST /api/v2/admin/orders/inflowgroups

    POST

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    inflow_group_id
    Required

    Max Length : [40]
    Type : [a-zA-Z0-9]

    アクセスルートのサイトID

    inflow_group_name
    Required

    Max Length : [100]

    アクセスルートのサイト名

    Request Copy
    Response Copy

    Update an orders inflowgroup

    PUT /api/v2/admin/orders/inflowgroups/{inflow_group_id}

    PUT

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    inflow_group_id
    Required

    Type : [a-zA-Z0-9]
    Max Length : [40]

    アクセスルートのサイトID

    inflow_group_name
    Required

    Max Length : [100]

    アクセスルートのサイト名

    Request Copy
    Response Copy

    Delete an orders inflowgroup

    DELETE /api/v2/admin/orders/inflowgroups/{inflow_group_id}

    DELETE

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    inflow_group_id
    Required

    Max Length : [40]
    Type : [a-zA-Z0-9]

    アクセスルートのサイトID

    Request Copy
    Response Copy

    Orders inflowgroups inflows

    Endpoints 
    GET /api/v2/admin/orders/inflowgroups/{group_id}/inflows
POST /api/v2/admin/orders/inflowgroups/{group_id}/inflows
PUT /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}
DELETE /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}

    Orders inflowgroups inflows properties

    Attribute Description
    inflow_id

    アクセスルートのサービスーID
    inflow_name

    アクセスルートのサービス名
    inflow_icon

    アクセスルートアイコン
    group_id

    アクセスルートのサイトID

    List all orders inflowgroups inflows

    GET /api/v2/admin/orders/inflowgroups/{group_id}/inflows

    GET

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    group_id
    Required

    Max Length : [40]

    アクセスルートのサイトID

    Request Copy
    Response Copy

    Create an orders inflowgroups inflow

    POST /api/v2/admin/orders/inflowgroups/{group_id}/inflows

    POST

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    group_id
    Required

    Max Length : [40]

    アクセスルートのサイトID

    inflow_id
    Required

    Max Length : [40]

    アクセスルートのサービスーID

    inflow_name
    Required

    Max Length : [100]

    アクセスルートのサービス名

    inflow_icon
    Required

    URL
    Max Length : [500]

    アクセスルートアイコン

    Request Copy
    Response Copy

    Update an orders inflowgroups inflow

    PUT /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}

    PUT

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    group_id
    Required

    Max Length : [40]

    アクセスルートのサイトID

    inflow_id
    Required

    Max Length : [40]

    アクセスルートのサービスーID

    inflow_name
    Required

    Max Length : [100]

    アクセスルートのサービス名

    inflow_icon
    Required

    URL
    Max Length : [500]

    アクセスルートアイコン

    Request Copy
    Response Copy

    Delete an orders inflowgroups inflow

    DELETE /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}

    DELETE

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    group_id
    Required

    Max Length : [40]

    アクセスルートのサイトID

    inflow_id
    Required

    Max Length : [40]

    アクセスルートのサービスーID

    Request Copy
    Response Copy

    Orders items

    品目別注文(Items)はショップの顧客が注文時に購入した品目の情報です。ショップの品目はショップで販売する商品の基本単位で、品目別注文では購入した商品の品目情報と共に購入時に選択したオプション、注文数量などの情報を追加で確認することができます。
    品目別注文番号は下位 Resourceで、注文(Order)の下位でしか使えません。

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/items
PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}

    Orders items properties

    Attribute Description
    shop_no

    ショップ番号
    item_no

    品目別注文ID

    品目別注文番号のID
    order_item_code

    品目別注文コード

    品目別注文番号のコード
    variant_code

    品目コード

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

    商品番号

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

    商品コード

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

    Max Length : [40]

    独自商品コード
    custom_variant_code

    独自品目コード
    eng_product_name

    英語商品名

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

    商品オプションID

    商品オプションのID
    option_value

    オプション値

    注文した商品のオプション値
    option_value_default

    基本オプション値
    additional_option_value

    追加入力オプション値
    additional_option_values

    追加入力オプション一覧
    product_name

    商品名

    商品の名前。商品名は商品を区分する一番基礎的な情報で、検索情報になる。
    product_name_default

    基本商品名
    product_price

    商品販売価格

    商品の販売価格。マルチショップを運営する場合には販売価格をショッピング別通貨単位で換算して表示
    option_price

    オプション追加価格

    オプション別に追加価格がある場合、その追加価格
    additional_discount_price

    商品追加割引金額

    商品に対する追加割引金額
    coupon_discount_price

    商品別のクーポンによる割引金額
    app_item_discount_amount

    アプリによる商品割引金額
    actual_payment_amount

    実際の決済金額(品目別)
    quantity

    数量

    注文した商品の数量
    product_tax_type

    商品の税金区分

    A : 課税
    B : 免税
    C : 非課税
    tax_amount

    税率
    supplier_product_name

    供給会社の商品名

    供給会社の商品名
    supplier_transaction_type

    供給会社の取引タイプ

    供給会社の取引タイプ

    D:直接登録型
    P:手数料型
    supplier_id

    供給会社のID

    供給会社のID
    supplier_name

    供給会社名

    供給会社の名前
    tracking_no

    送り状番号
    shipping_code

    配送番号

    配送番号。品目別注文番号を配送準備中に処理すると、システムにより自動的に付与される番号
    claim_code

    キャンセル/交換/返品番号
    claim_reason_type

    キャンセル/交換/返品の申込理由のタイプ

    購入者のキャンセル/交換/返品の申込み理由の区分
    販売者の受付理由は、各キャンセル/交換/返品リソースの「claim_reason_type」で照会できます。
    claim_reason

    キャンセル/交換/返品の理由

    購入者のキャンセル/交換/返品の申込み理由の詳細
    購入者の申込み理由は、各キャンセル/交換/返品リソースの「claim_reason」で照会できます。
    refund_bank_name

    返金先の銀行名
    refund_bank_account_no

    返金の口座番号
    refund_bank_account_holder

    返金先の口座名義
    post_express_flag

    ゆうパック連動

    ゆうパック連動ステータス
    order_status

    注文ステータス

    注文ステータス。注文ステータス別にそれぞれのコードがある。
    request_undone

    取消ステータス

    Cancellation：キャンセル取消し
    Exchange：交換取消し
    Return：返品取消し
    order_status_additional_info

    注文ステータスの追加情報

    注文ステータスの追加情報
    claim_quantity

    キャンセル/交換/返品の申込数量
    status_code

    現在の処理ステータスコード

    現在の処理ステータスのコード

    N1:正常
    N2:交換商品
    C1:入金前のキャンセル
    C2:配送前のキャンセル
    C3:返品
    E1:交換
    status_text

    現在の処理ステータス

    現在の処理ステータスに関する説明
    open_market_status

    モール型ECサイト連動ステータス値
    bundled_shipping_type

    まとめて配送のタイプ

    配送対象の注文に対してまとめて配送するタイプ

    N:単一注文の一般配送(Normal)
    C :複合注文のまとめて配送(Combination)
    shipping_company_id

    配送会社ID

    配送会社のID
    shipping_company_name

    配送会社名

    配送会社の名前
    shipping_company_code

    配送会社コード

    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:分離履歴ある
    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

    送料タイプ

    送料タイプの説明
    shipping_payment_option

    前払い/着払いの区分

    C：着払い
    P：前払い
    F：無料
    payment_info_id

    決済情報ID
    original_item_no

    既存の品目別注文ID
    store_pickup

    店舗受取の設定

    実店舗で受け取る商品かどうかを設定

    T:店舗にて受取り
    F:店舗にて受取りではない
    ordered_date

    timezone

    注文日
    shipped_date

    timezone

    配送開始日

    配送開始日
    delivered_date

    timezone

    配送完了日

    配送完了日
    cancel_date

    timezone

    注文キャンセル日

    注文のキャンセル日
    return_confirmed_date

    timezone

    返品承認日時
    return_request_date

    timezone

    返品申込日

    返品申込日
    return_collected_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

    海外通関コード

    clearance_category_code

    hs_code

    HSコード

    通関のためのHSコード
    one_plus_n_event

    1+Nイベントの有無

    1個購入時にN個を提供するイベントの設定
    origin_place

    原産国情報

    商品の原産国
    origin_place_no

    原産国コード
    made_in_code

    国名(原産国)コード
    gift

    ノベルティであるかどうか

    商品がプレミアムかどうかを設定

    T：ノベルティ
    F：ノベルティではない
    item_granting_gift

    ノベルティ贈呈条件となる品目の一覧
    subscription

    定期購入利用状況

    T : 利用中
    F : 非利用
    product_bundle_list

    セット商品一覧
    market_cancel_request

    ECサイトキャンセル申込み有無

    T : キャンセル申込みしたECサイト注文
    F : キャンセル申込みしていないECサイト注文
    market_cancel_request_quantity

    モール型ECサイトからのキャンセル申込数量
    market_fail_reason

    モール型ECサイトでの処理失敗の原因
    market_fail_reason_guide

    モール型ECサイトでの処理失敗の原因に対する説明
    market_custom_variant_code

    モール型ECサイト独自品目コード
    option_type

    オプション構成方式

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

    オプション
    order_id

    注文番号
    claim_type

    キャンセル/交換/返品のタイプ
    claim_status

    キャンセル/交換/返品の申込み状態

    List all orders items

    GET /api/v2/admin/orders/{order_id}/items

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    Request Copy
    Response Copy

    Update an orders item

    PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    order_item_code
    Required

    品目別注文コード

    claim_type
    Required

    キャンセル/交換/返品のタイプ

    C : キャンセル
    R : 返品

    claim_status
    Required

    キャンセル/交換/返品の申込み状態

    T : 申し込む
    F : 申し込まない

    claim_reason_type
    Required

    キャンセル/交換/返品の申込理由のタイプ

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他

    claim_reason

    キャンセル/交換/返品の理由

    claim_quantity

    キャンセル/交換/返品の申込数量

    Request Copy
    Response Copy

    Orders memos

    Endpoints 
    GET /api/v2/admin/orders/memos
GET /api/v2/admin/orders/{order_id}/memos
POST /api/v2/admin/orders/{order_id}/memos
PUT /api/v2/admin/orders/{order_id}/memos/{memo_no}
DELETE /api/v2/admin/orders/{order_id}/memos/{memo_no}

    Orders memos properties

    Attribute Description
    shop_no

    ショップ番号
    memo_no

    メモ番号
    order_id

    注文番号
    created_date

    timezone

    メモ登録日
    author_id

    作成者ID
    ip

    作成者IP
    use_customer_inquiry

    お問い合わせに対する回答の同時登録の使用状態

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

    登録基準

    O：注文別
    P：品目別
    content

    メモ内容
    starred_memo

    重要メモの有無

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

    上部に固定する機能の使用状態

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

    商品リスト
    topic_type

    お問い合わせカテゴリ

    cs_01 : 配送に関するお問い合わせ
    cs_02 : 商品に関するお問い合わせ
    cs_03 : 決済に関するお問い合わせ
    cs_04 : 注文キャンセル
    cs_05 : 商品変更
    status

    お問い合わせ対応の結果

    F：処理中
    T：処理完了

    List all orders memos (multiple orders)

    GET /api/v2/admin/orders/memos

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

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

    limit

    Min : [1]~Max : [500]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    List all orders memos

    GET /api/v2/admin/orders/{order_id}/memos

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    Request Copy
    Response Copy

    Create an orders memo

    POST /api/v2/admin/orders/{order_id}/memos

    POST

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    content
    Required

    Max Length : [1000]

    メモ内容

    use_customer_inquiry

    お問い合わせに対する回答の同時登録の使用状態

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

    DEFAULT F

    topic_type

    お問い合わせカテゴリ

    cs_01 : 配送に関するお問い合わせ
    cs_02 : 商品に関するお問い合わせ
    cs_03 : 決済に関するお問い合わせ
    cs_04 : 注文キャンセル
    cs_05 : 商品変更

    status

    お問い合わせ対応の結果

    F：処理中
    T：処理完了

    attach_type

    登録基準

    O：注文別
    P：品目別

    DEFAULT O

    starred_memo

    重要メモの有無

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

    DEFAULT F

    fixed

    上部に固定する機能の使用状態

    T:使用する
    F:使用しない

    DEFAULT F

    product_list

    商品リスト

    Request Copy
    Response Copy

    Update an orders memo

    PUT /api/v2/admin/orders/{order_id}/memos/{memo_no}

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    memo_no
    Required

    メモ番号

    content

    Max Length : [1000]

    メモ内容

    use_customer_inquiry

    お問い合わせに対する回答の同時登録の使用状態

    T:使用する
    F:使用しない

    DEFAULT F

    topic_type

    お問い合わせカテゴリ

    cs_01 : 配送に関するお問い合わせ
    cs_02 : 商品に関するお問い合わせ
    cs_03 : 決済に関するお問い合わせ
    cs_04 : 注文キャンセル
    cs_05 : 商品変更

    status

    お問い合わせ対応の結果

    F：処理中
    T：処理完了

    attach_type

    登録基準

    O：注文別
    P：品目別

    DEFAULT O

    starred_memo

    重要メモの有無

    T:重要メモ
    F:一般メモ

    DEFAULT F

    fixed

    上部に固定する機能の使用状態

    T:使用する
    F:使用しない

    DEFAULT F

    product_list

    商品リスト

    Request Copy
    Response Copy

    Delete an orders memo

    DELETE /api/v2/admin/orders/{order_id}/memos/{memo_no}

    DELETE

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    memo_no
    Required

    メモ番号

    Request Copy
    Response Copy

    Orders paymentamount

    Endpoints 
    GET /api/v2/admin/orders/paymentamount

    Orders paymentamount properties

    Attribute Description
    shop_no

    ショップ番号
    order_item_code

    品目別注文コード
    items

    品目情報
    order_price_amount

    商品購入金額
    order_discount_amount

    注文割引金額
    item_discount_amount

    商品割引金額
    additional_payment_amount

    併用決済金額
    actual_payment_amount

    実際の決済金額(品目別)

    List all orders paymentamount

    GET /api/v2/admin/orders/paymentamount

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_item_code
    Required

    品目別注文コード

    ,(コンマ)で複数の件を検索することができる。

    Request Copy
    Response Copy

    Orders payments

    Endpoints 
    PUT /api/v2/admin/orders/{order_id}/payments

    Orders payments properties

    Attribute Description
    shop_no

    ショップ番号
    order_id

    注文番号
    change_payment_amount

    決済金額変更の有無

    T:使用する
    F:使用しない
    change_payment_method

    決済方法変更の有無

    T:使用する
    F:使用しない
    payment_method

    決済方法
    payment_gateway_failure_message

    決済代行会社の決済キャンセルエラーメッセージ
    admin_additional_amount

    運営者入力金額
    commission

    決済手数料
    initial_estimated_payment_amount

    初期決済予定金額
    change_payment_amount_reason

    決済金額変更の理由

    Update an orders payment

    PUT /api/v2/admin/orders/{order_id}/payments

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    change_payment_amount
    Required

    決済金額変更の有無

    T:使用する
    F:使用しない

    change_payment_method
    Required

    決済方法変更の有無

    T:使用する
    F:使用しない

    payment_method

    決済方法

    cash：銀行振込
    daibiki：代金引換

    billing_name

    Max Length : [40]

    入金者名

    bank_account_id

    振込銀行のID

    admin_additional_amount

    Min : [0]
    Max : [10000000]

    運営者入力金額

    commission

    Min : [0]
    Max : [10000000]

    決済手数料

    change_payment_amount_reason

    Max Length : [255]

    決済金額変更の理由

    Request Copy
    Response Copy

    Orders paymenttimeline

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/paymenttimeline
GET /api/v2/admin/orders/{order_id}/paymenttimeline/{payment_no}

    Orders paymenttimeline properties

    Attribute Description
    shop_no

    ショップ番号
    payment_no

    決済番号
    payment_settle_type

    決済タイプ

    O：最初決済
    R：追加決済
    P：返金
    order_amount

    注文金額
    additional_payment_amount

    併用決済金額
    paid_amount

    決済金額
    payment_methods

    決済方法
    payment_datetime

    timezone

    決済日
    created_datetime

    timezone

    入力日
    payment_method_detail

    決済方法別の決済金額

    payment_method_detail code

    詳細照会を行う際にのみ確認できる。
    order_amount_detail

    注文金額の詳細

    order_amount_detail code

    詳細照会を行う際にのみ確認できる。

    List all orders paymenttimeline

    GET /api/v2/admin/orders/{order_id}/paymenttimeline

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    start_date

    Date
    timezone

    検索開始日

    end_date

    Date
    timezone

    検索終了日

    date_type

    検索日付のタイプ

    created_datetime：入力日
    payment_datetime：決済日

    Request Copy
    Response Copy

    Get an orders paymenttimeline

    GET /api/v2/admin/orders/{order_id}/paymenttimeline/{payment_no}

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    payment_no
    Required

    Min : [1]

    決済番号

    Request Copy
    Response Copy

    Orders receivers

    受取人情報(Receivers)は注文した商品を受け取る人の名前、連絡先、住所情報です。
    受取人情報は下位Resourceで、注文(Order)の下位でしか使えません。

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/receivers
PUT /api/v2/admin/orders/{order_id}/receivers
PUT /api/v2/admin/orders/{order_id}/receivers/{shipping_code}

    Orders receivers properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1
    name

    受取人名
    name_furigana

    受取人名(フリガナ)
    phone

    電話番号
    cellphone

    受取人の電話番号(携帯)
    virtual_phone_no

    受取人の安心番号
    zipcode

    郵便番号
    address1

    基本住所
    address2

    詳細住所
    address_state

    都道府県
    address_city

    市区町村
    address_street

    道路名
    address_full

    アドレス
    name_en

    受取人名(ローマ字)
    city_en

    受取人の都市(ローマ字)
    state_en

    受取人の住所(ローマ字)
    street_en

    受取人の住所 (ローマ字)
    country_code

    国コード
    country_name

    国名
    country_name_en

    国名(ローマ字)
    shipping_message

    配送メッセージ
    clearance_information_type

    通関情報タイプ

    I：身分証明書(ID)番号
    P：パスポート番号
    C：個人通関固有符号
    clearance_information

    通関情報
    wished_delivery_date

    配送希望日
    wished_delivery_time

    配達希望時間
    shipping_code

    配送番号
    change_default_shipping_address

    基本お届け先の変更有無

    T：変更する
    F：変更しない

    List all orders receivers

    GET /api/v2/admin/orders/{order_id}/receivers

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    shipping_code

    配送番号

    ,(コンマ)で複数の件を検索することができる。

    Request Copy
    Response Copy

    Update orders receivers

    PUT /api/v2/admin/orders/{order_id}/receivers

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 100

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    name

    Max Length : [20]

    受取人名

    phone

    Max Length : [20]

    受取人の電話番号(固定)

    cellphone

    Max Length : [20]

    受取人の電話番号(携帯)

    shipping_message

    配送メッセージ

    name_furigana

    受取人名(フリガナ)

    zipcode

    Min Length : [2]
    Max Length : [14]

    郵便番号

    address1

    Max Length : [255]

    基本住所

    address2

    Max Length : [255]

    詳細住所

    address_state

    都道府県

    address_city

    市区町村

    name_en

    受取人名(ローマ字)

    city_en

    受取人の都市(ローマ字)

    state_en

    受取人の住所(ローマ字)

    street_en

    受取人の住所 (ローマ字)

    country_code

    国コード

    clearance_information_type

    通関情報タイプ

    I：身分証明書(ID)番号
    P：パスポート番号
    C：個人通関固有符号

    clearance_information

    通関情報

    shipping_code

    配送番号

    change_default_shipping_address

    基本お届け先の変更有無

    T：変更する
    F：変更しない

    DEFAULT F

    virtual_phone_no

    受取人の安心番号

    Request Copy
    Response Copy

    Update an orders receiver

    PUT /api/v2/admin/orders/{order_id}/receivers/{shipping_code}

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    shipping_code
    Required

    配送番号

    name

    Max Length : [20]

    受取人名

    phone

    Max Length : [20]

    受取人の電話番号(固定)

    cellphone

    Max Length : [20]

    受取人の電話番号(携帯)

    shipping_message

    配送メッセージ

    name_furigana

    受取人名(フリガナ)

    zipcode

    Min Length : [2]
    Max Length : [14]

    郵便番号

    address1

    Max Length : [255]

    基本住所

    address2

    Max Length : [255]

    詳細住所

    address_state

    都道府県

    address_city

    市区町村

    name_en

    受取人名(ローマ字)

    city_en

    受取人の都市(ローマ字)

    state_en

    受取人の住所(ローマ字)

    street_en

    受取人の住所 (ローマ字)

    country_code

    国コード

    clearance_information_type

    通関情報タイプ

    I：身分証明書(ID)番号
    P：パスポート番号
    C：個人通関固有符号

    clearance_information

    通関情報

    change_default_shipping_address

    基本お届け先の変更有無

    T：変更する
    F：変更しない

    DEFAULT F

    virtual_phone_no

    受取人の安心番号

    Request Copy
    Response Copy

    Orders receivers history

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/receivers/history

    Orders receivers history properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号
    name

    受取人名
    phone

    電話番号
    cellphone

    受取人の電話番号(携帯)
    zipcode

    郵便番号
    address1

    基本住所
    address2

    詳細住所
    address_state

    都道府県
    address_city

    市区町村
    address_street

    道路名
    address_full

    アドレス
    name_en

    受取人名(ローマ字)
    city_en

    受取人の都市(ローマ字)
    state_en

    受取人の住所(ローマ字)
    street_en

    受取人の住所 (ローマ字)
    country_code

    国コード
    country_name

    国名
    country_name_en

    国名(ローマ字)
    shipping_message

    配送メッセージ
    updated_date

    timezone

    修正日
    user_id

    注文者を変更した人のID
    user_name

    注文者を変更した人の名前
    shipping_code

    配送番号

    List all orders receivers history

    GET /api/v2/admin/orders/{order_id}/receivers/history

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    Request Copy
    Response Copy

    Orders return

    Endpoints 
    POST /api/v2/admin/orders/{order_id}/return

    Orders return properties

    Attribute Description
    shop_no

    ショップ番号
    order_id

    注文番号
    status

    注文ステータス

    canceled:キャンセル完了
    claim_code

    キャンセル番号
    items

    品目別注文コード

    Create an orders return

    POST /api/v2/admin/orders/{order_id}/return

    POST

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    payment_gateway_cancel

    決済代行会社の注文キャンセルを申込むかどうか

    T : キャンセルする
    F : キャンセルしない

    DEFAULT F

    status
    Required

    注文ステータス

    returned : 返品完了

    recover_inventory

    在庫の回復

    T : 復元する
    F : 復元しない

    DEFAULT F

    recover_coupon

    クーポン復元

    T : 復元する
    F : 復元しない

    DEFAULT F

    add_memo_too

    運営者メモに追加する

    T：使用する
    F：使用しない

    DEFAULT F

    reason

    Max Length : [2000]

    返品理由

    claim_reason_type

    返品理由区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他

    naverpay_return_reason_type

    LIBSPECDATAPAY.ORDER.RETURN

    Cafe24管理画面(ベトナム, フィリピン, 日本) では使用できません。

    51：心変わり
    52：カラーまたはサイズ変更
    53：誤注文
    54：サービス・商品への不満
    55：配送遅延
    56：在庫切れ
    57：配送漏れ
    58：未配送
    59：商品破損
    60：商品情報との不一致
    61：配送ミス
    62：カラーなどのオプションが間違った商品が届く誤配送

    refund_method_code

    返金方式

    T : 現金
    F : クレジットカード
    M : ポイント
    G : 口座振込
    C : キャリア決済
    D : 預り金
    Z : 後払い
    O : 前払金
    I : コンビニ
    V : その他

    combined_refund_method

    複合 返金 方式

    T : 現金
    M : ポイント
    D : 預り金

    refund_bank_code

    返金先の銀行コード

    refund_bank_name

    Max Length : [250]

    返金先の銀行名

    refund_bank_account_no

    Max Length : [50]

    返金の口座番号

    refund_bank_account_holder

    Max Length : [15]

    返金先の口座名義

    items

    品目別注文コード

    order_item_code
    品目別注文コード
    Required

    quantity
    数量
    Required
    Request Copy
    Response Copy

    Orders saleschannels

    Endpoints 
    GET /api/v2/admin/orders/saleschannels
POST /api/v2/admin/orders/saleschannels
PUT /api/v2/admin/orders/saleschannels/{sales_channel_id}
DELETE /api/v2/admin/orders/saleschannels/{sales_channel_id}

    Orders saleschannels properties

    Attribute Description
    sales_channel_id

    販売先ID
    sales_channel_name

    販売先名
    sales_channel_icon

    販売先のアイコン

    List all orders saleschannels

    GET /api/v2/admin/orders/saleschannels

    GET

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    limit

    Min : [1]~Max : [500]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [10000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Create an orders saleschannel

    POST /api/v2/admin/orders/saleschannels

    POST

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    sales_channel_id
    Required

    Max Length : [40]
    Type : [a-zA-Z0-9]

    販売先ID

    sales_channel_name
    Required

    Max Length : [100]

    販売先名

    sales_channel_icon
    Required

    URL
    Max Length : [500]

    販売先のアイコン

    Request Copy
    Response Copy

    Update an orders saleschannel

    PUT /api/v2/admin/orders/saleschannels/{sales_channel_id}

    PUT

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    sales_channel_id
    Required

    Max Length : [40]
    Type : [a-zA-Z0-9]

    販売先ID

    sales_channel_name

    Max Length : [100]

    販売先名

    sales_channel_icon

    URL

    販売先のアイコン

    Request Copy
    Response Copy

    Delete an orders saleschannel

    DELETE /api/v2/admin/orders/saleschannels/{sales_channel_id}

    DELETE

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    sales_channel_id
    Required

    Max Length : [40]
    Type : [a-zA-Z0-9]

    販売先ID

    Request Copy
    Response Copy

    Orders shipments

    「Shipments」は、注文の配送処理をするために必要な配送情報を意味します。 注文の配送情報には送り状番号や配送会社の情報、配送ステータスなどがあります。

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/shipments
POST /api/v2/admin/orders/{order_id}/shipments
PUT /api/v2/admin/orders/{order_id}/shipments/{shipping_code}
DELETE /api/v2/admin/orders/{order_id}/shipments/{shipping_code}

    Orders shipments properties

    Attribute Description
    shop_no

    ショップ番号

    DEFAULT 1
    shipping_code

    配送番号
    order_id

    注文番号
    tracking_no

    送り状番号
    tracking_no_updated_date

    timezone

    送り状情報の入力日
    shipping_company_code

    配送会社コード

    shipping_company_code
    items

    品目別注文一覧
    status

    注文ステータス

    standby : 配送待ち
    shipping : 配送中
    shipped : 配送完了
    order_item_code

    品目別注文コード
    status_additional_info

    注文ステータスの追加情報

    List all orders shipments

    GET /api/v2/admin/orders/{order_id}/shipments

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    Request Copy
    Response Copy

    Register shipments information

    POST /api/v2/admin/orders/{order_id}/shipments

    POST

    注文に配送情報を登録して注文を出荷待ち状態にしたり、配送中処理をすることができます。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    tracking_no
    Required

    Max Length : [30]

    送り状番号

    shipping_company_code
    Required

    配送会社コード

    shipping_company_code

    order_item_code

    品目別注文コード

    status
    Required

    注文ステータス

    standby : 配送待ち
    shipping : 配送中

    shipping_code

    配送番号

    Request Copy
    Response Copy

    Update orders shipment information

    PUT /api/v2/admin/orders/{order_id}/shipments/{shipping_code}

    PUT

    注文の配送情報(配送ステータスなど)を変更することができます。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    shipping_code
    Required

    配送番号

    status

    注文ステータス

    standby : 配送待ち
    shipping : 配送中
    shipped : 配送完了

    status_additional_info

    Max Length : [30]

    注文ステータスの追加情報

    tracking_no

    Max Length : [30]

    送り状番号

    shipping_company_code

    配送会社コード

    Request Copy
    Response Copy

    Delete an orders shipment

    DELETE /api/v2/admin/orders/{order_id}/shipments/{shipping_code}

    DELETE

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    shipping_code
    Required

    配送番号

    Request Copy
    Response Copy

    Orders shippingfeecancellation

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/shippingfeecancellation
POST /api/v2/admin/orders/{order_id}/shippingfeecancellation

    Orders shippingfeecancellation properties

    Attribute Description
    shop_no

    ショップ番号
    order_id

    注文番号
    default_shipping_fee

    基本送料
    supplier_shipping_fee

    供給会社送料
    individual_shipping_fee

    個別送料
    international_shipping_fee

    해외배송비
    international_shipping_insurance_fee

    海外配送保険料
    additional_shipping_fee

    追加送料
    additional_handling_fee

    海外配送付加金額
    regional_surcharge_amount

    地域別送料
    claim_code

    キャンセル番号
    claim_reason_type

    区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他
    claim_reason

    理由
    refund_method

    返金方式
    shipping_discount_amount

    送料割引のキャンセル金額
    coupon_discount_amount

    クーポン割引の
    キャンセル金額
    refund_amount

    返金額
    point_used

    使用済みポイントの返還額
    credit_used

    使用済み預り金の返還額
    mixed_refund_amount

    複合返金金額
    mixed_refund_methods

    複合 返金 方式
    status

    注文ステータス

    LIBSPECDATACANCELING.PROCESSING

    List all orders shippingfeecancellation

    GET /api/v2/admin/orders/{order_id}/shippingfeecancellation

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    Request Copy
    Response Copy

    Create an orders shippingfeecancellation

    POST /api/v2/admin/orders/{order_id}/shippingfeecancellation

    POST

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    reason

    Max Length : [2000]

    キャンセル理由

    claim_reason_type

    キャンセル理由の区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他

    recover_coupon

    クーポン復元

    T : 復元する
    F : 復元しない

    DEFAULT F

    refund_method_code

    返金方式

    T : 現金
    F : クレジットカード
    M : ポイント
    G : 口座振込
    C : キャリア決済
    D : 預り金
    Z : 後払い
    O : 前払金
    I : コンビニ
    V : その他

    combined_refund_method

    複合 返金 方式

    T : 現金
    M : ポイント
    D : 預り金

    refund_bank_code

    返金先の銀行コード

    refund_bank_name

    Max Length : [250]

    返金先の銀行名

    refund_bank_account_no

    Max Length : [50]

    返金の口座番号

    refund_bank_account_holder

    Max Length : [15]

    返金先の口座名義

    payment_gateway_cancel

    決済代行会社の注文キャンセルを申込むかどうか

    T : キャンセルする
    F : キャンセルしない

    DEFAULT F

    Request Copy
    Response Copy

    Orders shortagecancellation

    Endpoints 
    POST /api/v2/admin/orders/{order_id}/shortagecancellation

    Orders shortagecancellation properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号
    order_id

    注文番号
    status

    注文ステータス

    canceled:キャンセル完了
    claim_code

    キャンセル番号
    items

    品目別注文コード

    Create an orders shortagecancellation

    POST /api/v2/admin/orders/{order_id}/shortagecancellation

    POST

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    order_id
    Required

    注文番号

    payment_gateway_cancel

    決済代行会社の注文キャンセルを申込むかどうか

    T : キャンセルする
    F : キャンセルしない

    DEFAULT F

    keep_auto_calculation

    LIBSPECDATAWHETHER.PRESERVE.FLAG

    LIBSPECDATAPRESERVED.REMOVED

    DEFAULT F

    collect_gift

    ノベルティを自動回収するかどうかの有無

    T：使用する
    F：使用しない

    DEFAULT F

    status
    Required

    注文ステータス

    canceled:キャンセル完了

    recover_inventory

    在庫の回復

    T : 復元する
    F : 復元しない

    DEFAULT F

    recover_coupon

    クーポン復元

    T : 復元する
    F : 復元しない

    DEFAULT F

    add_memo_too

    運営者メモに追加する

    T：使用する
    F：使用しない

    DEFAULT F

    reason

    Max Length : [2000]

    キャンセル理由

    claim_reason_type

    キャンセル理由の区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他

    naverpay_cancel_reason_type

    Naver Payで注文した件のキャンセル理由の区分

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

    51 : 心変わり
    52 : カラーまたはサイズ変更
    53 : 誤注文
    54 : サービス・商品への不満
    55 : 配送遅延
    56 : 在庫切れ
    60 : 商品情報との不一致

    refund_method_code

    返金方式

    T : 現金
    F : クレジットカード
    M : ポイント
    G : 口座振込
    C : キャリア決済
    D : 預り金
    Z : 後払い
    O : 前払金
    I : コンビニ
    V : その他

    combined_refund_method

    複合 返金 方式

    T : 現金
    M : ポイント
    D : 預り金

    refund_bank_code

    返金先の銀行コード

    refund_bank_name

    Max Length : [250]

    返金先の銀行名

    refund_bank_account_no

    Max Length : [50]

    返金の口座番号

    refund_bank_account_holder

    Max Length : [15]

    返金先の口座名義

    items

    品目別注文コード

    order_item_code
    品目別注文コード
    Required

    quantity
    数量
    Required
    Request Copy
    Response Copy

    Payments

    Endpoints 
    PUT /api/v2/admin/payments

    Payments properties

    Attribute Description
    shop_no

    ショップ番号
    order_id

    注文番号
    status

    注文ステータス

    paid：入金確認
    unpaid：入金前
    canceled：決済キャンセル
    cancel_request

    決済キャンセル申込み情報

    Update payments

    PUT /api/v2/admin/payments

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    status
    Required

    決済ステータス

    paid：入金確認
    unpaid：入金前
    canceled：決済キャンセル

    recover_inventory

    在庫の回復

    T : 復元する
    F : 復元しない

    cancel_request

    決済キャンセル申込み情報

    refund_status
    返金処理ステータス
    DEFAULT F
    P：返金完了、F：返金失敗

    partial_cancel
    一部キャンセルであるかどうか
    DEFAULT F
    T：一部キャンセル、F：すべてキャンセル

    payment_gateway_name
    決済代行会社名

    payment_method
    決済方法コード

    card：クレジットカード、tcash：口座振込、icash：バーチャル口座、cell：キャリア決済、deferpay：後払い、cvs：コンビニ、easypay：簡単決済、fpayment：海外決済

    response_code
    決済代行会社のレスポンスコード

    response_message
    決済代行会社のレスポンスメッセージ
    Request Copy
    Response Copy

    Refunds

    Endpoints 
    GET /api/v2/admin/refunds
GET /api/v2/admin/refunds/{refund_code}

    Refunds properties

    Attribute Description
    shop_no

    ショップ番号
    member_email

    会員メールアドレス
    buyer_email

    注文者のメールアドレス
    order_date

    timezone

    注文日
    accepted_refund_date

    timezone

    返金受付日
    refund_date

    timezone

    返金完了日
    order_id

    注文番号
    refund_code

    返金番号
    order_item_code

    品目別注文コード一覧
    quantity

    数量
    actual_refund_amount

    実際の返金額
    used_points

    使用済みポイントの返還額
    used_credits

    使用済み預り金の返還額
    used_transferable_points

    使用済みの総合ポイント返金額
    currency

    通貨単位
    payment_methods

    決済方法

    cash : 銀行振込
    card : クレジットカード
    cell : キャリア決済
    tcash : 口座振込
    icash : バーチャル口座
    prepaid : 前払い
    credit : 預り金
    point : ポイント
    pointfy : 総合ポイント
    cvs : コンビニ
    cod : 後払い
    coupon : クーポン
    market_discount : モール型ECサイト割引
    etc : その他
    refund_payment_methods

    返金方法

    cash : 銀行振込
    card : クレジットカード
    cell : キャリア決済
    tcash : 口座振込
    prepaid : 前払い
    credit : 預り金
    point : ポイント
    pointfy : 総合ポイント
    cvs : コンビニ
    cod : 後払い
    etc : その他
    payment_gateway_cancel_status

    決済代行会社でのキャンセル状態

    F：キャンセル前
    M：一部キャンセル完了
    T：すべてキャンセル完了
    payment_gateway_cancel_date

    timezone

    決済代行会社でのキャンセル日付
    status

    返金ステータス

    T：返金完了
    F：返金前
    refund_methods

    返金方法
    refund_bank_name

    返金先の銀行名
    refund_bank_account_no

    返金の口座番号
    refund_bank_account_holder

    返金先の口座名義
    refund_point

    ポイント返還額

    詳細照会を行う際にのみ確認できる。
    refund_credit

    預り金の返還額

    詳細照会を行う際にのみ確認できる。
    refund_naver_point

    Naverポイント返還額

    詳細照会を行う際にのみ確認できる。
    refund_naver_cash

    Naverキャッシュ返還額

    詳細照会を行う際にのみ確認できる。
    refund_amount

    返金額

    詳細照会を行う際にのみ確認できる。
    product_price

    商品販売価格

    詳細照会を行う際にのみ確認できる。
    shipping_fee

    送料

    詳細照会を行う際にのみ確認できる。
    shipping_fee_discount_amount

    送料割引

    詳細照会を行う際にのみ確認できる。
    cod_fees

    後払い手数料

    詳細照会を行う際にのみ確認できる。
    foreign_shipping_additional_fee

    海外配送付加金額

    詳細照会を行う際にのみ確認できる。
    product_discount_amount

    商品別の割引金額

    詳細照会を行う際にのみ確認できる。
    member_group_discount_amount

    会員ランク割引金額

    詳細照会を行う際にのみ確認できる。
    app_item_discount_amount

    アプリによる商品割引金額

    詳細照会を行う際にのみ確認できる。
    app_discount_amount

    アプリによる注文割引金額

    詳細照会を行う際にのみ確認できる。
    coupon_discount_amount

    クーポン割引金額

    詳細照会を行う際にのみ確認できる。
    product_bundle_discount_amount

    セット商品割引金額

    詳細照会を行う際にのみ確認できる。
    points_spent_amount

    ポイント使用金額

    詳細照会を行う際にのみ確認できる。
    credits_spent_amount

    預り金の使用金額

    詳細照会を行う際にのみ確認できる。
    transferable_points_spent_amount

    総合ポイント使用金額

    詳細照会を行う際にのみ確認できる。
    naver_point

    Naverポイント

    詳細照会を行う際にのみ確認できる。
    naver_cash

    Naverキャッシュ

    詳細照会を行う際にのみ確認できる。
    additional_product_amount

    商品追加決済金額

    詳細照会を行う際にのみ確認できる。
    manually_input_amount

    運営者入力金額

    詳細照会を行う際にのみ確認できる。
    changed_refund_amount

    変更された返金額

    詳細照会を行う際にのみ確認できる。
    refund_manager

    返金担当者

    詳細照会を行う際にのみ確認できる。
    refund_reason

    返金理由

    詳細照会を行う際にのみ確認できる。
    send_sms

    返金処理後SMS送信の設定

    詳細照会を行う際にのみ確認できる。

    T : 送信する
    F : 送信しない
    send_mail

    返金処理後メール送信の設定

    詳細照会を行う際にのみ確認できる。

    T : 送信する
    F : 送信しない
    items

    品目別注文エンティティ


    Embedパラメーターを使って照会することができる。

    詳細照会を行う際にのみ確認できる。

    List all refunds

    GET /api/v2/admin/refunds

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    start_date
    Required

    Date
    timezone

    検索開始日

    end_date
    Required

    Date
    timezone

    検索終了日

    date_type

    検索日付のタイプ

    accepted_refund_date : 返金受付日
    refund_date : 返金完了日

    DEFAULT refund_date

    member_email

    会員メールアドレス

    buyer_email

    注文者のメールアドレス

    order_id

    Order ID

    注文番号

    ,(コンマ)で複数の件を検索することができる。

    limit

    Min : [1]~Max : [500]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Get a refund

    GET /api/v2/admin/refunds/{refund_code}

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    refund_code
    Required

    返金番号

    items
    embed

    品目別注文エンティティ


    Embedパラメーターを使って照会することができる。

    Request Copy
    Response Copy

    Return

    「Return」は、配送後に顧客が注文をキャンセルことを意味します。返品リソースは返品情報を照会したり、または返品を処理できます。

    返品リソースは返品の受付以降から完了までのステータスを照会できます。

    Endpoints 
    GET /api/v2/admin/return/{claim_code}
POST /api/v2/admin/return

    Return properties

    Attribute Description
    shop_no

    ショップ番号

    詳細照会を行う際にのみ確認できる。
    order_id

    注文番号

    詳細照会を行う際にのみ確認できる。
    claim_code

    キャンセル番号

    詳細照会を行う際にのみ確認できる。
    claim_reason_type

    区分

    販売者の返品受付理由の区分
    購入者の返品申込み理由は、[items(品目・注文) > claim_reason_type]で照会できます。

    詳細照会を行う際にのみ確認できる。

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他
    claim_reason

    理由

    販売者の返品受付理由の詳細
    購入者の返品申込み理由の詳細は、[items(品目・注文) > claim_reason]で照会できます。

    詳細照会を行う際にのみ確認できる。
    claim_due_date

    返品処理予定日

    詳細照会を行う際にのみ確認できる。
    return_address

    返品先の住所

    詳細照会を行う際にのみ確認できる。
    pickup

    受取人の住所

    詳細照会を行う際にのみ確認できる。
    return_invoice_no

    返品用送り状の送り状番号

    詳細照会を行う際にのみ確認できる。
    return_shipping_company_name

    返品に使用する配送会社名

    詳細照会を行う際にのみ確認できる。
    pickup_request_state

    回収申込みのステータス

    詳細照会を行う際にのみ確認できる。

    E：回収申込み前
    W：回収受付前
    S：回収受付待ち(送り状発行前)
    F：回収受付失敗
    T：回収受付完了(送り状発行完了)
    N：未集荷
    refund_method

    返金方式

    詳細照会を行う際にのみ確認できる。
    refund_reason

    備考

    詳細照会を行う際にのみ確認できる。
    order_price_amount

    商品購入金額

    詳細照会を行う際にのみ確認できる。
    refund_amount

    返金額

    詳細照会を行う際にのみ確認できる。
    shipping_fee

    送料

    詳細照会を行う際にのみ確認できる。
    return_ship_type

    返品送料の適用区分

    詳細照会を行う際にのみ確認できる。
    return_shipping_fee

    返品送料

    詳細照会を行う際にのみ確認できる。
    return_shipping_fee_detail

    返品送料詳細

    詳細照会を行う際にのみ確認できる。
    return_regional_shipping_fee

    地域別返品送料

    詳細照会を行う際にのみ確認できる。
    return_regional_surcharge_detail

    地域別返品送料の詳細

    詳細照会を行う際にのみ確認できる。
    defer_commission

    後払い手数料

    詳細照会を行う際にのみ確認できる。
    partner_discount_amount

    提携割引のキャンセル金額

    詳細照会を行う際にのみ確認できる。
    add_discount_amount

    商品別追加割引の
    キャンセル金額

    詳細照会を行う際にのみ確認できる。
    member_grade_discount_amount

    会員ランク割引の
    キャンセル金額

    詳細照会を行う際にのみ確認できる。
    shipping_discount_amount

    送料割引のキャンセル金額

    詳細照会を行う際にのみ確認できる。
    coupon_discount_amount

    クーポン割引の
    キャンセル金額

    詳細照会を行う際にのみ確認できる。
    point_used

    使用済みポイントの返還額

    詳細照会を行う際にのみ確認できる。
    credit_used

    使用済み預り金の返還額

    詳細照会を行う際にのみ確認できる。
    undone

    取消しの有無

    詳細照会を行う際にのみ確認できる。

    T：取り消す
    F：取り消さない
    undone_reason_type

    取消し理由の区分

    詳細照会を行う際にのみ確認できる。

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他
    undone_reason

    取消しの理由

    詳細照会を行う際にのみ確認できる。
    expose_order_detail

    注文詳細の表示設定

    詳細照会を行う際にのみ確認できる。

    T：表示する
    F：表示しない
    exposed_undone_reason

    注文詳細に表示される取消しの理由

    詳細照会を行う際にのみ確認できる。
    items

    品目別注文コード

    詳細照会を行う際にのみ確認できる。
    status

    注文ステータス

    canceled:キャンセル完了

    Get a return

    GET /api/v2/admin/return/{claim_code}

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    claim_code
    Required

    返品番号

    Request Copy
    Response Copy

    Create return

    POST /api/v2/admin/return

    POST

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 100

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    status
    Required

    注文ステータス

    returned : 返品完了

    recover_inventory

    在庫の回復

    T : 復元する
    F : 復元しない

    DEFAULT F

    recover_coupon

    クーポン復元

    T : 復元する
    F : 復元しない

    DEFAULT F

    add_memo_too

    運営者メモに追加する

    T：使用する
    F：使用しない

    DEFAULT F

    reason

    Max Length : [2000]

    返品理由

    claim_reason_type

    返品理由区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他

    naverpay_return_reason_type

    LIBSPECDATAPAY.ORDER.RETURN

    Cafe24管理画面(ベトナム, フィリピン, 日本) では使用できません。

    51：心変わり
    52：カラーまたはサイズ変更
    53：誤注文
    54：サービス・商品への不満
    55：配送遅延
    56：在庫切れ
    57：配送漏れ
    58：未配送
    59：商品破損
    60：商品情報との不一致
    61：配送ミス
    62：カラーなどのオプションが間違った商品が届く誤配送

    refund_method_code

    返金方式

    T : 現金
    F : クレジットカード
    M : ポイント
    G : 口座振込
    C : キャリア決済
    D : 預り金
    Z : 後払い
    O : 前払金
    I : コンビニ
    V : その他

    combined_refund_method

    複合 返金 方式

    T : 現金
    M : ポイント
    D : 預り金

    refund_bank_code

    返金先の銀行コード

    refund_bank_name

    Max Length : [250]

    返金先の銀行名

    refund_bank_account_no

    Max Length : [50]

    返金の口座番号

    refund_bank_account_holder

    Max Length : [15]

    返金先の口座名義

    items

    品目別注文コード

    order_item_code
    品目別注文コード
    Required

    quantity
    数量
    Required
    Request Copy
    Response Copy

    Shipments

    Endpoints 
    POST /api/v2/admin/shipments
PUT /api/v2/admin/shipments

    Shipments properties

    Attribute Description
    shop_no

    ショップ番号
    tracking_no

    送り状番号
    shipping_company_code

    配送会社コード

    shipping_company_code
    status

    注文ステータス

    standby : 配送待ち
    shipping : 配送中
    shipped : 配送完了
    order_id

    注文番号
    shipping_code

    配送番号
    order_item_code

    品目別注文コード
    status_additional_info

    注文ステータスの追加情報

    Create shipments

    POST /api/v2/admin/shipments

    POST

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 100

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    tracking_no
    Required

    Max Length : [30]

    送り状番号

    shipping_company_code
    Required

    配送会社コード

    shipping_company_code

    status
    Required

    注文ステータス

    standby : 配送待ち
    shipping : 配送中

    order_id

    注文番号

    shipping_code

    配送番号

    order_item_code

    品目別注文コード

    Request Copy
    Response Copy

    Update shipments

    PUT /api/v2/admin/shipments

    PUT

    注文の配送情報(配送ステータスなど)を変更することができます。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 100

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    shipping_code
    Required

    配送番号

    order_id

    注文番号

    status

    注文ステータス

    standby : 配送待ち
    shipping : 配送中
    shipped : 配送完了

    status_additional_info

    Max Length : [30]

    注文ステータスの追加情報

    tracking_no

    Max Length : [30]

    送り状番号

    shipping_company_code

    配送会社コード

    Request Copy
    Response Copy

    Customer

    Customergroups

    Endpoints 
    GET /api/v2/admin/customergroups
GET /api/v2/admin/customergroups/count
GET /api/v2/admin/customergroups/{group_no}

    Customergroups properties

    Attribute Description
    shop_no

    ショップ番号
    group_no

    会員ランク番号
    group_name

    会員ランク名
    group_description

    会員ランクに関する説明
    benefits_paymethod

    特典付与のための決済条件

    A：すべての決済
    B：現金決済(銀行振込)
    C：現金決済以外すべての決済
    buy_benefits

    特典設定

    F:特典なし
    D:購入金額割引
    M:ポイント付与
    P:割引適用/ポイント付与
    ship_benefits

    送料特典

    T:送料無料設定
    F:送料無料設定しない
    product_availability

    商品別割引の重複設定

    P:商品別価格割引のみ適用
    M:会員ランク別価格割引のみ適用
    A:両方適用
    discount_information

    購入金額の割引設定
    points_information

    ポイント付与設定
    mobile_discount_information

    モバイル購入の追加割引設定
    mobile_points_information

    モバイル購入の追加ポイント設定

    List all customergroups

    GET /api/v2/admin/customergroups

    GET

    基本スペック

    Property Description
    SCOPE 会員の閲覧権限 (mall.read_customer)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    group_no

    会員ランク番号

    ,(コンマ)で複数の件を検索することができる。

    group_name

    Max Length : [20]

    会員ランク名

    ,(コンマ)で複数の件を検索することができる。

    Request Copy
    Response Copy

    Count all customergroups

    GET /api/v2/admin/customergroups/count

    GET

    基本スペック

    Property Description
    SCOPE 会員の閲覧権限 (mall.read_customer)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    group_no

    会員ランク番号

    ,(コンマ)で複数の件を検索することができる。

    group_name

    Max Length : [20]

    会員ランク名

    ,(コンマ)で複数の件を検索することができる。

    Request Copy
    Response Copy

    Get a customergroup

    GET /api/v2/admin/customergroups/{group_no}

    GET

    基本スペック

    Property Description
    SCOPE 会員の閲覧権限 (mall.read_customer)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    group_no
    Required

    会員ランク番号

    システムにより会員ランクに付与された番号

    Request Copy
    Response Copy

    Customergroups customers

    Endpoints 
    POST /api/v2/admin/customergroups/{group_no}/customers

    Customergroups customers properties

    Attribute Description
    shop_no

    ショップ番号
    group_no

    会員ランク番号
    member_id

    会員ID
    fixed_group

    会員ランクの固定設定

    T：固定する
    F：固定しない

    Change groups of customers

    POST /api/v2/admin/customergroups/{group_no}/customers

    POST

    基本スペック

    Property Description
    SCOPE 会員の投稿権限 (mall.write_customer)
    呼び出し件数制限 40
    1回当たり申込件数の制限 200

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    group_no
    Required

    会員ランク番号

    member_id
    Required

    Max Length : [20]

    会員ID

    fixed_group

    会員ランクの固定設定

    T：固定する
    F：固定しない

    DEFAULT F

    Request Copy
    Response Copy

    Customers

    Customers Resource構造

    会員(Customers)はショップの商品を購入する顧客の中でショップのクーポン、ポイント、割引などの特典をもらうために登録した顧客です。会員を管理するためにショップの運営者は会員を特定会員ランクに分類したり特別会員に指定することができます。

    Endpoints 
    GET /api/v2/admin/customers

    Customers properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    member_id

    Max Length : [20]

    会員ID
    group_no

    会員ランク番号

    会員ランクの番号
    member_authentication

    会員認証の有無

    会員認証の設定。認証によって会員は4種類に区分される。認証会員を特別管理会員に設定する場合、その会員は一番最後に設定した特別管理会員として表示される。

    T:認証
    F:未認証
    B:特別管理会員
    J:14歳未満の会員
    use_blacklist

    要注意会員の設定

    要注意会員に設定。要注意会員の場合はそのタイプによって商品購入ブロックやログインブロック、または商品購入とログインを両方ブロックすることができる。

    T:設定する
    F:設定しない
    blacklist_type

    要注意会員のブロック設定

    要注意会員のタイプ。要注意会員のタイプによって商品購入ブロックやログインブロック、または商品購入とログインを両方ブロックすることができる。

    P:商品購入ブロック
    L:ログインブロック
    A:商品購入&ログインブロック
    sms

    SMS

    SMSを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。

    T:受信する
    F:受信しない
    news_mail

    メールマガジン受信の有無

    Ｅメールを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。「絶対受信しない」の場合は主要メールを含めてすべてのメールを受信しない。

    T:受信する
    F:受信しない
    solar_calendar

    新暦/旧暦

    T:新暦
    F:旧暦
    total_points

    ポイント合計
    available_points

    使用可能ポイント
    used_points

    ポイント利用額
    last_login_date

    timezone

    直近のアクセス日時

    会員が最終ログインした日時
    gender

    性別

    会員の性別

    M:男性
    F:女性
    use_mobile_app

    スマホアプリ使用の設定

    T:使用する
    F:使用しない
    available_credits

    使用可能預り金
    created_date

    timezone

    登録日
    fixed_group

    会員ランクの固定設定

    T：固定する
    F：固定しない

    Search customers

    GET /api/v2/admin/customers

    GET

    基本スペック

    Property Description
    SCOPE 会員の閲覧権限 (mall.read_customer)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    cellphone

    電話番号(携帯)

    照会する会員の携帯電話番号。個人情報保護のために携帯電話番号の全体を入力する必要があります。「cellphone」または「member_id」のうち1つは必ず検索条件として指定してください。

    ,(コンマ)で複数の件を検索することができる。

    member_id

    Max Length : [20]

    会員ID

    検索するショップ会員のID個人情報保護のためにIDは入力漏れがないようにしてください。「cellphone」と「member_id」のうち1つは必ず検索条件として指定してください。

    ,(コンマ)で複数の件を検索することができる。

    Request Copy
    Response Copy

    Customers memos

    「Customers memos」は特定会員に対するメモリソースであり、メモは会員のサブリソースです。

    Endpoints 
    GET /api/v2/admin/customers/{member_id}/memos
GET /api/v2/admin/customers/{member_id}/memos/count
GET /api/v2/admin/customers/{member_id}/memos/{memo_no}
POST /api/v2/admin/customers/{member_id}/memos
PUT /api/v2/admin/customers/{member_id}/memos/{memo_no}
DELETE /api/v2/admin/customers/{member_id}/memos/{memo_no}

    Customers memos properties

    Attribute Description
    shop_no

    ショップ番号
    memo_no

    メモ番号

    システムにより付与された商品メモの固有番号。商品メモ番号はショップ内で重複しない。
    author_id

    作成者ID

    メモを作成した管理者のID情報
    memo

    メモ内容

    メモの内容。HTMLを使って登録できる。
    important_flag

    重要メモの有無

    重要メモを区分するかどうかを設定

    T:重要メモ
    F:一般メモ
    created_date

    timezone

    作成日

    メモを作成した時間

    List all customers memos

    GET /api/v2/admin/customers/{member_id}/memos

    GET

    基本スペック

    Property Description
    SCOPE 会員の閲覧権限 (mall.read_customer)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    member_id
    Required

    会員ID

    offset

    Max : [10000]

    検索結果の開始位置

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    Request Copy
    Response Copy

    Count all customers memos

    GET /api/v2/admin/customers/{member_id}/memos/count

    GET

    基本スペック

    Property Description
    SCOPE 会員の閲覧権限 (mall.read_customer)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    member_id
    Required

    会員ID

    Request Copy
    Response Copy

    Get a customers memo

    GET /api/v2/admin/customers/{member_id}/memos/{memo_no}

    GET

    基本スペック

    Property Description
    SCOPE 会員の閲覧権限 (mall.read_customer)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    memo_no
    Required

    メモ番号

    システムにより付与された商品メモの固有番号。商品メモ番号はショップ内で重複しない。

    member_id
    Required

    会員ID

    Request Copy
    Response Copy

    Create a customers memo

    POST /api/v2/admin/customers/{member_id}/memos

    POST

    基本スペック

    Property Description
    SCOPE 会員の投稿権限 (mall.write_customer)
    呼び出し件数制限 30
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    member_id
    Required

    会員ID

    author_id
    Required

    Max Length : [20]

    作成者ID

    メモを作成した管理者のID情報

    memo
    Required

    メモ

    メモの内容。HTMLを使って登録できる。

    important_flag

    重要メモの有無

    重要メモを区分するかどうかを設定

    T:重要メモ
    F:一般メモ

    DEFAULT F

    Request Copy
    Response Copy

    Update a customers memo

    PUT /api/v2/admin/customers/{member_id}/memos/{memo_no}

    PUT

    基本スペック

    Property Description
    SCOPE 会員の投稿権限 (mall.write_customer)
    呼び出し件数制限 30
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    memo_no
    Required

    メモ番号

    システムにより付与された商品メモの固有番号。商品メモ番号はショップ内で重複しない。

    member_id
    Required

    会員ID

    author_id
    Required

    Max Length : [20]

    作成者ID

    メモを作成した管理者のID情報

    memo

    メモ

    メモの内容。HTMLを使って登録できる。

    important_flag

    重要メモの有無

    重要メモを区分するかどうかを設定

    T:重要メモ
    F:一般メモ

    Request Copy
    Response Copy

    Delete a customers memo

    DELETE /api/v2/admin/customers/{member_id}/memos/{memo_no}

    DELETE

    基本スペック

    Property Description
    SCOPE 会員の投稿権限 (mall.write_customer)
    呼び出し件数制限 30

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    memo_no
    Required

    メモ番号

    システムにより付与された商品メモの固有番号。商品メモ番号はショップ内で重複しない。

    member_id
    Required

    会員ID

    Request Copy
    Response Copy

    Customers paymentinformation

    Endpoints 
    GET /api/v2/admin/customers/{member_id}/paymentinformation
DELETE /api/v2/admin/customers/{member_id}/paymentinformation

    Customers paymentinformation properties

    Attribute Description
    shop_no

    ショップ番号
    member_id

    Max Length : [20]

    会員ID
    payment_method

    決済方法名
    payment_gateway

    決済代行サービス名
    created_date

    timezone

    生成日

    List all customers paymentinformation

    GET /api/v2/admin/customers/{member_id}/paymentinformation

    GET

    基本スペック

    Property Description
    SCOPE 会員の閲覧権限 (mall.read_customer)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    member_id
    Required

    Max Length : [20]

    会員ID

    Request Copy
    Response Copy

    Delete a customers paymentinformation

    DELETE /api/v2/admin/customers/{member_id}/paymentinformation

    DELETE

    基本スペック

    Property Description
    SCOPE 会員の投稿権限 (mall.write_customer)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    member_id
    Required

    Max Length : [20]

    会員ID

    Request Copy
    Response Copy

    Community

    Boards

    Endpoints 
    GET /api/v2/admin/boards

    Boards properties

    Attribute Description
    shop_no

    ショップ番号
    board_no

    掲示板番号
    board_type

    掲示板のカテゴリ

    1：運営
    2：一般
    3：資料室
    4：その他
    5：商品
    6：アルバム
    7：My質問
    11：ひとこと投稿
    board_name

    掲示板タイトル
    use_additional_board

    掲示板の追加有無

    T：追加掲示板
    F：基本掲示板
    use_board

    掲示板の使用有無

    T:使用する
    F:使用しない
    use_display

    表示有無

    T:表示する
    F:表示しない
    display_order

    並べ替え順序

    List all boards

    GET /api/v2/admin/boards

    GET

    基本スペック

    Property Description
    SCOPE 掲示板の閲覧権限 (mall.read_community)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    Request Copy
    Response Copy

    Boards articles

    「Boards articles」は掲示板の投稿についての情報を意味します。

    Endpoints 
    GET /api/v2/admin/boards/{board_no}/articles
POST /api/v2/admin/boards/{board_no}/articles
PUT /api/v2/admin/boards/{board_no}/articles/{article_no}
DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}

    Boards articles properties

    Attribute Description
    shop_no

    ショップ番号
    article_no

    投稿番号
    parent_article_no

    親投稿の番号
    board_no
    Required

    掲示板番号
    product_no

    商品番号
    category_no

    カテゴリ番号
    board_category_no

    掲示板カテゴリ番号
    reply_sequence

    回答投稿の順序
    reply_depth

    回答順序
    created_date

    Date
    timezone

    生成日
    writer

    作成者名
    writer_email

    Email

    作成者Eメール
    member_id

    会員ID
    title

    タイトル
    content

    内容
    client_ip

    IP

    作成者IP
    nick_name

    ニックネーム
    rating

    Min : [1]~Max : [5]

    評価
    sales_channel

    Max Length : [20]

    媒体社
    reply_mail

    My質問への回答メールの有無

    Y：使用する
    N:使用しない
    display

    掲示設定

    T : 掲示する
    F : 掲示しない
    secret

    非公開の有無

    T:使用する
    F:使用しない
    notice

    告知の有無

    T:使用する
    F:使用しない
    fixed

    固定投稿の有無

    T:使用する
    F:使用しない
    deleted

    削除区分

    T : 削除
    F : 未削除
    input_channel

    投稿作成のルート

    P:PC
    M：モバイル
    order_id

    注文番号
    attach_file_urls

    添付ファイルの詳細
    hit

    観覧数
    reply

    My質問への回答の有無

    T:使用する
    F:使用しない
    reply_user_id

    処理中または回答完了した運営者ID
    reply_status

    回答処理状態

    N:回答前
    P:処理中
    C:対応完了
    naverpay_review_id

    Naver PayのレビューID
    display_time

    表示時間使用の有無
    display_time_start_hour

    表示時間の開始時刻
    display_time_end_hour

    表示時間の終了時刻
    attached_file_detail

    添付ファイルの詳細
    attached_file_urls

    添付ファイルの詳細

    List all boards articles

    GET /api/v2/admin/boards/{board_no}/articles

    GET

    基本スペック

    Property Description
    SCOPE 掲示板の閲覧権限 (mall.read_community)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    board_no
    Required

    掲示板番号

    board_category_no

    掲示板カテゴリ番号

    start_date

    Date
    timezone

    作成日の開始日

    end_date

    Date
    timezone

    作成日の終了日

    input_channel

    ショップ区分

    P : PC
    M : モバイル

    search

    検索エリア

    subject : タイトル
    content : 内容
    writer_name : 作成者
    product : 商品名
    member_id : 会員ID

    keyword

    検索キーワード

    reply_status

    回答状態

    N : 回答前
    P : 処理中
    C : 回答完了

    comment

    コメントの有無

    T : 有り
    F : 無し

    attached_file

    添付ファイルの有無

    T : 有り
    F : 無し

    article_type

    投稿タイプ

    ,(コンマ)で複数の件を検索することができる。

    all : すべて
    normal : 一般投稿
    notice : お知らせ投稿
    fixed : 固定投稿

    product_no

    商品番号

    has_product

    商品情報を含むかどうか

    T : 有り
    F : 無し

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Create boards articles

    POST /api/v2/admin/boards/{board_no}/articles

    POST

    基本スペック

    Property Description
    SCOPE 掲示板の投稿権限 (mall.write_community)
    呼び出し件数制限 40
    1回当たり申込件数の制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    board_no
    Required

    掲示板番号

    writer
    Required

    Max Length : [100]

    作成者名

    title
    Required

    Max Length : [256]

    タイトル

    content
    Required

    内容

    client_ip
    Required

    IP

    作成者IP

    reply_article_no

    回答の投稿番号

    created_date

    Date
    timezone

    生成日

    writer_email

    Email

    作成者Eメール

    member_id

    Max Length : [20]

    会員ID

    notice

    告知の有無

    T:使用する
    F:使用しない

    DEFAULT F

    fixed

    固定投稿の有無

    T:使用する
    F:使用しない

    DEFAULT F

    deleted

    削除区分

    T : 削除
    F : 未削除

    DEFAULT F

    reply

    My質問への回答の有無

    T:使用する
    F:使用しない

    DEFAULT F

    rating

    Min : [1]~Max : [5]

    評価

    sales_channel

    Max Length : [20]

    媒体社

    secret

    非公開の有無

    T:使用する
    F:使用しない

    DEFAULT F

    password

    投稿パスワード

    reply_mail

    My質問への回答メールの有無

    Y：使用する
    N:使用しない

    DEFAULT N

    board_category_no

    掲示板カテゴリ番号

    nick_name

    Max Length : [50]

    ニックネーム

    input_channel

    投稿作成のルート

    P:PC
    M：モバイル

    DEFAULT P

    reply_user_id

    処理中または回答完了した運営者ID

    reply_status

    回答処理状態

    N:回答前
    P:処理中
    C:対応完了

    product_no

    商品番号

    category_no

    カテゴリ番号

    order_id

    Order ID

    注文番号

    naverpay_review_id

    Naver PayのレビューID

    attach_file_urls

    添付ファイルの詳細

    name
    ファイル名

    url
    ファイルURL
    Request Copy
    Response Copy

    Update a boards article

    PUT /api/v2/admin/boards/{board_no}/articles/{article_no}

    PUT

    基本スペック

    Property Description
    SCOPE 掲示板の投稿権限 (mall.write_community)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    board_no
    Required

    掲示板番号

    article_no
    Required

    投稿番号

    title

    Max Length : [256]

    タイトル

    content

    内容

    rating

    Min : [1]~Max : [5]

    評価

    sales_channel

    Max Length : [20]

    媒体社

    board_category_no

    掲示板カテゴリ番号

    display

    掲示設定

    T : 掲示する
    F : 掲示しない

    notice

    告知の有無

    T:使用する
    F:使用しない

    fixed

    固定投稿の有無

    T:使用する
    F:使用しない

    display_time_start_hour

    表示時間の開始時刻

    display_time_end_hour

    表示時間の終了時刻

    attach_file_url1

    URL

    ファイルURL

    attach_file_url2

    URL

    ファイルURL

    attach_file_url3

    URL

    ファイルURL

    attach_file_url4

    URL

    ファイルURL

    attach_file_url5

    URL

    ファイルURL

    Request Copy
    Response Copy

    Delete a boards article

    DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}

    DELETE

    基本スペック

    Property Description
    SCOPE 掲示板の投稿権限 (mall.write_community)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    board_no
    Required

    掲示板番号

    article_no
    Required

    投稿番号

    Request Copy
    Response Copy

    Boards articles comments

    Endpoints 
    GET /api/v2/admin/boards/{board_no}/articles/{article_no}/comments
POST /api/v2/admin/boards/{board_no}/articles/{article_no}/comments
DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}/comments/{comment_no}

    Boards articles comments properties

    Attribute Description
    shop_no

    ショップ番号
    board_no

    掲示板番号
    article_no

    投稿番号
    comment_no

    コメント番号
    content

    コメント内容
    writer

    Max Length : [100]

    作成者名
    member_id

    Max Length : [20]

    会員ID
    created_date

    Date
    timezone

    生成日
    client_ip

    IP

    作成者IP
    rating

    Min : [1]~Max : [5]

    コメント評価
    secret

    非公開の有無

    T:使用する
    F:使用しない
    parent_comment_no

    親コメント番号
    input_channel

    ショップ区分

    P : PC
    M : モバイル

    List all boards articles comments

    GET /api/v2/admin/boards/{board_no}/articles/{article_no}/comments

    GET

    基本スペック

    Property Description
    SCOPE 掲示板の閲覧権限 (mall.read_community)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    board_no
    Required

    掲示板番号

    article_no
    Required

    投稿番号

    comment_no

    コメント番号

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Create a boards articles comment

    POST /api/v2/admin/boards/{board_no}/articles/{article_no}/comments

    POST

    基本スペック

    Property Description
    SCOPE 掲示板の投稿権限 (mall.write_community)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    board_no
    Required

    掲示板番号

    article_no
    Required

    投稿番号

    content
    Required

    コメント内容

    writer
    Required

    Max Length : [100]

    作成者名

    password
    Required

    Length Min : [1]~Max : [20]

    コメントのパスワード

    member_id

    Max Length : [20]

    会員ID

    rating

    Min : [1]~Max : [5]

    コメント評価

    secret

    非公開の有無

    T:使用する
    F:使用しない

    DEFAULT F

    parent_comment_no

    Min : [1]

    親コメント番号

    input_channel

    ショップ区分

    P : PC
    M : モバイル

    DEFAULT P

    created_date

    Date
    timezone

    生成日

    Request Copy
    Response Copy

    Delete a boards articles comment

    DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}/comments/{comment_no}

    DELETE

    基本スペック

    Property Description
    SCOPE 掲示板の投稿権限 (mall.write_community)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    board_no
    Required

    掲示板番号

    article_no
    Required

    投稿番号

    comment_no
    Required

    コメント番号

    Request Copy
    Response Copy

    Customers reviews

    顧客レビュー(Customer Reviews)はショップの顧客が作成したレビューの顧客別リストを確認する関係型Resourceです。

    Endpoints 
    GET /api/v2/admin/customers/{writing_id}/reviews
GET /api/v2/admin/customers/{writing_id}/reviews/count
GET /api/v2/admin/customers/{writing_id}/reviews/{review_no}

    Customers reviews properties

    Attribute Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号
    product_no

    商品番号
    review_no

    レビュー番号
    order_id

    Order ID

    注文番号
    nickname

    投稿者のニックネーム
    title

    レビュータイトル
    content

    レビュー内容
    content_text_length

    レビューの文字数
    input_channel

    レビュー作成デバイス

    P : PC
    M : モバイル
    writer

    投稿者名
    writing_id

    投稿者の会員ID
    created_date

    Date
    timezone

    投稿日
    updated_date

    修正日
    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

    GET /api/v2/admin/customers/{writing_id}/reviews

    GET

    基本スペック

    Property Description
    SCOPE 掲示板の閲覧権限 (mall.read_community)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    review_no

    レビュー番号

    writing_id
    Required

    投稿者の会員ID

    created_start_date

    Date
    timezone

    投稿日の検索開始日

    レビュー作成日基準検索の検索開始日
    検索終了日と必ずペアで使用すること。

    created_end_date

    Date
    timezone

    投稿日の検索終了日

    レビュー作成日基準検索の検索終了日
    検索開始日と必ずペアで使用すること。

    updated_start_date

    Date
    timezone

    修正日の検索開始日

    updated_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 : 投稿者の会員ID
    content : レビュー内容
    product_no : 商品番号
    product_name : 商品番号
    product_code : 商品コード

    keyword

    検索キーワード

    mileage

    ポイント付与状態

    todo : 未付与
    done : 付与済み

    limit

    Min : [1]

    表示する一覧数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 50

    offset

    Min : [0]

    一覧を表示する位置

    Request Copy
    Response Copy

    Count all customers reviews

    GET /api/v2/admin/customers/{writing_id}/reviews/count

    GET

    基本スペック

    Property Description
    SCOPE 掲示板の閲覧権限 (mall.read_community)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    writing_id
    Required

    投稿者の会員ID

    created_start_date

    Date
    timezone

    投稿日の検索開始日

    レビュー作成日基準検索の検索開始日
    検索終了日と必ずペアで使用すること。

    created_end_date

    Date
    timezone

    投稿日の検索終了日

    レビュー作成日基準検索の検索終了日
    検索開始日と必ずペアで使用すること。

    updated_start_date

    Date
    timezone

    修正日の検索開始日

    updated_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 : 投稿者の会員ID
    content : レビュー内容
    product_no : 商品番号
    product_name : 商品名
    product_code : 商品コード

    keyword

    検索キーワード

    mileage

    ポイント付与状態

    todo : 未付与
    done : 付与済み

    Request Copy
    Response Copy

    Get a customers review

    GET /api/v2/admin/customers/{writing_id}/reviews/{review_no}

    GET

    基本スペック

    Property Description
    SCOPE 掲示板の閲覧権限 (mall.read_community)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    writing_id
    Required

    投稿者の会員ID

    review_no
    Required

    レビュー番号

    Request Copy
    Response Copy

    Reviews

    Review de Talk(Reviews)は商品やサービスを利用したショップの顧客がレビューを書くサービスを意味します。Review de Talk APIを使うためにはまずショップで Review de Talkサービスを使っているか確認する必要があります。

    Endpoints 
    GET /api/v2/admin/reviews
GET /api/v2/admin/reviews/count
GET /api/v2/admin/reviews/{review_no}
POST /api/v2/admin/reviews
PUT /api/v2/admin/reviews/{review_no}
DELETE /api/v2/admin/reviews/{review_no}

    Reviews properties

    Attribute Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号
    product_no

    商品番号
    review_no

    レビュー番号
    order_id

    Order ID

    注文番号
    nickname

    投稿者のニックネーム
    title

    レビュータイトル
    content

    レビュー内容
    content_text_length

    レビューの文字数
    input_channel

    レビュー作成デバイス

    P : PC
    M : モバイル
    writer

    投稿者名
    writing_id

    投稿者の会員ID
    created_date

    Date
    timezone

    投稿日
    updated_date

    修正日
    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 reviews

    GET /api/v2/admin/reviews

    GET

    基本スペック

    Property Description
    SCOPE 掲示板の閲覧権限 (mall.read_community)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    review_no

    レビュー番号

    writing_id

    投稿者の会員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 : 投稿者の会員ID
    content : レビュー内容
    product_no : 商品番号
    product_name : 商品名
    product_code : 商品コード

    keyword

    検索キーワード

    mileage

    ポイント付与状態

    todo : 未付与
    done : 付与済み

    limit

    Min : [1]

    表示する一覧数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 50

    offset

    Min : [0]
    Max : [5000]

    検索結果の表示開始位置

    検索結果の開始位置

    Request Copy
    Response Copy

    Count all reviews

    GET /api/v2/admin/reviews/count

    GET

    基本スペック

    Property Description
    SCOPE 掲示板の閲覧権限 (mall.read_community)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    writing_id

    投稿者の会員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 : 投稿者の会員ID
    content : レビュー内容
    product_no : 商品番号
    product_name : 商品名
    product_code : 商品コード

    keyword

    検索キーワード

    mileage

    ポイント付与状態

    todo : 未付与
    done : 付与済み

    Request Copy
    Response Copy

    Get a review

    GET /api/v2/admin/reviews/{review_no}

    GET

    基本スペック

    Property Description
    SCOPE 掲示板の閲覧権限 (mall.read_community)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    review_no
    Required

    レビュー番号

    Request Copy
    Response Copy

    Create a review

    POST /api/v2/admin/reviews

    POST

    基本スペック

    Property Description
    SCOPE 掲示板の投稿権限 (mall.write_community)
    呼び出し件数制限 100
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    writing_id
    Required

    投稿者の会員ID

    product_no
    Required

    商品番号

    商品固有の一連番号。ショップ内で商品番号は重複しない。

    order_id

    Order ID

    注文番号

    item_code

    品目コード

    レビューを作成する商品の品目コード

    content
    Required

    Max Length : [2000]

    レビュー内容

    rating

    評価

    DEFAULT 5

    additional_information

    追加項目

    images

    添付画像

    input_channel

    レビュー作成デバイス

    P : PC
    M : モバイル

    DEFAULT P

    use_share

    SNSシェア状態

    T : シェア済み
    F : 未シェア

    sales_channel

    BSARI.NAVER.SALES.CHANNEL

    smartstore : BSARI.NAVER.SMART.STORE
    npay : BSARI.NAVER.PAY

    Request Copy
    Response Copy

    Update a review

    PUT /api/v2/admin/reviews/{review_no}

    PUT

    基本スペック

    Property Description
    SCOPE 掲示板の投稿権限 (mall.write_community)
    呼び出し件数制限 100
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    review_no
    Required

    レビュー番号

    content

    Max Length : [2000]

    レビュー内容

    rating

    評価

    additional_information

    追加項目

    images

    添付画像

    レビューに添付する画像

    use_share

    SNSシェア状態

    レビューのSNSシェアの有無

    T : シェア済み
    F : 未シェア

    Request Copy
    Response Copy

    Delete a review

    DELETE /api/v2/admin/reviews/{review_no}

    DELETE

    基本スペック

    Property Description
    SCOPE 掲示板の投稿権限 (mall.write_community)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    review_no
    Required

    レビュー番号

    Request Copy
    Response Copy

    Reviews comments

    コメント(Comments)はレビューに対する他の顧客やショップ運営者の反応を示します。コメントはレビューに属する下位Resourceです。

    Endpoints 
    GET /api/v2/admin/reviews/{review_no}/comments
GET /api/v2/admin/reviews/{review_no}/comments/{comment_no}
POST /api/v2/admin/reviews/{review_no}/comments
PUT /api/v2/admin/reviews/{review_no}/comments/{comment_no}
DELETE /api/v2/admin/reviews/{review_no}/comments/{comment_no}

    Reviews comments properties

    Attribute Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号
    review_no

    レビュー番号
    comment_no

    コメント番号
    content

    コメント内容
    writer

    投稿者名
    nickname

    投稿者のニックネーム
    ip

    IP

    投稿者のIPアドレス
    writing_id

    投稿者の会員ID
    created_date

    Date
    timezone

    投稿日

    List all reviews comments

    GET /api/v2/admin/reviews/{review_no}/comments

    GET

    基本スペック

    Property Description
    SCOPE 掲示板の閲覧権限 (mall.read_community)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    review_no
    Required

    レビュー番号

    limit

    Min : [1]

    表示する一覧数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 50

    offset

    Min : [0]

    一覧を表示する位置

    検索結果の開始位置

    Request Copy
    Response Copy

    Get a reviews comment

    GET /api/v2/admin/reviews/{review_no}/comments/{comment_no}

    GET

    基本スペック

    Property Description
    SCOPE 掲示板の閲覧権限 (mall.read_community)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    review_no
    Required

    レビュー番号

    comment_no
    Required

    コメント番号

    Request Copy
    Response Copy

    Create a reviews comment

    POST /api/v2/admin/reviews/{review_no}/comments

    POST

    基本スペック

    Property Description
    SCOPE 掲示板の投稿権限 (mall.write_community)
    呼び出し件数制限 100
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    review_no
    Required

    レビュー番号

    writing_id

    投稿者の会員ID

    content
    Required

    コメント内容

    Request Copy
    Response Copy

    Update a reviews comment

    PUT /api/v2/admin/reviews/{review_no}/comments/{comment_no}

    PUT

    基本スペック

    Property Description
    SCOPE 掲示板の投稿権限 (mall.write_community)
    呼び出し件数制限 100
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    review_no
    Required

    レビュー番号

    comment_no
    Required

    コメント番号

    content
    Required

    コメント内容

    Request Copy
    Response Copy

    Delete a reviews comment

    DELETE /api/v2/admin/reviews/{review_no}/comments/{comment_no}

    DELETE

    基本スペック

    Property Description
    SCOPE 掲示板の投稿権限 (mall.write_community)
    呼び出し件数制限 100

    要求スペック

    Parameter Description
    shop_no

    越境ECショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    review_no
    Required

    レビュー番号

    comment_no
    Required

    コメント番号

    Request Copy
    Response Copy

    Design

    Themes

    デザイン(Themes)はショップに使うために購入または直接制作したデザイン情報です。デザインは PCショップとモバイルショップのデザインを両方とも確認することができます。デザインリストにあるデザインの中で代表デザインを指定するとショップのデザインがそのデザインに変更されます。

    Endpoints 
    GET /api/v2/admin/themes
GET /api/v2/admin/themes/count
GET /api/v2/admin/themes/{skin_no}

    Themes properties

    Attribute Description
    skin_no

    Min : [1]

    デザイン番号
    skin_code

    デザインコード
    skin_name

    Max Length : [100]

    デザイン名
    skin_thumbnail_url

    Max Length : [255]

    デザインサムネイル画像のURL
    usage_type

    デザイン用途の区分

    S:PCの基本デザイン
    C:PCのコピーされたデザイン
    I:PCの連動されたデザイン
    M:モバイルの基本デザイン/連動されたデザイン
    N:モバイルのコピーされたデザイン
    editor_type

    エディタータイプ

    H : スマートデザイン(HTML)
    D : Edibotデザイン(Drag & Drop)
    W : シンプルデザイン(WYSIWYG)
    parent_skin_no

    親デザイン番号
    seller_id

    販売者のデザインセンターID
    seller_skin_code

    販売者のデザインコード
    design_purchase_no

    Min : [0]

    デザイン購入番号
    design_product_code

    デザインセンターの商品コード
    language_code

    Min Length : [5]
    Max Length : [5]

    言語コード

    ko_KR:韓国語
    en_US:英語
    zh_CN:中国語(簡体字)
    zh_TW:中国語(繁体字)
    ja_JP:日本語
    pt_PT:ポルトガル語
    es_ES:スペイン語
    vi_VN:ベトナム語
    published_in

    メインデザインを設定した越境ECショップの番号
    created_date

    Date
    timezone

    作成日
    updated_date

    Date
    timezone

    修正日

    List all themes

    GET /api/v2/admin/themes

    GET

    基本スペック

    Property Description
    SCOPE デザインの閲覧権限 (mall.read_design)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    type
    Required

    デザインタイプ

    pc:PC
    mobile:モバイル

    DEFAULT pc

    Request Copy
    Response Copy

    Count all themes

    GET /api/v2/admin/themes/count

    GET

    基本スペック

    Property Description
    SCOPE デザインの閲覧権限 (mall.read_design)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    type

    デザインタイプ

    pc:PC
    mobile:モバイル

    DEFAULT pc

    Request Copy
    Response Copy

    Get a theme

    GET /api/v2/admin/themes/{skin_no}

    GET

    基本スペック

    Property Description
    SCOPE デザインの閲覧権限 (mall.read_design)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    skin_no

    Min : [1]

    デザイン番号

    Request Copy
    Response Copy

    Promotion

    Benefits

    「Benefits」では、[プロモーション > 特典管理]のイベント、割引、クーポンなどを照会することができます。

    Endpoints 
    GET /api/v2/admin/benefits
GET /api/v2/admin/benefits/count
GET /api/v2/admin/benefits/{benefit_no}
POST /api/v2/admin/benefits
PUT /api/v2/admin/benefits/{benefit_no}
DELETE /api/v2/admin/benefits/{benefit_no}

    Benefits properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    benefit_no

    特典番号
    use_benefit

    提供の有無
    benefit_name

    Max Length : [255]

    特典名
    benefit_division

    特典タイプ
    benefit_type

    特典タイプ詳細
    use_benefit_period

    特典期間設定
    benefit_start_date

    Date
    timezone

    開始日
    benefit_end_date

    Date
    timezone

    終了日
    platform_types

    特典使用の範囲
    use_group_binding

    提供対象設定
    customer_group_list

    会員ランク
    product_binding_type

    特典対象商品
    use_except_category

    カテゴリ適用除外
    available_coupon

    クーポン使用範囲
    icon_url

    アイコンURL
    created_date

    timezone

    特典登録日
    period_sale

    期間割引設定

    詳細照会を行う際にのみ確認できる。
    repurchase_sale

    再購入割引設定

    詳細照会を行う際にのみ確認できる。
    bulk_purchase_sale

    大量購入数量設定

    詳細照会を行う際にのみ確認できる。
    member_sale

    会員割引設定

    詳細照会を行う際にのみ確認できる。
    new_product_sale

    新着商品割引設定

    詳細照会を行う際にのみ確認できる。
    shipping_fee_sale

    送料割引設定

    詳細照会を行う際にのみ確認できる。
    gift

    ノベルティ設定

    詳細照会を行う際にのみ確認できる。
    gift_product_bundle

    1+Nイベント設定

    詳細照会を行う際にのみ確認できる。

    List all benefits

    GET /api/v2/admin/benefits

    GET

    基本スペック

    Property Description
    SCOPE プロモーションの閲覧権限 (mall.read_promotion)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    use_benefit

    提供の有無

    T:提供する
    F:提供しない

    benefit_name

    特典名

    benefit_type

    特典タイプ詳細

    クーポンによる特典の種類の区分

    DP：期間限定割引
    DR：再購入割引
    DQ：大量購入割引
    DM：会員限定割引
    DN：新着商品割引
    DV：送料割引
    PG：ノベルティ
    PB ：1+Nイベント

    period_type

    特典期間タイプ

    R: 特典登録日
    S: 特典開始日
    E: 特典終了日

    benefit_start_date

    Date
    timezone

    検索開始日

    benefit_end_date

    Date
    timezone

    検索終了日

    platform_types

    特典使用の範囲

    ,(コンマ)で複数の件を検索することができる。

    P:PCショップ
    M:Mobileショップ
    A:プラスアプリ

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Count all benefits

    GET /api/v2/admin/benefits/count

    GET

    基本スペック

    Property Description
    SCOPE プロモーションの閲覧権限 (mall.read_promotion)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    use_benefit

    提供の有無

    T:提供する
    F:提供しない

    benefit_name

    特典名

    benefit_type

    特典タイプ詳細

    クーポンによる特典の種類の区分

    DP：期間限定割引
    DR：再購入割引
    DQ：大量購入割引
    DM：会員限定割引
    DN：新着商品割引
    DV：送料割引
    PG：ノベルティ
    PB ：1+Nイベント

    period_type

    特典期間タイプ

    R: 特典登録日
    S: 特典開始日
    E: 特典終了日

    benefit_start_date

    Date
    timezone

    検索開始日

    benefit_end_date

    Date
    timezone

    検索終了日

    platform_types

    特典使用の範囲

    ,(コンマ)で複数の件を検索することができる。

    P:PCショップ
    M:Mobileショップ
    A:プラスアプリ

    Request Copy
    Response Copy

    Get a benefit

    GET /api/v2/admin/benefits/{benefit_no}

    GET

    基本スペック

    Property Description
    SCOPE プロモーションの閲覧権限 (mall.read_promotion)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    benefit_no
    Required

    特典番号

    Request Copy
    Response Copy

    Create a benefit

    POST /api/v2/admin/benefits

    POST

    基本スペック

    Property Description
    SCOPE プロモーションの投稿権限 (mall.write_promotion)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    use_benefit
    Required

    提供の有無

    T:提供する
    F:提供しない

    benefit_name
    Required

    Max Length : [255]

    特典名

    benefit_division
    Required

    特典タイプ

    D：割引
    P：贈呈

    benefit_type
    Required

    特典タイプ詳細

    DP：期間限定割引
    DN：新着商品割引
    DV：送料割引
    PG：ノベルティ
    PB：1+Nイベント

    use_benefit_period

    特典期間設定

    T:使用する
    F:使用しない

    benefit_start_date

    Date
    timezone

    開始日

    benefit_end_date

    Date
    timezone

    終了日

    platform_types
    Required

    特典使用の範囲

    P:PCショップ
    M:Mobileショップ
    A:プラスアプリ

    use_group_binding

    提供対象設定

    A : 会員 + 非会員
    N : 非会員
    M : 会員

    customer_group_list

    会員ランク

    product_binding_type

    特典対象商品

    A : 全商品
    P : 特定商品
    E : 除外送品
    C : 商品カテゴリ

    use_except_category

    カテゴリ適用除外

    T:使用する
    F:使用しない

    available_coupon

    クーポン使用範囲

    T:すべてのクーポンを使用できる
    F:すべてのクーポンが使用できない

    period_sale

    期間割引設定

    product_list
    商品リスト

    add_category_list
    商品カテゴリ

    except_category_list
    除外カテゴリ

    discount_purchasing_quantity
    割引適用数量

    T : 購入数による、 F : 購入数関係なし

    discount_value
    割引値

    discount_value_unit
    割引基準

    P : 比率、 W : 金額

    discount_truncation_unit
    割引切り上げ単位

    F : 切り捨てしない、 C : 0.01、 B : 0.1、 O : 1、 T : 10、 M : 100、 H : 1000

    discount_truncation_method
    割引単位で処理

    L : 切り捨て、 U : 四捨五入、 C : 切り上げ
    gift

    ノベルティ設定

    product_list
    商品リスト

    add_category_list
    商品カテゴリ

    offer_only_first
    初回購入かどうか

    T:使用する、F:使用しない

    first_purchase_type
    初回購入基準

    O : 注文基準、 D : 配送完了基準

    use_unlimited_price
    価格最大値制限

    T:使用する、F:使用しない

    purchase_start_price
    購入価格制限(n 以上)

    purchase_limit_price
    購入価格制限(n 未満)

    gift_product_list Array
    ノベルティ一覧

    product_no
    商品番号

    gift_point
    差引点数

    max_count
    最大選択数量
    new_product_sale

    新着商品割引設定

    product_list
    商品リスト

    add_category_list
    商品カテゴリ

    except_category_list
    除外カテゴリ

    new_product_date_type
    新商品設定基準日
    Required

    I : 商品登録日､ U : 商品の最終修正日、 V : 商品の最終表示日

    new_product_day
    新商品設定値(数字入力)
    Required

    new_product_term_type
    新商品設定単位(日/時間)
    Required

    D : 日、 H : 時間

    discount_purchasing_quantity
    割引適用数量

    T : 購入数による、 F : 購入数関係なし

    discount_value
    割引値
    Required

    discount_value_unit
    割引基準

    P : 比率、 W : 金額

    discount_truncation_unit
    割引切り上げ単位

    F : 切り捨てしない、 C : 0.01、 B : 0.1、 O : 1、 T : 10、 M : 100、 H : 1000

    discount_truncation_method
    割引単位で処理

    L : 切り捨て、 U : 四捨五入、 C : 切り上げ
    shipping_fee_sale

    送料割引設定

    product_list
    商品リスト

    use_purchase_price_condition
    金額基準使用の有無

    T:使用する、F:使用しない

    total_purchase_price
    金額制限

    include_regional_shipping_rate
    地域別送料を含むかどうかの値

    T:含む、F:含まない
    gift_product_bundle

    1+Nイベント設定

    product_list
    商品リスト

    product_bundle_type
    特典設定
    Required

    P : 商品、 I : 品目

    product_bundle_count
    追加商品数量
    Required
    icon_url

    アイコンURL

    Request Copy
    Response Copy

    Update a benefit

    PUT /api/v2/admin/benefits/{benefit_no}

    PUT

    基本スペック

    Property Description
    SCOPE プロモーションの投稿権限 (mall.write_promotion)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    benefit_no
    Required

    特典番号

    use_benefit

    提供の有無

    T:提供する
    F:提供しない

    benefit_name

    Max Length : [255]

    特典名

    use_benefit_period

    特典期間設定

    T:使用する
    F:使用しない

    benefit_start_date

    Date
    timezone

    開始日

    benefit_end_date

    Date
    timezone

    終了日

    platform_types

    特典使用の範囲

    P:PCショップ
    M:Mobileショップ
    A:プラスアプリ

    use_group_binding

    提供対象設定

    A : 会員 + 非会員
    N : 非会員
    M : 会員

    customer_group_list

    会員ランク

    product_binding_type

    特典対象商品

    A : 全商品
    P : 特定商品
    E : 除外送品
    C : 商品カテゴリ

    use_except_category

    カテゴリ適用除外

    T:使用する
    F:使用しない

    available_coupon

    クーポン使用範囲

    T:すべてのクーポンを使用できる
    F:すべてのクーポンが使用できない

    period_sale

    期間割引設定

    product_list
    商品リスト

    add_category_list
    商品カテゴリ

    except_category_list
    除外カテゴリ

    discount_purchasing_quantity
    割引適用数量

    T : 購入数による、 F : 購入数関係なし

    discount_value
    割引値

    discount_value_unit
    割引基準

    P : 比率、 W : 金額

    discount_truncation_unit
    割引切り上げ単位

    F : 切り捨てしない、 C : 0.01、 B : 0.1、 O : 1、 T : 10、 M : 100、 H : 1000

    discount_truncation_method
    割引単位で処理

    L : 切り捨て、 U : 四捨五入、 C : 切り上げ
    gift

    ノベルティ設定

    product_list
    商品リスト

    add_category_list
    商品カテゴリ

    offer_only_first
    初回購入かどうか

    T:使用する、F:使用しない

    first_purchase_type
    初回購入基準

    O : 注文基準、 D : 配送完了基準

    use_unlimited_price
    価格最大値制限

    T:使用する、F:使用しない

    purchase_start_price
    購入価格制限(n 以上)

    purchase_limit_price
    購入価格制限(n 未満)

    gift_product_list Array
    ノベルティ一覧

    product_no
    商品番号

    gift_point
    差引点数

    max_count
    最大選択数量
    gift_product_bundle

    1+Nイベント設定

    product_list
    商品リスト

    product_bundle_count
    追加商品数量
    new_product_sale

    新着商品割引設定

    product_list
    商品リスト

    add_category_list
    商品カテゴリ

    except_category_list
    除外カテゴリ

    new_product_date_type
    新商品設定基準日

    I : 商品登録日､ U : 商品の最終修正日、 V : 商品の最終表示日

    new_product_day
    新商品設定値(数字入力)

    new_product_term_type
    新商品設定単位(日/時間)

    D : 日、 H : 時間

    discount_purchasing_quantity
    割引適用数量

    T : 購入数による、 F : 購入数関係なし

    discount_value
    割引値

    discount_value_unit
    割引基準

    P : 比率、 W : 金額

    discount_truncation_unit
    割引切り上げ単位

    F : 切り捨てしない、 C : 0.01、 B : 0.1、 O : 1、 T : 10、 M : 100、 H : 1000

    discount_truncation_method
    割引単位で処理

    L : 切り捨て、 U : 四捨五入、 C : 切り上げ
    shipping_fee_sale

    送料割引設定

    product_list
    商品リスト

    use_purchase_price_condition
    金額基準使用の有無

    T:使用する、F:使用しない

    total_purchase_price
    金額制限

    include_regional_shipping_rate
    地域別送料を含むかどうかの値

    T:含む、F:含まない
    icon_url

    アイコンURL

    Request Copy
    Response Copy

    Delete a benefit

    DELETE /api/v2/admin/benefits/{benefit_no}

    DELETE

    基本スペック

    Property Description
    SCOPE プロモーションの投稿権限 (mall.write_promotion)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    benefit_no
    Required

    特典番号

    Request Copy
    Response Copy

    Coupons

    Coupons Resource関係図
    クーポン(Coupons)は商品の価格や送料を割引してもえるようにショップの会員に発行する特典です。クーポンはショップの販売促進(プロモーション)のために使うことができ、多様な形で会員に発行することができます。

    Endpoints 
    GET /api/v2/admin/coupons
GET /api/v2/admin/coupons/count
POST /api/v2/admin/coupons

    Coupons properties

    Attribute Description
    shop_no

    ショップ番号

    DEFAULT 1
    coupon_no

    クーポン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

    特典区分

    特典のタイプ。タイプ別に付与する特典が異なる。
    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

    発行方式

    クーポンの発行形態のタイプ
    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

    使用期間のタイプ

    クーポンの使用可能な期間のタイプ
    available_begin_datetime

    timezone

    使用期間の開始日時

    クーポンの使用可能な期間の開始日時
    available_end_datetime

    timezone

    使用期間の終了日時

    クーポンの使用可能な期間の終了日時
    available_site
    Required

    使用対象のタイプ

    クーポンの使用可能なアクセス経路のタイプ
    available_scope

    適用範囲

    クーポンの適用可能な範囲。商品クーポンとして適用する場合は商品一つに対してクーポンが適用され、注文書クーポンとして適用する場合は注文書全体に適用される。
    available_day_from_issued

    使用可能日数

    クーポンの使用可能な日数
    available_price_type

    使用可能な購入金額のタイプ

    クーポンの使用可能な金額の基準。商品の金額が基準である場合は価格に数量を掛けた金額を基準とし、注文金額が基準である場合はその金額にその他の割引、送料が適用された金額を基準に計算する。

    U:制限なし
    O:注文金額基準
    P:商品金額基準
    available_order_price_type

    使用できる購入金額タイプの詳細

    U : 全商品の注文金額
    I : クーポン適用商品の注文金額
    available_min_price

    使用可能な購入金額

    クーポンの使用可能な購入金額
    available_amount_type

    適用計算の基準

    クーポンを適用する基準になる決済金額。クーポン割引を各種割引(会員ランク割引、商品割引など)前の注文金額に適用するか各種割引後の金額に適用するかを設定
    available_payment_method

    使用可能な決済方法

    クーポンの使用可能な決済方法

    all：制限なし
    R：銀行振込
    E：バーチャル口座
    C：クレジットカード
    A：口座振込
    H：キャリア決済
    M：ポイント
    K：KPAY
    P：Paynow
    N：PAYCO
    O：Kakaopay
    S：SmilePay
    V：Naver Pay
    B：コンビニ
    D：Toss
    available_product

    クーポン適用商品の選択

    クーポンの適用可能な商品の選択。特定の商品を除いたり適用したり、またはすべての商品に対してクーポンを適用するかどうか選択できる。
    available_product_list

    クーポン適用商品リスト
    available_category

    クーポン適用カテゴリの選択

    クーポンの適用可能なカテゴリの選択。特定のカテゴリを除いたり適用したり、またはすべてのカテゴリに対してクーポンを適用するかどうか選択できる。
    available_category_list

    クーポン適用カテゴリリスト
    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

    クーポン発行情報メールの送信設定

    クーポンの発行情報をＥメールで送信するかどうかを設定

    T:メールを送信する
    F:メールを送信しない

    DEFAULT F
    discount_amount

    割引金額
    discount_rate

    割引率

    List all coupons

    GET /api/v2/admin/coupons

    GET

    基本スペック

    Property Description
    SCOPE プロモーションの閲覧権限 (mall.read_promotion)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    coupon_no

    クーポンID

    coupon_type

    クーポンタイプ

    O:オンラインクーポン
    S:オフラインクローズドクーポン

    coupon_name

    クーポン名

    benefit_type

    特典区分

    クーポンによる特典の種類の区分

    ,(コンマ)で複数の件を検索することができる。

    A：割引金額
    B：割引率
    C：ポイント金額
    D：付与率
    E：基本送料割引(全額割引)
    I：基本送料割引(割引率)
    H：基本送料割引(割引金額)
    J：全送料タイプの割引(全額割引)
    F：即時付与
    G：預り金

    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:商品金額基準

    available_order_price_type

    使用できる購入金額タイプの詳細

    U : 全商品の注文金額
    I : クーポン適用商品の注文金額

    limit

    Min : [1]~Max : [500]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 100

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Count all coupons

    GET /api/v2/admin/coupons/count

    GET

    基本スペック

    Property Description
    SCOPE プロモーションの閲覧権限 (mall.read_promotion)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    coupon_no

    クーポンID

    coupon_type

    クーポンタイプ

    検索したいクーポンのタイプ

    O:オンラインクーポン
    S:オフラインクローズドクーポン

    coupon_name

    クーポン名

    benefit_type

    特典区分

    クーポンによる特典の種類の区分

    ,(コンマ)で複数の件を検索することができる。

    A：割引金額
    B：割引率
    C：ポイント金額
    D：付与率
    E：基本送料割引(全額割引)
    I：基本送料割引(割引率)
    H：基本送料割引(割引金額)
    J：全送料タイプの割引(全額割引)
    F：即時付与
    G：預り金

    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:商品金額基準

    available_order_price_type

    使用できる購入金額タイプの詳細

    U : 全商品の注文金額
    I : クーポン適用商品の注文金額

    Request Copy
    Response Copy

    Create a coupon

    POST /api/v2/admin/coupons

    POST

    基本スペック

    Property Description
    SCOPE プロモーションの投稿権限 (mall.write_promotion)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    coupon_name
    Required

    Length Min : [1]~Max : [50]

    クーポン名

    benefit_type
    Required

    特典区分

    A：割引金額
    B：割引率

    issue_type
    Required

    発行方式

    M：対象者指定発行

    available_period_type
    Required

    使用期間のタイプ

    F:一般期間
    R:クーポン発行日基準
    M:当月末まで使用

    available_begin_datetime

    Date
    timezone

    使用期間の開始日時

    available_end_datetime

    Date
    timezone

    使用期間の終了日時

    available_day_from_issued

    Min : [1]
    Max : [999]

    使用可能日数

    available_site
    Required

    使用対象のタイプ

    W：PCショップ専用
    M：モバイルショップ専用

    available_scope
    Required

    適用範囲

    P:商品クーポン
    O:注文書クーポン

    available_product
    Required

    クーポン適用商品の選択

    U:制限なし
    I:選択商品適用
    E:選択商品を除く

    available_product_list

    クーポン適用商品リスト

    available_category
    Required

    クーポン適用カテゴリの選択

    U:制限なし
    I:選択カテゴリ適用
    E:選択カテゴリを除く

    available_category_list

    クーポン適用カテゴリリスト

    available_amount_type
    Required

    適用計算の基準

    E:割引(クーポンを除く)適用前の決済金額
    I:割引(クーポンを除く)適用後の決済金額

    available_coupon_count_by_order
    Required

    Min : [1]
    Max : [999]

    注文書当たり同一クーポンの最大使用数

    available_price_type

    使用可能な購入金額のタイプ

    U:制限なし
    O:注文金額基準
    P:商品金額基準

    DEFAULT U

    available_order_price_type

    使用できる購入金額タイプの詳細

    U : 全商品の注文金額
    I : クーポン適用商品の注文金額

    available_min_price

    Min : [0.01]~Max : [999999999]

    使用可能な購入金額

    discount_amount

    割引金額

    benefit_price
    特典金額
    Required
    discount_rate

    割引率

    benefit_percentage
    特典割合
    Required

    benefit_percentage_round_unit
    特典割合の切り捨て単位
    Required

    benefit_percentage_max_price
    特典割合の最大金額
    Required
    Request Copy
    Response Copy

    Coupons issues

    Endpoints 
    GET /api/v2/admin/coupons/{coupon_no}/issues
POST /api/v2/admin/coupons/{coupon_no}/issues

    Coupons issues properties

    Attribute Description
    shop_no

    ショップ番号
    coupon_no

    クーポンID
    issue_no

    クーポン発行番号
    member_id

    会員ID
    group_no

    発行会員ランク番号
    issued_date

    timezone

    クーポン発行日
    expiration_date

    timezone

    満了日
    used_coupon

    クーポン使用可否
    used_date

    timezone

    クーポン使用日
    related_order_id

    関連注文
    count

    カウント

    List all coupons issues

    GET /api/v2/admin/coupons/{coupon_no}/issues

    GET

    基本スペック

    Property Description
    SCOPE プロモーションの閲覧権限 (mall.read_promotion)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    coupon_no
    Required

    クーポンID

    member_id

    Max Length : [20]

    会員ID

    group_no

    会員ランク番号

    issued_date

    Date
    timezone

    クーポン発行日

    issued_start_date

    Date
    timezone

    検索開始日

    issued_end_date

    Date
    timezone

    検索終了日

    used_coupon

    クーポン使用可否

    T:使用する
    F:使用しない

    since_issue_no

    該当のクーポンID以降の発行履歴を検索

    limit

    Max : [500]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Create a coupons issues

    POST /api/v2/admin/coupons/{coupon_no}/issues

    POST

    基本スペック

    Property Description
    SCOPE プロモーションの投稿権限 (mall.write_promotion)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    coupon_no
    Required

    クーポンID

    issued_member_scope
    Required

    会員/条件選択

    A:全会員
    G:特定会員グループ
    M:特定会員

    group_no

    会員ランク番号

    member_id

    会員ID

    send_sms_for_issue

    クーポン発行SMSの送信設定

    Cafe24管理画面(日本, ベトナム, フィリピン) では使用できません。

    T:発送する
    F:発送しない

    DEFAULT F

    allow_duplication

    重複発行設定

    T:発行する
    F:発行しない
    S:発行しない(使用の有無
    使用期間に対する追加検証をしない)

    DEFAULT F

    single_issue_per_once

    1回発行時に1枚のみ発行するか否かの設定

    T:1枚ずつ発行
    F:同時発行設定数量だけ発行

    DEFAULT T

    issue_count_per_once

    Min : [2]
    Max : [10]

    多数発行時の発行数量

    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

    Request Copy
    Response Copy

    Customers coupons

    Endpoints 
    GET /api/v2/admin/customers/{member_id}/coupons
GET /api/v2/admin/customers/{member_id}/coupons/count
DELETE /api/v2/admin/customers/{member_id}/coupons/{coupon_no}

    Customers coupons properties

    Attribute Description
    shop_no

    ショップ番号
    coupon_no

    クーポンID
    issue_no

    クーポン発行番号
    coupon_name

    クーポン名
    available_price_type

    使用可能な購入金額のタイプ

    U:制限なし
    O:注文金額基準
    P:商品金額基準
    available_price_type_detail

    使用できる購入金額タイプの詳細

    U : 全商品の注文金額
    I : クーポン適用商品の注文金額
    available_min_price

    使用可能な購入金額
    available_payment_methods

    使用可能な決済方法

    all：制限なし
    R：銀行振込
    E：バーチャル口座
    C：クレジットカード
    A：口座振込
    H：キャリア決済
    M：ポイント
    K：KPAY
    P：Paynow
    N：PAYCO
    O：Kakaopay
    S：SmilePay
    V：Naver Pay
    B：コンビニ
    D：Toss
    benefit_type

    特典区分

    G : 預り金(既存のexample項目に「G : 預り金」を追加)
    benefit_price

    特典金額
    benefit_percentage

    特典割合
    benefit_percentage_round_unit

    特典割合の切り捨て単位
    benefit_percentage_max_price

    特典割合の最大金額
    credit_amount

    預り金の付与金額
    issued_date

    timezone

    発行日
    available_begin_datetime

    timezone

    使用期間の開始日時
    available_end_datetime

    timezone

    使用期間の終了日時

    List all customers coupons

    GET /api/v2/admin/customers/{member_id}/coupons

    GET

    基本スペック

    Property Description
    SCOPE プロモーションの閲覧権限 (mall.read_promotion)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    member_id
    Required

    会員ID

    offset

    Max : [10000]

    検索結果の開始位置

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    DEFAULT 10

    Request Copy
    Response Copy

    Count all customers coupons

    GET /api/v2/admin/customers/{member_id}/coupons/count

    GET

    基本スペック

    Property Description
    SCOPE プロモーションの閲覧権限 (mall.read_promotion)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    member_id
    Required

    会員ID

    Request Copy
    Response Copy

    Delete a customers coupon

    DELETE /api/v2/admin/customers/{member_id}/coupons/{coupon_no}

    DELETE

    基本スペック

    Property Description
    SCOPE プロモーションの投稿権限 (mall.write_promotion)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    member_id
    Required

    会員ID

    coupon_no
    Required

    クーポンID

    issue_no

    クーポン発行番号

    Request Copy
    Response Copy

    Application

    Apps

    Endpoints 
    GET /api/v2/admin/apps
PUT /api/v2/admin/apps

    Apps properties

    Attribute Description
    version

    バージョン
    version_expiration_date

    バージョンの満了日
    initial_version

    初回バージョン
    previous_version

    以前のバージョン

    Get app information

    GET /api/v2/admin/apps

    GET

    基本スペック

    Property Description
    SCOPE アプリの閲覧権限 (mall.read_application)
    呼び出し件数制限 40
    Request Copy
    Response Copy

    Update an app

    PUT /api/v2/admin/apps

    PUT

    基本スペック

    Property Description
    SCOPE アプリの投稿権限 (mall.write_application)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    version
    Required

    バージョン

    Request Copy
    Response Copy

    Appstore orders

    cafe24 App Storeの注文生成APIでショップの運営者に決済時必要な金額を払わせるためにcafe24 App Storeの注文を生成することができます。

    Endpoints 
    GET /api/v2/admin/appstore/orders/{order_id}
POST /api/v2/admin/appstore/orders

    Appstore orders properties

    Attribute Description
    order_id

    注文ID

    cafe24 App Store注文の注文ID

    詳細照会を行う際にのみ確認できる。
    order_name

    注文名

    cafe24 App Store注文の注文名。注文生成時に指定可能で、ユーザーが決済時にその決済の内容が分かるようなものでなければならない。

    詳細照会を行う際にのみ確認できる。
    order_amount

    注文金額

    cafe24 App Store注文生成時に決済を要求した注文金額

    詳細照会を行う際にのみ確認できる。
    currency

    通貨単位

    詳細照会を行う際にのみ確認できる。

    KRW：￦ (韓国ウォン)
    USD：$ (米ドル)
    JPY：¥ (日本円)
    PHP：₱ (フィリピンペソ)
    return_url

    Return Url

    ユーザーが決済後に移動するページ

    詳細照会を行う際にのみ確認できる。
    automatic_payment

    Max Length : [1]

    定期課金の有無

    詳細照会を行う際にのみ確認できる。

    T:使用する
    F:使用しない
    created_date

    timezone

    注文生成日

    詳細照会を行う際にのみ確認できる。
    confirmation_url

    決済URL

    ユーザーが決済するために自動的に移動するページのアドレス

    Get an appstore order

    GET /api/v2/admin/appstore/orders/{order_id}

    GET

    基本スペック

    Property Description
    SCOPE アプリの閲覧権限 (mall.read_application)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    order_id

    注文番号

    検索したいcafe24 App Store注文番号

    Request Copy
    Response Copy

    Create an appstore order

    POST /api/v2/admin/appstore/orders

    POST

    基本スペック

    Property Description
    SCOPE アプリの投稿権限 (mall.write_application)
    呼び出し件数制限 10
    1回当たり申込件数の制限 1

    要求スペック

    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

    Request Copy
    Response Copy

    Appstore payments

    cafe24 App Storeでの注文の決済を完了した場合、cafe24 App Storeの決済検索機能を使って決済の内訳を確認することができます。

    Endpoints 
    GET /api/v2/admin/appstore/payments
GET /api/v2/admin/appstore/payments/count

    Appstore payments properties

    Attribute Description
    order_id

    決済番号

    cafe24 App Store注文の注文ID
    payment_status

    決済ステータス

    paid : 決済完了
    refund : 返金
    title

    注文名

    cafe24 App Store注文の注文名。注文生成時に指定可能で、ユーザーが決済時にその決済の内容が分かるようなものでなければならない。
    approval_no

    承認番号

    決済承認番号
    payment_gateway_name

    決済代行会社名
    payment_method

    決済方法
    payment_amount

    決済金額
    refund_amount

    返金額
    currency

    通貨単位

    KRW：￦ (韓国ウォン)
    USD：$ (米ドル)
    JPY：¥ (日本円)
    PHP：₱ (フィリピンペソ)
    locale_code

    決済先の国
    automatic_payment

    定期課金の有無

    T:使用する
    F:使用しない
    pay_date

    timezone

    決済承認日
    refund_date

    timezone

    返金承認日
    expiration_date

    timezone

    満了日

    List all appstore payments

    GET /api/v2/admin/appstore/payments

    GET

    基本スペック

    Property Description
    SCOPE アプリの閲覧権限 (mall.read_application)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    order_id

    注文番号

    検索したいcafe24 App Store注文番号

    ,(コンマ)で複数の件を検索することができる。

    start_date
    Required

    Date
    timezone

    検索開始日

    該当日以後に決済完了した注文検索

    end_date
    Required

    Date
    timezone

    検索終了日

    該当日以前に決済完了した注文検索

    currency

    通貨単位

    KRW：￦ (韓国ウォン)
    USD：$ (米ドル)
    JPY：¥ (日本円)
    PHP：₱ (フィリピンペソ)

    limit

    Min : [1]~Max : [50]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 20

    offset

    Max : [10000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Count all appstore payments

    GET /api/v2/admin/appstore/payments/count

    GET

    基本スペック

    Property Description
    SCOPE アプリの閲覧権限 (mall.read_application)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    order_id

    注文番号

    検索したいcafe24 App Store注文番号

    ,(コンマ)で複数の件を検索することができる。

    start_date
    Required

    Date
    timezone

    検索開始日

    該当日以後に決済完了した注文検索

    end_date
    Required

    Date
    timezone

    検索終了日

    該当日以前に決済完了した注文検索

    currency

    通貨単位

    KRW：￦ (韓国ウォン)
    USD：$ (米ドル)
    JPY：¥ (日本円)
    PHP：₱ (フィリピンペソ)

    Request Copy
    Response Copy

    Scripttags

    スクリプト(Scripttags)はアプリでショップの特定画面(Page)に遠隔でスクリプトを設置するために使うAPIです。スクリプトAPIを使ってショップのデザインを変更せずにショップの画面に機能を簡単に追加することができます。

    Endpoints 
    GET /api/v2/admin/scripttags
GET /api/v2/admin/scripttags/count
GET /api/v2/admin/scripttags/{script_no}
POST /api/v2/admin/scripttags
PUT /api/v2/admin/scripttags/{script_no}
DELETE /api/v2/admin/scripttags/{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」の場合、すべてのページにスクリプトが適用される。

    display_location_code

    exclude_path

    除外経路
    skin_no

    スキン番号

    スクリプトを適用するデザイン番号
    integrity

    サブリソース完全性
    created_date

    timezone

    作成日

    スクリプトの設置日
    updated_date

    timezone

    修正日

    スクリプトの修正日

    List all scripttags

    GET /api/v2/admin/scripttags

    GET

    基本スペック

    Property Description
    SCOPE アプリの閲覧権限 (mall.read_application)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    script_no

    scriptの固有番号

    スクリプトの固有番号の検索

    src

    URL

    原本script経路

    原本スクリプトの経路検索

    display_location

    画面経路

    スクリプトを表示する「画面経路」。画面経路は画面のページ経路ではなく、ショップの各ページに付与された特定の役割を意味する。
    (例: 商品カテゴリ(product_list)にスクリプトを挿入する場合、ショップで商品カテゴリとして使われるすべてのページにスクリプトが表示される)

    画面の役割はそのページに使われたモジュールによって自動付与される。任意のページに商品カテゴリモジュールを追加すると、そのページは「商品カテゴリ」の役割として認識される。ショップ管理者画面の「デザイン管理 > ショップ環境設定 > 画面経路 > 画面経路設定」で各ページに付与された画面の役割を検索・設定することができる。

    「all」の場合、すべてのページにスクリプトが適用される。

    display_location_code

    ,(コンマ)で複数の件を検索することができる。

    exclude_path

    除外経路

    ,(コンマ)で複数の件を検索することができる。

    skin_no

    スキン番号

    スクリプトを適用するデザイン番号

    ,(コンマ)で複数の件を検索することができる。

    integrity

    サブリソース完全性

    created_start_date

    Date
    timezone

    スクリプト設置日の検索開始日

    スクリプトを設置した日が該当日以後であるスクリプト検索
    検索終了日と必ずペアで使用すること。

    created_end_date

    Date
    timezone

    スクリプト設置日の検索終了日

    スクリプトを設置した日が該当日以後であるスクリプト検索
    検索終了日と必ずペアで使用すること。

    updated_start_date

    Date
    timezone

    スクリプト修正日の検索開始日

    スクリプトの修正日が該当日以後であるスクリプト検索
    検索終了日と必ずペアで使用すること。

    updated_end_date

    Date
    timezone

    スクリプト修正日の検索終了日

    スクリプトの修正日が該当日以前であるスクリプト検索
    検索開始日と必ずペアで使用すること。

    Request Copy
    Response Copy

    Count all scripttags

    GET /api/v2/admin/scripttags/count

    GET

    基本スペック

    Property Description
    SCOPE アプリの閲覧権限 (mall.read_application)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    script_no

    scriptの固有番号

    スクリプトの固有番号の検索

    src

    URL

    原本script経路

    原本スクリプトの経路検索

    display_location

    画面経路

    スクリプトを表示する「画面経路」。画面経路は画面のページ経路ではなく、ショップの各ページに付与された特定の役割を意味する。
    (例: 商品カテゴリ(product_list)にスクリプトを挿入する場合、ショップで商品カテゴリとして使われるすべてのページにスクリプトが表示される)

    画面の役割はそのページに使われたモジュールによって自動付与される。任意のページに商品カテゴリモジュールを追加すると、そのページは「商品カテゴリ」の役割として認識される。ショップ管理者画面の「デザイン管理 > ショップ環境設定 > 画面経路 > 画面経路設定」で各ページに付与された画面の役割を検索・設定することができる。

    「all」の場合、すべてのページにスクリプトが適用される。

    display_location_code

    skin_no

    スキン番号

    スクリプトを適用するデザイン番号

    ,(コンマ)で複数の件を検索することができる。

    created_start_date

    Date
    timezone

    スクリプト設置日の検索開始日

    スクリプトを設置した日が該当日以後であるスクリプト検索
    検索終了日と必ずペアで使用すること。

    created_end_date

    Date
    timezone

    スクリプト設置日の検索終了日

    スクリプトを設置した日が該当日以前であるスクリプト検索
    検索終了日と必ずペアで使用すること。

    updated_start_date

    Date
    timezone

    スクリプト修正日の検索開始日

    スクリプトの修正日が該当日以後であるスクリプト検索
    検索終了日と必ずペアで使用すること。

    updated_end_date

    Date
    timezone

    スクリプト修正日の検索終了日

    スクリプトの修正日が該当日以前であるスクリプト検索
    検索開始日と必ずペアで使用すること。

    Request Copy
    Response Copy

    Get a scripttag

    GET /api/v2/admin/scripttags/{script_no}

    GET

    基本スペック

    Property Description
    SCOPE アプリの閲覧権限 (mall.read_application)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    script_no

    scriptの固有番号

    スクリプトの固有番号の検索

    Request Copy
    Response Copy

    Create a scripttag

    POST /api/v2/admin/scripttags

    POST

    基本スペック

    Property Description
    SCOPE アプリの投稿権限 (mall.write_application)
    呼び出し件数制限 10
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    src

    URL

    原本script経路

    設置するスクリプトの原本経路(絶対経路)

    display_location
    Required

    画面経路

    スクリプトを表示する「画面経路」。画面経路は画面のページ経路ではなく、ショップの各ページに付与された特定の役割を意味する。
    (例: 商品カテゴリ(product_list)にスクリプトを挿入する場合、ショップで商品カテゴリとして使われるすべてのページにスクリプトが表示される)

    画面の役割はそのページに使われたモジュールによって自動付与される。任意のページに商品カテゴリモジュールを追加すると、そのページは「商品カテゴリ」の役割として認識される。ショップ管理者画面の「デザイン管理 > ショップ環境設定 > 画面経路 > 画面経路設定」で各ページに付与された画面の役割を検索・設定することができる。

    「all」の場合、すべてのページにスクリプトが適用される。

    display_location_code

    exclude_path

    除外経路

    skin_no

    スキン番号

    スクリプトを適用するデザイン番号

    integrity

    サブリソース完全性

    Request Copy
    Response Copy

    Update a scripttag

    PUT /api/v2/admin/scripttags/{script_no}

    PUT

    基本スペック

    Property Description
    SCOPE アプリの投稿権限 (mall.write_application)
    呼び出し件数制限 10
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    script_no
    Required

    scriptの固有番号

    スクリプトの固有番号

    src

    URL

    原本script経路

    設置するスクリプトの原本経路(絶対経路)

    display_location

    画面経路

    スクリプトを表示する「画面経路」。画面経路は画面のページ経路ではなく、ショップの各ページに付与された特定の役割を意味する。
    (例: 商品カテゴリ(product_list)にスクリプトを挿入する場合、ショップで商品カテゴリとして使われるすべてのページにスクリプトが表示される)

    画面の役割はそのページに使われたモジュールによって自動付与される。任意のページに商品カテゴリモジュールを追加すると、そのページは「商品カテゴリ」の役割として認識される。ショップ管理者画面の「デザイン管理 > ショップ環境設定 > 画面経路 > 画面経路設定」で各ページに付与された画面の役割を検索・設定することができる。

    display_location_code

    exclude_path

    除外経路

    skin_no

    スキン番号

    スクリプトを適用するデザイン番号

    integrity

    サブリソース完全性

    Request Copy
    Response Copy

    Delete a scripttag

    DELETE /api/v2/admin/scripttags/{script_no}

    DELETE

    ※ ショップ別に削除したい場合はエンドポイントの後ろに"?shop_no=N"を追加します。

    基本スペック

    Property Description
    SCOPE アプリの投稿権限 (mall.write_application)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    script_no
    Required

    scriptの固有番号

    スクリプトの固有番号

    Request Copy
    Response Copy

    Category

    Autodisplay

    Endpoints 
    GET /api/v2/admin/autodisplay
POST /api/v2/admin/autodisplay
PUT /api/v2/admin/autodisplay/{display_no}
DELETE /api/v2/admin/autodisplay/{display_no}

    Autodisplay properties

    Attribute Description
    shop_no

    ショップ番号
    display_no

    自動入替番号
    use_main

    メインカテゴリかどうか

    T: メインカテゴリ
    F: 商品カテゴリ
    category_no

    カテゴリ番号
    display_group

    商品カテゴリの詳細
    display_count

    Min : [1]~Max : [200]

    自動入替え可能な最大商品数
    use_reservation

    入替予約機能の使用有無

    T: 使用
    F: 未使用
    start_date

    timezone

    予約開始日
    use_hashtag

    ハッシュタグ使用有無

    T: 使用
    F: 未使用
    hash_tags

    ハッシュタグ
    display_sort

    ソート順

    AOD: 現在の注文数(降順)
    AOA: 現在の注文数(昇順)
    AVD: 現在の閲覧数(降順)
    AVA: 現在の閲覧数(昇順)
    ARD: 現在の注文率(降順)
    ARA: 現在の注文率(昇順)
    ACD: クリック単価(降順)
    AND: 新着商品順
    APD: 販売価格(降順)
    APA: 販売価格(昇順)→AOD: 注文数(降順)
    AOA: 注文数(昇順)
    AVD: 閲覧数(降順)
    AVA: 閲覧数(昇順)
    ARD: 注文率(降順)
    ARA: 注文率(昇順)
    ACD: クリック単価(降順)
    AND: 新着商品順
    APD: 販売価格(降順)
    APA: 販売価格(昇順)
    RD : 最近の登録商品を上に
    RA : 最近の登録商品を下に
    UD : 最近の修正商品を上に
    UA : 最近の修正商品を下に
    NA : 商品名五十音昇順
    ND : 商品名五十音降順
    PD : 販売価格が高い商品を上に
    PA :販売価格が高い商品を下に
    SD : 販売数の多い商品を上に
    SA : 販売数の多い商品を下に
    CD : 閲覧数の多い商品を上に
    CA : 閲覧数の多い商品を下に
    LD : いいね数が多い商品を上に
    LA : いいね数が多い商品を下に
    timetable

    Array Max : [24]

    アップデート時間
    period

    データの集計期間

    1.1日
    3: 3日
    7: 1週間(7日)
    30: 30日
    except_categories_scope

    除外カテゴリ設定

    A: すべてのカテゴリに適用
    C :このカテゴリのみ適用
    except_categories

    除外カテゴリ

    List all autodisplay

    GET /api/v2/admin/autodisplay

    GET

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_no

    自動入替番号

    Request Copy
    Response Copy

    Create an autodisplay

    POST /api/v2/admin/autodisplay

    POST

    基本スペック

    Property Description
    SCOPE 商品カテゴリの投稿権限 (mall.write_category)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    use_main
    Required

    メインカテゴリかどうか

    T: メインカテゴリ
    F: 商品カテゴリ

    category_no
    Required

    カテゴリ番号

    display_group
    Required

    商品カテゴリの詳細

    display_count
    Required

    Min : [1]~Max : [200]

    自動入替え可能な最大商品数

    use_reservation
    Required

    入替予約機能の使用有無

    T: 使用
    F: 未使用

    start_date

    timezone

    予約開始日

    use_hashtag
    Required

    ハッシュタグ使用有無

    T: 使用
    F: 未使用

    hash_tags

    ハッシュタグ

    display_sort

    ソート順

    AOD: 現在の注文数(降順)
    AOA: 現在の注文数(昇順)
    AVD: 現在の閲覧数(降順)
    AVA: 現在の閲覧数(昇順)
    ARD: 現在の注文率(降順)
    ARA: 現在の注文率(昇順)
    ACD: クリック単価(降順)
    AND: 新着商品順
    APD: 販売価格(降順)
    APA: 販売価格(昇順)→AOD: 注文数(降順)
    AOA: 注文数(昇順)
    AVD: 閲覧数(降順)
    AVA: 閲覧数(昇順)
    ARD: 注文率(降順)
    ARA: 注文率(昇順)
    ACD: クリック単価(降順)
    AND: 新着商品順
    APD: 販売価格(降順)
    APA: 販売価格(昇順)
    RD : 最近の登録商品を上に
    RA : 最近の登録商品を下に
    UD : 最近の修正商品を上に
    UA : 最近の修正商品を下に
    NA : 商品名五十音昇順
    ND : 商品名五十音降順
    PD : 販売価格が高い商品を上に
    PA :販売価格が高い商品を下に
    SD : 販売数の多い商品を上に
    SA : 販売数の多い商品を下に
    CD : 閲覧数の多い商品を上に
    CA : 閲覧数の多い商品を下に
    LD : いいね数が多い商品を上に
    LA : いいね数が多い商品を下に

    timetable

    Array Max : [24]

    アップデート時間

    period

    データの集計期間

    1.1日
    3: 3日
    7: 1週間(7日)
    30: 30日

    except_categories_scope

    除外カテゴリ設定

    A: すべてのカテゴリに適用
    C :このカテゴリのみ適用

    DEFAULT A

    except_categories

    除外カテゴリ

    Request Copy
    Response Copy

    Update an autodisplay

    PUT /api/v2/admin/autodisplay/{display_no}

    PUT

    基本スペック

    Property Description
    SCOPE 商品カテゴリの投稿権限 (mall.write_category)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_no
    Required

    自動入替番号

    display_count

    Min : [1]~Max : [200]

    自動入替え可能な最大商品数

    use_reservation

    入替予約機能の使用有無

    T: 使用
    F: 未使用

    start_date

    timezone

    予約開始日

    use_hashtag

    ハッシュタグ使用有無

    T: 使用
    F: 未使用

    hash_tags

    ハッシュタグ

    display_sort

    ソート順

    AOD: 現在の注文数(降順)
    AOA: 現在の注文数(昇順)
    AVD: 現在の閲覧数(降順)
    AVA: 現在の閲覧数(昇順)
    ARD: 現在の注文率(降順)
    ARA: 現在の注文率(昇順)
    ACD: クリック単価(降順)
    AND: 新着商品順
    APD: 販売価格(降順)
    APA: 販売価格(昇順)→AOD: 注文数(降順)
    AOA: 注文数(昇順)
    AVD: 閲覧数(降順)
    AVA: 閲覧数(昇順)
    ARD: 注文率(降順)
    ARA: 注文率(昇順)
    ACD: クリック単価(降順)
    AND: 新着商品順
    APD: 販売価格(降順)
    APA: 販売価格(昇順)
    RD : 最近の登録商品を上に
    RA : 最近の登録商品を下に
    UD : 最近の修正商品を上に
    UA : 最近の修正商品を下に
    NA : 商品名五十音昇順
    ND : 商品名五十音降順
    PD : 販売価格が高い商品を上に
    PA :販売価格が高い商品を下に
    SD : 販売数の多い商品を上に
    SA : 販売数の多い商品を下に
    CD : 閲覧数の多い商品を上に
    CA : 閲覧数の多い商品を下に
    LD : いいね数が多い商品を上に
    LA : いいね数が多い商品を下に

    timetable

    Array Max : [24]

    アップデート時間

    period

    データの集計期間

    1.1日
    3: 3日
    7: 1週間(7日)
    30: 30日

    except_categories_scope

    除外カテゴリ設定

    A: すべてのカテゴリに適用
    C :このカテゴリのみ適用

    except_categories

    除外カテゴリ

    Request Copy
    Response Copy

    Delete an autodisplay

    DELETE /api/v2/admin/autodisplay/{display_no}

    DELETE

    基本スペック

    Property Description
    SCOPE 商品カテゴリの投稿権限 (mall.write_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_no
    Required

    自動入替番号

    Request Copy
    Response Copy

    Categories

    Categories Resource関係図

    商品カテゴリ(Categories)はショップの顧客が見つけやすい方法で商品を表示したり分類できるカテゴリです。商品を一つ以上の商品カテゴリに表示しないと販売できません。一つの商品を複数の商品カテゴリに表示することができます。

    Endpoints 
    GET /api/v2/admin/categories
GET /api/v2/admin/categories/count
GET /api/v2/admin/categories/{category_no}
POST /api/v2/admin/categories
PUT /api/v2/admin/categories/{category_no}
DELETE /api/v2/admin/categories/{category_no}

    Categories properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    category_no

    カテゴリ番号

    商品カテゴリ固有の一連番号。ショップ内で商品カテゴリ番号は重複しない。
    category_depth

    Min : [1]~Max : [4]

    カテゴリdepth

    下位何次の商品カテゴリにあるカテゴリかを表示する。1~4次まで商品カテゴリが存在する。
    parent_category_no

    親カテゴリ番号

    商品カテゴリが2次(中カテゴリ)、3次(小カテゴリ)、4次(細カテゴリ)の場合、上位にある商品カテゴリの番号を表示する。

    parent_category_no = 1の場合、そのカテゴリは大カテゴリを意味する。
    category_name

    Max Length : [50]

    カテゴリ名

    商品カテゴリの名前を示す。
    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:在庫切れ商品を一番後ろに
    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:１カ月
    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:１カ月
    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:１カ月
    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:１カ月
    3M:3カ月
    6M:6カ月
    access_authority

    アクセス権限

    F : 全て利用可能
    T : 会員のみ利用可能
    G : 特定の会員ランクのみ利用可能
    A : 特定の運営者のみ利用可能

    List all categories

    GET /api/v2/admin/categories

    GET

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    category_depth

    Min : [1]~Max : [4]

    カテゴリdepth

    検索したい商品カテゴリの次数検索

    category_no

    カテゴリ番号

    検索したい商品カテゴリの番号

    parent_category_no

    親カテゴリ番号

    検索したい商品カテゴリの親商品カテゴリ番号検索

    大カテゴリのみ検索したい場合はparent_category_no =1で検索する。

    category_name

    カテゴリ名

    検索キーワードがカテゴリ名に含まれている商品カテゴリ検索(大文字・小文字を区別しない)

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    Request Copy
    Response Copy

    Count all categories

    GET /api/v2/admin/categories/count

    GET

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    category_depth

    Min : [1]~Max : [4]

    カテゴリdepth

    検索したい商品カテゴリの次数検索

    category_no

    カテゴリ番号

    検索したい商品カテゴリの番号

    parent_category_no

    親カテゴリ番号

    検索したい商品カテゴリの親商品カテゴリ番号検索

    大カテゴリのみ検索したい場合はparent_category_no =1で検索する。

    category_name

    カテゴリ名

    検索キーワードがカテゴリ名に含まれている商品カテゴリ検索(大文字・小文字を区別しない)

    Request Copy
    Response Copy

    Get a category

    GET /api/v2/admin/categories/{category_no}

    GET

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    検索したい商品カテゴリの番号

    Request Copy
    Response Copy

    Create a category

    POST /api/v2/admin/categories

    POST

    基本スペック

    Property Description
    SCOPE 商品カテゴリの投稿権限 (mall.write_category)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    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:在庫切れ商品を一番後ろに
    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:１カ月
    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:１カ月
    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:１カ月
    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:１カ月
    3M:3カ月
    6M:6カ月

    Request Copy
    Response Copy

    Update a category

    PUT /api/v2/admin/categories/{category_no}

    PUT

    基本スペック

    Property Description
    SCOPE 商品カテゴリの投稿権限 (mall.write_category)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    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:在庫切れ商品を一番後ろに
    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:１カ月
    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:１カ月
    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:１カ月
    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:１カ月
    3M:3カ月
    6M:6カ月

    Request Copy
    Response Copy

    Delete a category

    DELETE /api/v2/admin/categories/{category_no}

    DELETE

    基本スペック

    Property Description
    SCOPE 商品カテゴリの投稿権限 (mall.write_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    category_no
    Required

    カテゴリ番号

    Request Copy
    Response Copy

    Categories decorationimages

    Endpoints 
    GET /api/v2/admin/categories/{category_no}/decorationimages
PUT /api/v2/admin/categories/{category_no}/decorationimages

    Categories decorationimages properties

    Attribute Description
    shop_no

    ショップ番号
    category_no

    カテゴリ番号
    use_menu_image_pc

    カテゴリメニュー画像の使用設定(PC)

    T:使用する
    F:使用しない
    menu_image_pc

    カテゴリメニューのデフォルト画像(PC)
    menu_over_image_pc

    カテゴリメニューのマウスオーバー画像(PC)
    use_top_image_pc

    カテゴリ上部画像の使用設定(PC)

    T:使用する
    F:使用しない
    top_images_pc

    カテゴリの上部画像(PC)
    use_title_image_pc

    カテゴリタイトル画像の使用設定(PC)

    T:使用する
    F:使用しない
    title_image_pc

    カテゴリのタイトル画像(PC)
    use_menu_image_mobile

    カテゴリメニュー画像の使用設定(モバイル)

    T:使用する
    F:使用しない
    menu_image_mobile

    カテゴリメニューのデフォルト画像(モバイル)
    use_top_image_mobile

    カテゴリ上部画像の使用設定(モバイル)

    T:使用する
    F:使用しない
    top_images_mobile

    Array Max : [3]

    カテゴリの上部画像(モバイル)
    use_title_image_mobile

    カテゴリタイトル画像の使用設定(モバイル)

    T:使用する
    F:使用しない
    title_image_mobile

    カテゴリのタイトル画像(モバイル)

    List all categories decoration images

    GET /api/v2/admin/categories/{category_no}/decorationimages

    GET

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    Request Copy
    Response Copy

    Update a categories decorationimage

    PUT /api/v2/admin/categories/{category_no}/decorationimages

    PUT

    基本スペック

    Property Description
    SCOPE 商品カテゴリの投稿権限 (mall.write_category)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    use_menu_image_pc

    カテゴリメニュー画像の使用設定(PC)

    T:使用する
    F:使用しない

    menu_image_pc

    カテゴリメニューのデフォルト画像(PC)

    menu_over_image_pc

    カテゴリメニューのマウスオーバー画像(PC)

    use_top_image_pc

    カテゴリ上部画像の使用設定(PC)

    T:使用する
    F:使用しない

    top_images_pc

    Array Max : [3]

    カテゴリの上部画像(PC)

    use_title_image_pc

    カテゴリタイトル画像の使用設定(PC)

    T:使用する
    F:使用しない

    title_image_pc

    カテゴリのタイトル画像(PC)

    use_menu_image_mobile

    カテゴリメニュー画像の使用設定(モバイル)

    T:使用する
    F:使用しない

    menu_image_mobile

    カテゴリメニューのデフォルト画像(モバイル)

    use_top_image_mobile

    カテゴリ上部画像の使用設定(モバイル)

    T:使用する
    F:使用しない

    top_images_mobile

    Array Max : [3]

    カテゴリの上部画像(モバイル)

    use_title_image_mobile

    カテゴリタイトル画像の使用設定(モバイル)

    T:使用する
    F:使用しない

    title_image_mobile

    カテゴリのタイトル画像(モバイル)

    Request Copy
    Response Copy

    Categories seo

    Endpoints 
    GET /api/v2/admin/categories/{category_no}/seo
PUT /api/v2/admin/categories/{category_no}/seo

    Categories seo properties

    Attribute Description
    shop_no

    ショップ番号
    category_no

    カテゴリ番号
    search_engine_exposure

    検索エンジンでの表示設定

    T:使用する
    F:使用しない
    meta_title

    ブラウザでのタイトル
    meta_author

    メタタグ1:Author
    meta_description

    メタタグ2:Description
    meta_keywords

    メタタグ3:Keywords

    List all categories seo

    GET /api/v2/admin/categories/{category_no}/seo

    GET

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    Request Copy
    Response Copy

    Update a categories seo

    PUT /api/v2/admin/categories/{category_no}/seo

    PUT

    基本スペック

    Property Description
    SCOPE 商品カテゴリの投稿権限 (mall.write_category)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    search_engine_exposure

    検索エンジンでの表示設定

    T:使用する
    F:使用しない

    meta_title

    ブラウザでのタイトル

    meta_author

    メタタグ1:Author

    meta_description

    メタタグ2:Description

    meta_keywords

    メタタグ3:Keywords

    Request Copy
    Response Copy

    Mains

    Mains Resource関係図

    メインカテゴリ(Mains)はショップの商品をトップページに表示できる商品カテゴリです。

    Endpoints 
    GET /api/v2/admin/mains

    Mains properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    module_code

    モジュールコード

    各メインカテゴリに指定されたモジュールコード
    display_group

    メインカテゴリ番号
    group_name

    メインカテゴリ名

    メインカテゴリの生成時に指定したカテゴリ名
    soldout_sort_type

    在庫切れ商品の表示

    在庫切れ商品が表示される位置

    B:在庫切れ商品を一番後ろに
    N:在庫切れ商品関係なし

    List all mains

    GET /api/v2/admin/mains

    GET

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40
    Request Copy
    Response Copy

    Collection

    Brands

    ブランド(Brands)は商品の「製作情報」の中でブランドに入力する情報を意味します。ブランドはショップの商品を区分する販売カテゴリの一つで、商品は必ず一つのブランドを持っています(指定しない場合は「独自ブランド」を使う)。

    Endpoints 
    GET /api/v2/admin/brands
GET /api/v2/admin/brands/count
POST /api/v2/admin/brands
PUT /api/v2/admin/brands/{brand_code}
DELETE /api/v2/admin/brands/{brand_code}

    Brands properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1
    brand_code

    ブランドコード
    brand_name

    Max Length : [50]

    ブランド名
    use_brand

    ブランドの使用有無

    T:使用する
    F:使用しない
    search_keyword

    Max Length : [200]

    検索キーワード設定
    product_count

    商品数
    created_date

    timezone

    作成日

    List all brands

    GET /api/v2/admin/brands

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    brand_code

    ブランドコード

    ,(コンマ)で複数の件を検索することができる。

    brand_name

    ブランド名

    ,(コンマ)で複数の件を検索することができる。

    use_brand

    ブランドの使用有無

    T:使用する
    F:使用しない

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Count all brands

    GET /api/v2/admin/brands/count

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    brand_code

    ブランドコード

    ,(コンマ)で複数の件を検索することができる。

    brand_name

    ブランド名

    ,(コンマ)で複数の件を検索することができる。

    use_brand

    ブランドの使用有無

    T:使用する
    F:使用しない

    Request Copy
    Response Copy

    Create a brand

    POST /api/v2/admin/brands

    POST

    基本スペック

    Property Description
    SCOPE 販売カテゴリの投稿権限 (mall.write_collection)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    brand_name
    Required

    ブランド名

    use_brand

    ブランドの使用有無

    T:使用する
    F:使用しない

    DEFAULT T

    search_keyword

    Max Length : [200]

    検索キーワード設定

    Request Copy
    Response Copy

    Update a brand

    PUT /api/v2/admin/brands/{brand_code}

    PUT

    基本スペック

    Property Description
    SCOPE 販売カテゴリの投稿権限 (mall.write_collection)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    brand_code
    Required

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    ブランドコード

    brand_name

    ブランド名

    use_brand

    ブランドの使用有無

    T:使用する
    F:使用しない

    DEFAULT T

    search_keyword

    Max Length : [200]

    検索キーワード設定

    Request Copy
    Response Copy

    Delete a brand

    DELETE /api/v2/admin/brands/{brand_code}

    DELETE

    基本スペック

    Property Description
    SCOPE 販売カテゴリの投稿権限 (mall.write_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    brand_code
    Required

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    ブランドコード

    Request Copy
    Response Copy

    Classifications

    独自カテゴリ(Classifications)は商品の「製作情報」の中で独自カテゴリに入力する情報を意味します。商品を区分する販売カテゴリの一つで、商品は必ず一つの独自カテゴリを持っています(指定しない場合は「基本の独自カテゴリ」を使う)。

    Endpoints 
    GET /api/v2/admin/classifications
GET /api/v2/admin/classifications/count

    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

    GET /api/v2/admin/classifications

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    classification_code

    独自カテゴリコード

    ,(コンマ)で複数の件を検索することができる。

    classification_name

    独自カテゴリ名

    ,(コンマ)で複数の件を検索することができる。

    use_classification

    使用設定

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Count all classifications

    GET /api/v2/admin/classifications/count

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    classification_code

    独自カテゴリコード

    ,(コンマ)で複数の件を検索することができる。

    classification_name

    独自カテゴリ名

    ,(コンマ)で複数の件を検索することができる。

    use_classification

    使用設定

    Request Copy
    Response Copy

    Manufacturers

    メーカー(Manufacturers)は商品の「製作情報」の中でメーカーに入力する情報を意味します。メーカーは商品を製作、生産する主体を示し、商品を区分する販売カテゴリの一つです。商品は必ず一つのメーカーを持っています(指定しない場合は「独自メーカー」を使う)。

    Endpoints 
    GET /api/v2/admin/manufacturers
GET /api/v2/admin/manufacturers/count
GET /api/v2/admin/manufacturers/{manufacturer_code}
POST /api/v2/admin/manufacturers
PUT /api/v2/admin/manufacturers/{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

    GET /api/v2/admin/manufacturers

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    manufacturer_code

    メーカーコード

    検索したいメーカーのコード

    ,(コンマ)で複数の件を検索することができる。

    manufacturer_name

    メーカー名

    ,(コンマ)で複数の件を検索することができる。

    use_manufacturer

    メーカー使用の設定

    T:使用する
    F:使用しない

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    Request Copy
    Response Copy

    Count all manufacturers

    GET /api/v2/admin/manufacturers/count

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    manufacturer_code

    メーカーコード

    検索したいメーカーのコード

    ,(コンマ)で複数の件を検索することができる。

    manufacturer_name

    メーカー名

    検索キーワードがメーカー名に含まれている供給会社検索(大文字・小文字を区別しない)

    ,(コンマ)で複数の件を検索することができる。

    use_manufacturer

    メーカー使用の設定

    T:使用する
    F:使用しない

    Request Copy
    Response Copy

    Get a manufacturer

    GET /api/v2/admin/manufacturers/{manufacturer_code}

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    manufacturer_code
    Required

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    メーカーコード

    Request Copy
    Response Copy

    Create a manufacturer

    POST /api/v2/admin/manufacturers

    POST

    基本スペック

    Property Description
    SCOPE 販売カテゴリの投稿権限 (mall.write_collection)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    manufacturer_name
    Required

    メーカー名

    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:使用しない

    Request Copy
    Response Copy

    Update a manufacturer

    PUT /api/v2/admin/manufacturers/{manufacturer_code}

    PUT

    基本スペック

    Property Description
    SCOPE 販売カテゴリの投稿権限 (mall.write_collection)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    manufacturer_code
    Required

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    メーカーコード

    manufacturer_name

    メーカー名

    president_name

    代表者名

    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:使用しない

    Request Copy
    Response Copy

    Origin

    原産国(Origin)は商品が生産された地域を意味します。原産国は国外配送などに重要なデータです。カフェ24は多数の原産国をコード化しているため、原産国検索APIで原産国コード情報を確認することができます。

    Endpoints 
    GET /api/v2/admin/origin

    Origin properties

    Attribute Description
    origin_place_no

    原産国番号
    origin_place_name

    原産国名
    foreign

    海外
    made_in_code

    国名(原産国)コード

    List all origin

    GET /api/v2/admin/origin

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    origin_place_no

    原産国番号

    origin_place_name

    Max Length : [50]

    原産国名

    foreign

    海外

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    トレンド(Trends)は商品の「製作情報」の中でトレンドに入力する情報を意味します。トレンドは商品を区分する販売カテゴリの一つで、商品は必ず一つのトレンドを持っています(指定しない場合は「基本トレンド」を使う)。

    Endpoints 
    GET /api/v2/admin/trends
GET /api/v2/admin/trends/count
    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    trend_code

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    トレンドコード
    trend_name

    Max Length : [50]

    トレンド名
    use_trend

    トレンド使用の設定

    T:使用する
    F:使用しない
    created_date

    timezone

    作成日
    product_count

    商品数

    GET /api/v2/admin/trends

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    trend_code

    トレンドコード

    ,(コンマ)で複数の件を検索することができる。

    trend_name

    トレンド名

    ,(コンマ)で複数の件を検索することができる。

    use_trend

    トレンド使用の設定

    T:使用する
    F:使用しない

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    GET /api/v2/admin/trends/count

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    trend_code

    トレンドコード

    ,(コンマ)で複数の件を検索することができる。

    trend_name

    トレンド名

    ,(コンマ)で複数の件を検索することができる。

    use_trend

    トレンド使用の設定

    T:使用する
    F:使用しない

    Supply

    Suppliers

    供給会社(Suppliers)は商品の「製作情報」の中で供給会社に入力する情報を意味します。供給会社はショップに商品を供給して販売できるようにする会社または個人を意味します。供給会社は商品を区分する販売カテゴリの一つで、商品は必ず一つの供給会社を持っています(指定しない場合は「独自供給」を使う)。

    Endpoints 
    GET /api/v2/admin/suppliers
GET /api/v2/admin/suppliers/count
GET /api/v2/admin/suppliers/{supplier_code}
POST /api/v2/admin/suppliers
PUT /api/v2/admin/suppliers/{supplier_code}
DELETE /api/v2/admin/suppliers/{supplier_code}

    Suppliers properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    supplier_code

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。
    supplier_name

    Max Length : [100]

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。
    status

    ステータス

    供給会社との取引現況情報

    A:取引中
    P:取引中止
    N:取引解除
    commission

    手数料

    精算タイプが手数料型(P)の場合に使う手数料情報
    payment_period

    精算周期

    供給会社に対する精算周期を設定することができる。

    0：選択しない
    C：日次精算
    B：週次精算
    A：月次精算
    business_item

    Max Length : [255]

    取引商品タイプ

    供給会社と取り引きする商品のタイプ情報
    payment_type

    精算タイプ

    供給会社に払う金額をどのようなタイプで精算するかを設定することができる。
    手数料型 : 商品の販売価格に対する手数料を策定し、手数料金額を反映して精算する。
    買入型 : 商品登録時に入力した供給価格を基準に精算する。

    P:手数料型
    D:仕入れ型
    supplier_type

    供給会社のタイプ

    供給会社の営業形態

    卸売業者 : 最終消費者には販売せず、小売業者に販売する業者
    仕入れ業者 : 卸売業者から商品を購入して小売業者に販売する業者
    出品業者 : ショップに入店して販売している会社

    WS:卸売業者
    SF:仕入れ業者
    BS:出品業者
    ET:その他
    use_supplier

    使用設定

    その供給会社を使うかどうかを表示

    T:使用する
    F:使用しない
    created_date

    timezone

    登録日

    供給会社の情報が登録された日付
    updated_date

    timezone

    修正日

    供給会社情報が変更された日付
    country_code

    事業所住所の国コード

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    ETC : その他
    zipcode

    Max Length : [10]

    郵便番号

    供給会社の住所の郵便番号
    address1

    Max Length : [255]

    基本住所

    供給会社の住所(市区町村単位で表記)
    address2

    Max Length : [255]

    詳細住所

    供給会社の住所(詳細住所表記)
    manager_information

    担当者

    供給会社の担当者の連絡先情報
    trading_type

    供給会社の仕入れ方法

    商品が供給会社から配送される形態

    仕入れ: 商品を販売者が購入して購入者に配送する。
    直接配送: 商品の注文が入ると供給会社が購入者に直接配送する。

    詳細照会を行う際にのみ確認できる。

    D:仕入れ
    C:直接配送
    payment_method

    精算時期

    精算基準時期
    10：決済完了
    30：配送開始
    40：配送完了

    詳細照会を行う際にのみ確認できる。

    10 : 決済完了
    30 : 配送開始
    40 : 配送完了
    payment_start_day

    Min : [0]~Max : [6]

    精算開始曜日

    精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。
    0 : 毎週日曜日に精算
    1 : 毎週月曜日に精算
    2 : 毎週火曜日に精算
    3 : 毎週水曜日に精算
    4 : 毎週木曜日に精算
    5 : 毎週金曜日に精算
    6 : 毎週土曜日に精算

    詳細照会を行う際にのみ確認できる。

    0 : 日曜日
    1 : 月曜日
    2 : 火曜日
    3 : 水曜日
    4 : 木曜日
    5 : 金曜日
    6 : 土曜日
    payment_end_day

    Min : [0]~Max : [6]

    精算終了曜日

    精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。
    0 : 毎週日曜日に精算
    1 : 毎週月曜日に精算
    2 : 毎週火曜日に精算
    3 : 毎週水曜日に精算
    4 : 毎週木曜日に精算
    5 : 毎週金曜日に精算
    6 : 毎週土曜日に精算

    詳細照会を行う際にのみ確認できる。

    0 : 日曜日
    1 : 月曜日
    2 : 火曜日
    3 : 水曜日
    4 : 木曜日
    5 : 金曜日
    6 : 土曜日
    payment_start_date

    Min : [1]~Max : [31]

    精算開始日

    精算周期が月間精算(A)である場合、該当日付を精算開始日とする。

    詳細照会を行う際にのみ確認できる。
    payment_end_date

    Min : [1]~Max : [31]

    精算終了日

    精算周期が月間精算(A)である場合、該当日付を精算終了日とする。

    詳細照会を行う際にのみ確認できる。
    bank_code

    Max Length : [50]

    銀行コード

    供給会社精算時に使う口座の入金銀行コード

    bank_code

    詳細照会を行う際にのみ確認できる。
    bank_account_no

    口座番号

    供給会社精算時に使う口座の番号

    詳細照会を行う際にのみ確認できる。
    bank_account_name

    口座名義

    供給会社精算時に使う口座の名義

    詳細照会を行う際にのみ確認できる。
    phone

    Max Length : [20]

    電話番号

    供給会社の事業所の電話番号

    詳細照会を行う際にのみ確認できる。
    fax

    Max Length : [20]

    ファックス番号

    供給会社のファックス番号

    詳細照会を行う際にのみ確認できる。
    market_country_code

    市場の住所の国コード

    詳細照会を行う際にのみ確認できる。

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    ETC : その他
    market_zipcode

    Max Length : [10]

    市場の郵便番号

    詳細照会を行う際にのみ確認できる。
    market_address1

    市場の住所(基本)

    詳細照会を行う際にのみ確認できる。
    market_address2

    市場の住所(詳細)

    詳細照会を行う際にのみ確認できる。
    exchange_country_code

    事業所住所の国コード

    詳細照会を行う際にのみ確認できる。

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    ETC : その他
    exchange_zipcode

    Max Length : [10]

    返品先の郵便番号

    詳細照会を行う際にのみ確認できる。
    exchange_address1

    Max Length : [255]

    返品先の住所(基本)

    詳細照会を行う際にのみ確認できる。
    exchange_address2

    Max Length : [255]

    返品先の住所(詳細)

    詳細照会を行う際にのみ確認できる。
    homepage_url

    Max Length : [100]

    ホームページアドレス

    詳細照会を行う際にのみ確認できる。
    mall_url

    Max Length : [100]

    ショップのアドレス

    詳細照会を行う際にのみ確認できる。
    account_start_date

    Max Length : [10]

    取引開始日

    詳細照会を行う際にのみ確認できる。
    account_stop_date

    Max Length : [10]

    取引中止日

    詳細照会を行う際にのみ確認できる。
    show_supplier_info

    Max Length : [100]

    供給会社情報の表示

    詳細照会を行う際にのみ確認できる。

    SP:電話番号
    SM:事業場の住所
    MA:市場の住所
    EA:返品先の住所
    MN:担当者名
    MI:担当者の連絡先
    memo

    Max Length : [255]

    メモ

    供給会社に対する管理用メモ

    詳細照会を行う際にのみ確認できる。
    company_registration_no

    Max Length : [12]

    事業者登録番号

    供給会社の事業者登録番号。国別に事業者に固有の登録番号が発行される場合に表示する。

    詳細照会を行う際にのみ確認できる。
    company_name

    商号

    事業者登録時に供給会社が登録した商号

    詳細照会を行う際にのみ確認できる。
    president_name

    代表者名

    事業者登録時に供給会社が登録した代表者名

    詳細照会を行う際にのみ確認できる。
    company_condition

    業態

    事業者登録時に供給会社が登録した業態

    詳細照会を行う際にのみ確認できる。
    company_line

    種目

    事業者登録時に供給会社が登録した業種

    詳細照会を行う際にのみ確認できる。
    company_introduction

    会社紹介

    供給会社について簡単に紹介。ネットショップの会社概要画面に表示される。

    詳細照会を行う際にのみ確認できる。

    List all suppliers

    GET /api/v2/admin/suppliers

    GET

    基本スペック

    Property Description
    SCOPE 供給会社の情報の閲覧権限 (mall.read_supply)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    supplier_code

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。

    ,(コンマ)で複数の件を検索することができる。

    supplier_name

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

    ,(コンマ)で複数の件を検索することができる。

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Count all suppliers

    GET /api/v2/admin/suppliers/count

    GET

    基本スペック

    Property Description
    SCOPE 供給会社の情報の閲覧権限 (mall.read_supply)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    supplier_code

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。

    ,(コンマ)で複数の件を検索することができる。

    supplier_name

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

    ,(コンマ)で複数の件を検索することができる。

    Request Copy
    Response Copy

    Get a supplier

    GET /api/v2/admin/suppliers/{supplier_code}

    GET

    基本スペック

    Property Description
    SCOPE 供給会社の情報の閲覧権限 (mall.read_supply)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    supplier_code
    Required

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。

    Request Copy
    Response Copy

    Create a supplier

    POST /api/v2/admin/suppliers

    POST

    基本スペック

    Property Description
    SCOPE 供給会社の情報の投稿権限 (mall.write_supply)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    supplier_name
    Required

    Max Length : [50]

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

    manager_information

    Array Max : [3]

    担当者

    no
    担当者の一連番号
    Required

    name
    担当者の氏名
    Required

    phone
    担当者の連絡先

    email
    担当者のメールアドレス
    use_supplier

    使用設定

    その供給会社を使うかどうかを表示

    T:使用する
    F:使用しない

    DEFAULT T

    trading_type

    供給会社の仕入れ方法

    商品が供給会社から配送される形態

    仕入れ: 商品を販売者が購入して購入者に配送する。
    直接配送: 商品の注文が入ると供給会社が購入者に直接配送する。

    D:仕入れ
    C:直接配送

    DEFAULT D

    supplier_type

    供給会社のタイプ

    供給会社の営業形態

    卸売業者 : 最終消費者には販売せず、小売業者に販売する業者
    仕入れ業者 : 卸売業者から商品を購入して小売業者に販売する業者
    出品業者 : ショップに入店して販売している会社

    WS:卸売業者
    SF:仕入れ業者
    BS:出品業者
    ET:その他

    DEFAULT WS

    status

    ステータス

    供給会社との取引現況情報

    A:取引中
    P:取引中止
    N:取引解除

    DEFAULT A

    business_item

    Max Length : [255]

    取引商品タイプ

    供給会社と取り引きする商品のタイプ情報

    payment_type

    精算タイプ

    供給会社に払う金額をどのようなタイプで精算するかを設定することができる。
    手数料型 : 商品の販売価格に対する手数料を策定し、手数料金額を反映して精算する。
    買入型 : 商品登録時に入力した供給価格を基準に精算する。

    P:手数料型
    D:仕入れ型

    DEFAULT P

    payment_period

    精算周期

    供給会社に対する精算周期を設定することができる。

    0：選択しない
    C：日次精算
    B：週次精算
    A：月次精算

    payment_method

    精算時期

    精算基準時期
    10：決済完了
    30：配送開始
    40：配送完了

    10 : 決済完了
    30 : 配送開始
    40 : 配送完了

    payment_start_day

    Min : [0]~Max : [6]

    精算開始曜日

    精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。
    0 : 毎週日曜日に精算
    1 : 毎週月曜日に精算
    2 : 毎週火曜日に精算
    3 : 毎週水曜日に精算
    4 : 毎週木曜日に精算
    5 : 毎週金曜日に精算
    6 : 毎週土曜日に精算

    0 : 日曜日
    1 : 月曜日
    2 : 火曜日
    3 : 水曜日
    4 : 木曜日
    5 : 金曜日
    6 : 土曜日

    payment_end_day

    Min : [0]~Max : [6]

    精算終了曜日

    精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。
    0 : 毎週日曜日に精算
    1 : 毎週月曜日に精算
    2 : 毎週火曜日に精算
    3 : 毎週水曜日に精算
    4 : 毎週木曜日に精算
    5 : 毎週金曜日に精算
    6 : 毎週土曜日に精算

    0 : 日曜日
    1 : 月曜日
    2 : 火曜日
    3 : 水曜日
    4 : 木曜日
    5 : 金曜日
    6 : 土曜日

    payment_start_date

    Min : [1]~Max : [31]

    精算開始日

    精算周期が月間精算(A)である場合、該当日付を精算開始日とする。

    payment_end_date

    Min : [1]~Max : [31]

    精算終了日

    精算周期が月間精算(A)である場合、該当日付を精算終了日とする。

    commission

    手数料率

    精算タイプが手数料型(P)の場合に使う手数料情報

    DEFAULT 10

    phone

    Max Length : [20]
    Phone Number

    電話番号

    供給会社の事業所の電話番号

    fax

    Max Length : [20]
    Phone Number

    ファックス番号

    供給会社のファックス番号

    country_code

    事業所住所の国コード

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    VNM : ベトナム
    ETC : その他

    zipcode

    Max Length : [10]

    郵便番号

    供給会社の住所の郵便番号

    address1

    Max Length : [255]

    基本住所

    供給会社の住所(市区町村単位で表記)

    address2

    Max Length : [255]

    詳細住所

    供給会社の住所(詳細住所表記)

    market_country_code

    市場の住所の国コード

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    VNM : ベトナム
    ETC : その他

    market_zipcode

    Max Length : [10]

    市場の郵便番号

    market_address1

    市場の住所(基本)

    market_address2

    市場の住所(詳細)

    exchange_country_code

    事業所住所の国コード

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    VNM : ベトナム
    ETC : その他

    exchange_zipcode

    Max Length : [10]

    返品先の郵便番号

    exchange_address1

    Max Length : [255]

    返品先の住所(基本)

    exchange_address2

    Max Length : [255]

    返品先の住所(詳細)

    homepage_url

    Max Length : [100]

    ホームページアドレス

    mall_url

    Max Length : [100]

    ショップのアドレス

    account_start_date

    Max Length : [10]
    Date

    取引開始日

    account_stop_date

    Max Length : [10]
    Date

    取引中止日

    memo

    Max Length : [255]

    メモ

    供給会社に対する管理用メモ

    company_registration_no

    Max Length : [12]
    Business Number

    事業者登録番号

    供給会社の事業者登録番号。国別に事業者に固有の登録番号が発行される場合に表示する。

    company_name

    Max Length : [30]

    商号

    事業者登録時に供給会社が登録した商号

    president_name

    Max Length : [20]

    代表者名

    事業者登録時に供給会社が登録した代表者名

    company_condition

    Max Length : [20]

    業態

    事業者登録時に供給会社が登録した業態

    company_line

    Max Length : [20]

    種目

    事業者登録時に供給会社が登録した業種

    company_introduction

    会社紹介

    供給会社について簡単に紹介。ネットショップの会社概要画面に表示される。

    Request Copy
    Response Copy

    Update a supplier

    PUT /api/v2/admin/suppliers/{supplier_code}

    PUT

    基本スペック

    Property Description
    SCOPE 供給会社の情報の投稿権限 (mall.write_supply)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    supplier_code
    Required

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。

    supplier_name

    Max Length : [50]

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

    use_supplier

    使用設定

    その供給会社を使うかどうかを表示

    T:使用する
    F:使用しない

    trading_type

    供給会社の仕入れ方法

    商品が供給会社から配送される形態

    仕入れ: 商品を販売者が購入して購入者に配送する。
    直接配送: 商品の注文が入ると供給会社が購入者に直接配送する。

    D:仕入れ
    C:直接配送

    supplier_type

    供給会社のタイプ

    供給会社の営業形態

    卸売業者 : 最終消費者には販売せず、小売業者に販売する業者
    仕入れ業者 : 卸売業者から商品を購入して小売業者に販売する業者
    出品業者 : ショップに入店して販売している会社

    WS:卸売業者
    SF:仕入れ業者
    BS:出品業者
    ET:その他

    status

    ステータス

    供給会社との取引現況情報

    A:取引中
    P:取引中止
    N:取引解除

    payment_type

    精算タイプ

    供給会社に払う金額をどのようなタイプで精算するかを設定することができる。
    手数料型 : 商品の販売価格に対する手数料を策定し、手数料金額を反映して精算する。
    買入型 : 商品登録時に入力した供給価格を基準に精算する。

    P:手数料型
    D:仕入れ型

    payment_period

    精算周期

    供給会社に対する精算周期を設定することができる。

    0：選択しない
    C：日次精算
    B：週次精算
    A：月次精算

    commission

    手数料率

    精算タイプが手数料型(P)の場合に使う手数料情報

    manager_information

    Array Max : [3]

    担当者

    no
    担当者の一連番号
    Required

    name
    担当者の氏名
    Required

    phone
    担当者の連絡先

    email
    担当者のメールアドレス

    use_sms
    SMS

    T:受信する、F:受信しない
    business_item

    Max Length : [255]

    取引商品タイプ

    供給会社と取り引きする商品のタイプ情報

    payment_method

    精算時期

    精算基準時期
    10：決済完了
    30：配送開始
    40：配送完了

    10 : 決済完了
    30 : 配送開始
    40 : 配送完了

    payment_start_day

    Min : [0]~Max : [6]

    精算開始曜日

    精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。
    0 : 毎週日曜日に精算
    1 : 毎週月曜日に精算
    2 : 毎週火曜日に精算
    3 : 毎週水曜日に精算
    4 : 毎週木曜日に精算
    5 : 毎週金曜日に精算
    6 : 毎週土曜日に精算

    0 : 日曜日
    1 : 月曜日
    2 : 火曜日
    3 : 水曜日
    4 : 木曜日
    5 : 金曜日
    6 : 土曜日

    payment_end_day

    Min : [0]~Max : [6]

    精算終了曜日

    精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。
    0 : 毎週日曜日に精算
    1 : 毎週月曜日に精算
    2 : 毎週火曜日に精算
    3 : 毎週水曜日に精算
    4 : 毎週木曜日に精算
    5 : 毎週金曜日に精算
    6 : 毎週土曜日に精算

    0 : 日曜日
    1 : 月曜日
    2 : 火曜日
    3 : 水曜日
    4 : 木曜日
    5 : 金曜日
    6 : 土曜日

    payment_start_date

    Min : [1]~Max : [31]

    精算開始日

    精算周期が月間精算(A)である場合、該当日付を精算開始日とする。

    payment_end_date

    Min : [1]~Max : [31]

    精算終了日

    精算周期が月間精算(A)である場合、該当日付を精算終了日とする。

    phone

    Max Length : [20]
    Phone Number

    電話番号

    供給会社の事業所の電話番号

    fax

    Max Length : [20]
    Phone Number

    ファックス番号

    供給会社のファックス番号

    country_code

    事業所住所の国コード

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    VNM : ベトナム
    ETC : その他

    zipcode

    Max Length : [10]

    郵便番号

    供給会社の住所の郵便番号

    address1

    Max Length : [255]

    基本住所

    供給会社の住所(市区町村単位で表記)

    address2

    Max Length : [255]

    詳細住所

    供給会社の住所(詳細住所表記)

    market_country_code

    市場の住所の国コード

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    VNM : ベトナム
    ETC : その他

    market_zipcode

    Max Length : [10]

    市場の郵便番号

    market_address1

    市場の住所(基本)

    market_address2

    市場の住所(詳細)

    exchange_country_code

    事業所住所の国コード

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    VNM : ベトナム
    ETC : その他

    exchange_zipcode

    Max Length : [10]

    返品先の郵便番号

    exchange_address1

    Max Length : [255]

    返品先の住所(基本)

    exchange_address2

    Max Length : [255]

    返品先の住所(詳細)

    homepage_url

    Max Length : [100]

    ホームページアドレス

    mall_url

    Max Length : [100]

    ショップのアドレス

    account_start_date

    Max Length : [10]
    Date

    取引開始日

    account_stop_date

    Max Length : [10]
    Date

    取引中止日

    memo

    Max Length : [255]

    メモ

    供給会社に対する管理用メモ

    company_registration_no

    Max Length : [12]
    Business Number

    事業者登録番号

    供給会社の事業者登録番号。国別に事業者に固有の登録番号が発行される場合に表示する。

    company_name

    Max Length : [30]

    商号

    事業者登録時に供給会社が登録した商号

    president_name

    Max Length : [20]

    代表者名

    事業者登録時に供給会社が登録した代表者名

    company_condition

    Max Length : [20]

    業態

    事業者登録時に供給会社が登録した業態

    company_line

    Max Length : [20]

    種目

    事業者登録時に供給会社が登録した業種

    company_introduction

    会社紹介

    供給会社について簡単に紹介。ネットショップの会社概要画面に表示される。

    Request Copy
    Response Copy

    Delete a supplier

    DELETE /api/v2/admin/suppliers/{supplier_code}

    DELETE

    基本スペック

    Property Description
    SCOPE 供給会社の情報の投稿権限 (mall.write_supply)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    supplier_code
    Required

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    供給会社のコード

    Request Copy
    Response Copy

    Suppliers users

    供給会社の運営者(Supplier Users)は供給会社がショップにログインして商品を直接登録する場合に使います。供給会社の運営者に商品のアップロード、カテゴリ管理、掲示板管理など制限的な権限を付与することができます。

    Endpoints 
    GET /api/v2/admin/suppliers/users
GET /api/v2/admin/suppliers/users/count
GET /api/v2/admin/suppliers/users/{user_id}

    Suppliers users properties

    Attribute Description
    user_id

    Type : [a-zA-Z0-9]
    Max Length : [20]

    供給会社の運営者ID

    供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。
    supplier_code

    Max Length : [8]

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。
    supplier_name

    Max Length : [100]

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。
    permission_category_select

    商品登録時のカテゴリ選択権限

    供給会社の運営者が商品登録時に商品カテゴリを選択して登録できる権限を設定

    T:許容する
    F:許容しない
    permission_product_modify

    商品修正の権限

    供給会社の運営者が商品を登録した後、商品情報を修正できる権限を設定

    T:許容する
    F:許容しない
    permission_product_display

    商品表示の権限

    供給会社の運営者が商品を登録した後、ショップの画面に表示できる権限を設定

    T:許容する
    F:許容しない
    permission_product_selling

    商品販売の権限

    供給会社の運営者が商品を登録した後、その商品の販売有無を設定できる権限を設定

    T:許容する
    F:許容しない
    permission_product_delete

    登録商品の削除権限

    供給会社の運営者が自分で登録した商品を削除できる権限を設定

    T:許容する
    F:許容しない
    permission_board_manage

    掲示板の権限設定

    供給会社の運営者がショップの掲示板にアクセスできる権限を設定

    T:許容する
    F:許容しない
    user_name

    供給会社の運営者

    供給会社の運営者の名前。供給会社の運営者名は供給会社の運営者がショップ管理者画面で作業をする場合、「作業を実行した人(処理者)」の部分に表示される名前を意味する。
    供給会社運営者の詳細検索APIでしか確認できない。

    詳細照会を行う際にのみ確認できる。
    nick_name

    Length Min : [4]~Max : [20]

    運営者ニックネーム

    供給会社の運営者のニックネーム。供給会社の運営者のニックネームは供給会社の運営者が掲示板に投稿する際に「投稿者」に表示されるニックネームを意味する(ただ、その掲示板が作成者名の代わりに「ニックネーム」を表示するように設定されている場合に限る)。
    供給会社の運営者の詳細検索APIでしか確認できない。

    詳細照会を行う際にのみ確認できる。
    nick_name_icon_type

    ニックネームアイコンのタイプ

    供給会社の運営者のニックネームの横に表示されるアイコンを設定することができる。

    直接アイコン登録 : ニックネームアイコンを直接アップロードして設定することができる。
    サンプルアイコン登録 : 事前に提供されているアイコンを選択して設定することができる。
    供給会社運営者の詳細検索APIでしか確認できない。

    詳細照会を行う際にのみ確認できる。

    D:直接
    S:サンプル
    nick_name_icon_url

    Max Length : [255]

    ニックネームアイコンのURL

    供給会社の運営者のニックネームアイコンの画像経路

    供給会社運営者の詳細検索APIでしか確認できない。

    詳細照会を行う際にのみ確認できる。
    use_nick_name_icon

    掲示板へのニックネームアイコン表示設定

    供給会社の運営者が掲示板に投稿する際、ニックネームアイコンを表示するかどうかを設定

    供給会社運営者の詳細検索APIでしか確認できない。

    詳細照会を行う際にのみ確認できる。

    T:表示
    F:表示しない
    use_writer_name_icon

    掲示板への作成者表示設定

    供給会社の運営者が掲示板に投稿する際、作成者名を表示するかどうかを設定

    供給会社運営者の詳細検索APIでしか確認できない。

    詳細照会を行う際にのみ確認できる。

    T:表示
    F:表示しない
    email

    メールアドレス

    供給会社の運営者のメールアドレス。供給会社の運営者の連絡先を保存する目的で使う。

    供給会社の運営者の詳細検索APIでしか確認できない。

    詳細照会を行う際にのみ確認できる。
    phone

    電話番号

    供給会社の運営者の電話番号。供給会社の運営者の連絡先を保存する目的で使う。

    供給会社の運営者の詳細検索APIでのみ確認が可能。

    詳細照会を行う際にのみ確認できる。
    permission_shop_no

    アクセス可能ショップ

    マルチショップを区分するために使うショップ番号

    詳細照会を行う際にのみ確認できる。
    permitted_category_list

    商品登録時に許容される商品カテゴリ

    供給会社の運営者が商品登録時に選択可能な商品カテゴリ。供給会社の運営者は商品登録時にその商品カテゴリにしか商品をアップロードすることができない。

    供給会社運営者の詳細検索APIでしか確認できない。

    詳細照会を行う際にのみ確認できる。

    List all suppliers users

    GET /api/v2/admin/suppliers/users

    GET

    基本スペック

    Property Description
    SCOPE 供給会社の情報の閲覧権限 (mall.read_supply)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    user_id

    Type : [a-zA-Z0-9]
    Max Length : [20]

    供給会社の運営者ID

    供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。

    supplier_code

    Max Length : [8]

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。

    supplier_name

    Max Length : [100]

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

    Request Copy
    Response Copy

    Count all suppliers users

    GET /api/v2/admin/suppliers/users/count

    GET

    基本スペック

    Property Description
    SCOPE 供給会社の情報の閲覧権限 (mall.read_supply)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    user_id

    Type : [a-zA-Z0-9]
    Max Length : [20]

    供給会社の運営者ID

    供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。

    supplier_code

    Max Length : [8]

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。

    supplier_name

    Max Length : [100]

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

    Request Copy
    Response Copy

    Get a suppliers user

    GET /api/v2/admin/suppliers/users/{user_id}

    GET

    基本スペック

    Property Description
    SCOPE 供給会社の情報の閲覧権限 (mall.read_supply)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    user_id

    Type : [a-zA-Z0-9]
    Max Length : [20]

    供給会社の運営者ID

    供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。

    Request Copy
    Response Copy

    Shipping

    Carriers

    Endpoints 
    GET /api/v2/admin/carriers
GET /api/v2/admin/carriers/{carrier_id}
POST /api/v2/admin/carriers
PUT /api/v2/admin/carriers/{carrier_id}
DELETE /api/v2/admin/carriers/{carrier_id}

    Carriers properties

    Attribute Description
    shop_no

    ショップ番号
    carrier_id

    配送会社ID
    shipping_carrier_code

    配送会社コード

    shipping_company_code

    shipping_carrier

    配送会社名
    track_shipment_url

    配送追跡URL
    shipping_type

    国内/海外配送の設定

    A：国内
    B：国内/海外
    C：海外
    contact

    代表連絡先
    secondary_contact

    緊急連絡先
    email

    メールアドレス
    default_shipping_fee

    基本送料
    homepage_url

    ホームページアドレス
    default_shipping_carrier

    基本配送会社かどうか

    T:使用する
    F:使用しない
    shipping_fee_setting

    送料の設定有無

    T:使用する
    F:使用しない
    shipping_fee_setting_detail

    送料設定データ
    express_exception_setting

    連携配送における例外情報設定の使用有無
    links

    link

    List all carriers

    GET /api/v2/admin/carriers

    GET

    基本スペック

    Property Description
    SCOPE 配送の閲覧権限 (mall.read_shipping)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    Request Copy
    Response Copy

    Get a carrier

    GET /api/v2/admin/carriers/{carrier_id}

    GET

    基本スペック

    Property Description
    SCOPE 配送の閲覧権限 (mall.read_shipping)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    carrier_id
    Required

    配送会社ID

    Request Copy
    Response Copy

    Create a carrier

    POST /api/v2/admin/carriers

    POST

    基本スペック

    Property Description
    SCOPE 配送の投稿権限 (mall.write_shipping)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    shipping_carrier_code
    Required

    配送会社コード

    shipping_company_code

    contact
    Required

    Max Length : [16]

    代表連絡先

    email
    Required

    Email
    Max Length : [255]

    メールアドレス

    shipping_carrier

    Max Length : [80]

    配送会社名

    track_shipment_url

    Max Length : [255]

    配送追跡URL

    secondary_contact

    Max Length : [16]

    緊急連絡先

    default_shipping_fee

    基本送料

    homepage_url

    Max Length : [255]

    ホームページアドレス

    shipping_fee_setting

    送料の設定有無

    T:使用する
    F:使用しない

    DEFAULT F

    shipping_fee_setting_detail

    送料設定データ

    shipping_type
    国内/海外配送の設定
    DEFAULT B
    A：国内、B：国内/海外、C：海外

    available_shipping_zone
    配送可能地域

    min_shipping_period
    配送にかかる日数(最短日)

    max_shipping_period
    配送にかかる日数(最長日)

    shipping_information
    注文書の配送案内文

    shipping_fee_setting_domestic Array
    国内配送の設定値

    shipping_fee_type
    送料設定

    shipping_fee
    送料

    min_price
    送料が適用される金額(設定金額未満の場合)

    use_product_category
    商品カテゴリ適用

    product_category_list Array
    選択した商品カテゴリを適用したカテゴリ一覧

    category_no
    カテゴリ番号

    shipping_fee_criteria
    送料を適用する注文金額の条件設定

    domestic_shipping_fee_list Array
    国内送料一覧

    min_value
    範囲金額の最小値

    max_value
    範囲金額の最大値

    shipping_fee
    送料

    available_shipping_zone
    配送可能地域設定

    available_shipping_zone_list Array
    配送可能地域一覧

    region
    配送可能地域名

    start_zipcode
    開始郵便番号

    end_zipcode
    終了郵便番号

    available_order_time
    注文可能時間設定

    start_time
    注文可能開始時間

    end_time
    注文可能終了時間

    shipping_fee_setting_oversea Array
    海外配送の設定値

    shipping_fee_criteria
    送料を適用する注文金額の条件設定

    shipping_country_list Array
    配送先の国一覧

    country_code
    国コード

    country_shipping_fee_list Array
    国別の送料一覧

    country_code
    国コード

    conditional
    範囲条件

    min_value
    範囲金額の最小値

    max_value
    範囲金額の最大値

    shipping_fee
    送料

    additional_handling_fee
    海外配送付加金額の設定

    additional_handling_fee_list Array
    海外配送付加金額一覧

    country_code
    国コード

    text
    付加金額名

    min_value
    範囲金額の最小値

    max_value
    範囲金額の最大値

    additional_handling_fee
    海外配送付加金額

    unit
    海外配送付加金額の単位(定額/定率)

    rounding_unit
    切り捨て単位

    rounding_rule
    切り捨て方法

    maximum_quantity
    購入数量の制限

    product_category_limit
    商品カテゴリ制限設定

    product_category_limit_list Array
    商品カテゴリ制限一覧

    category_no
    カテゴリ番号

    product_maximum_quantity
    商品カテゴリ別の購入数量制限
    Request Copy
    Response Copy

    Update a carrier

    PUT /api/v2/admin/carriers/{carrier_id}

    PUT

    基本スペック

    Property Description
    SCOPE 配送の投稿権限 (mall.write_shipping)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    carrier_id
    Required

    配送会社ID

    default_shipping_carrier

    基本配送会社かどうか

    T:使用する
    F:使用しない

    DEFAULT T

    Request Copy
    Response Copy

    Delete a carrier

    DELETE /api/v2/admin/carriers/{carrier_id}

    DELETE

    基本スペック

    Property Description
    SCOPE 配送の投稿権限 (mall.write_shipping)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    carrier_id
    Required

    配送会社ID

    Request Copy
    Response Copy

    Shipping

    Endpoints 
    GET /api/v2/admin/shipping

    Shipping properties

    Attribute Description
    shop_no

    ショップ番号
    shipping_method

    配送方法

    shipping_01 : 配送
    shipping_02 : 速達郵便
    shipping_04 : 直接配送
    shipping_05 : クイック配送
    shipping_06 : その他
    shipping_07 : 貨物配送
    shipping_08 : 店舗受取
    shipping_09 : 配送不要
    shipping_etc

    その他配送
    shipping_type

    国内/海外配送設定

    A : 国内配送
    C : 海外配送
    B : 国内/海外配送
    shipping_period

    配送期間
    shipping_fee_type

    送料タイプ

    T:送料無料
    R:固定送料を使用
    M:購入金額によって課金
    D:購入金額別送料を使用
    W:商品の重量別送料を使用
    C:商品の数量別送料を使用
    N:商品の数量に比例して送料を課金
    shipping_fee

    Max : [999999999]

    送料
    free_shipping_price

    Max : [999999999]

    送料無料の基準金額
    shipping_fee_by_quantity

    Max : [999999999]

    商品数別送料
    shipping_rates

    送料詳細設定
    shipping_fee_criteria

    送料を適用する注文金額の条件設定

    D：割引前の販売価格(推奨)
    L : 実際の決済金額
    A : 割引適用後の決済金額
    R : 実際の決済金額の基準
    product_weight

    商品の重量
    oversea_shipping_country

    海外配送対象国の制限設定

    T：制限する
    F：制限しない
    oversea_shipping_country_list

    配送先の国
    country_shipping_fee

    国別送料設定の使用有無

    T：使用する
    F：使用しない
    country_shipping_fee_list

    国別送料
    international_shipping_insurance

    海外配送保険料

    T：使用する
    F：使用しない
    return_address

    返品先の住所
    package_volume

    荷物サイズ

    List all shipping

    GET /api/v2/admin/shipping

    GET

    基本スペック

    Property Description
    SCOPE 配送の閲覧権限 (mall.read_shipping)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    Request Copy
    Response Copy

    Salesreport

    Reports salesvolume

    販売数量(SalesVolume)はショップの商品が販売された数量を意味します。販売数量は定期的に集計及びアップデートされるため、リアルタイムで反映されないことがあります。

    Endpoints 
    GET /api/v2/admin/reports/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

    GET /api/v2/admin/reports/salesvolume

    GET

    基本スペック

    Property Description
    SCOPE 売上統計の閲覧権限 (mall.read_salesreport)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    product_no

    商品番号

    商品固有の一連番号。ショップ内で商品番号は重複しない。

    照会の際、商品番号(product_no)と品目コード(variant_code)のうちいずれか１つは必ず含まなければならない。

    ,(コンマ)で複数の件を検索することができる。

    variants_code

    品目コード

    販売数量を検索する品目コード

    照会の際、商品番号(product_no)と品目コード(variant_code)のうちいずれか１つは必ず含まなければならない。

    category_no

    カテゴリ番号

    販売数量の中で特定カテゴリで販売された数量の検索

    mobile

    モバイル/PC

    販売数量の中でモバイルウェブで販売された数量の検索

    T:モバイル
    F:その外

    delivery_type

    配送タイプ

    販売数量の中で国内または海外配送数量の検索

    A:国内
    B:海外

    customer_group_no

    会員ランク番号

    販売数量のうち、特定会員ランクで注文された数量の検索

    group_no

    会員ランク番号

    supplier_id

    Max Length : [20]

    供給会社のID

    販売数量の中で特定の供給会社のIDで登録された数量の検索

    start_date
    Required

    Date
    timezone

    検索開始日

    販売数量を検索する検索開始日(注文日基準)
    検索終了日と必ずペアで使用すること。

    end_date
    Required

    Date
    timezone

    検索終了日

    販売数量を検索する検索終了日(注文日基準)
    検索開始日と必ずペアで使用すること。

    Request Copy
    Response Copy

    Personal

    Carts

    Endpoints 
    GET /api/v2/admin/carts

    Carts properties

    Attribute Description
    shop_no

    ショップ番号
    basket_product_no

    カート内の商品番号
    member_id

    会員ID
    created_date

    timezone

    追加日
    product_no

    商品番号
    additional_option_values

    追加入力オプション
    variant_code

    Type : [A-Z0-9]
    Length Min : [12]~Max : [12]

    商品品目コード
    quantity

    数量
    product_price

    商品販売価格
    option_price

    オプション追加価格
    product_bundle

    セット商品の有無

    T:セット商品
    F:セット商品ではない
    shipping_type

    配送タイプ

    A:国内
    B:海外
    category_no

    カテゴリ番号

    List all carts

    GET /api/v2/admin/carts

    GET

    基本スペック

    Property Description
    SCOPE 個人化情報の閲覧権限 (mall.read_personal)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    member_id
    Required

    会員ID

    ,(コンマ)で複数の件を検索することができる。

    offset

    Max : [10000]

    検索結果の開始位置

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    DEFAULT 10

    Request Copy
    Response Copy

    Customers wishlist

    「Customers wishlist」は会員のお気に入りを照会できるリレーショナルリソースです。

    Endpoints 
    GET /api/v2/admin/customers/{member_id}/wishlist
GET /api/v2/admin/customers/{member_id}/wishlist/count

    Customers wishlist properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    wishlist_no

    お気に入り番号
    product_no

    商品番号
    variant_code

    Type : [A-Z0-9]
    Length Min : [12]~Max : [12]

    品目コード

    システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。
    additional_option

    追加入力オプション
    attached_file_option

    ファイル添付オプション
    price

    商品販売価格

    商品の販売価格。クーポン及び特典を適用する前の価格
    商品登録時にはマルチショップに同じ価格で登録するが、ショップ別に異なる価格を入力したい場合は商品修正を通じて異なる価格を入力することができる。
    ※ 販売価格 = [ 原価 + (原価 * 売上総利益率) + 追加金額 ]
    product_bundle

    セット商品の有無
    created_date

    timezone

    追加日

    商品をお気に入りに追加した日付
    price_content

    Max Length : [20]

    販売価格の代替メッセージ

    List all customers wishlist

    GET /api/v2/admin/customers/{member_id}/wishlist

    GET

    会員のお気に入り商品リストを照会

    基本スペック

    Property Description
    SCOPE 個人化情報の閲覧権限 (mall.read_personal)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    member_id
    Required

    会員ID

    shop_no

    ショップ番号

    DEFAULT 1

    Request Copy
    Response Copy

    Count all customers wishlist

    GET /api/v2/admin/customers/{member_id}/wishlist/count

    GET

    会員のお気に入り商品数を照会

    基本スペック

    Property Description
    SCOPE 個人化情報の閲覧権限 (mall.read_personal)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    member_id
    Required

    会員ID

    shop_no

    ショップ番号

    DEFAULT 1

    Request Copy
    Response Copy

    Products carts

    Endpoints 
    GET /api/v2/admin/products/{product_no}/carts
GET /api/v2/admin/products/{product_no}/carts/count

    Products carts properties

    Attribute Description
    shop_no

    ショップ番号
    member_id

    会員ID
    created_date

    timezone

    追加日
    product_no

    商品番号
    variant_code

    商品品目コード
    quantity

    数量
    product_bundle

    セット商品の有無

    T:セット商品
    F:セット商品ではない

    List all products carts

    GET /api/v2/admin/products/{product_no}/carts

    GET

    基本スペック

    Property Description
    SCOPE 個人化情報の閲覧権限 (mall.read_personal)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [10000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Count all products carts

    GET /api/v2/admin/products/{product_no}/carts/count

    GET

    基本スペック

    Property Description
    SCOPE 個人化情報の閲覧権限 (mall.read_personal)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    Request Copy
    Response Copy

    Privacy

    Customersprivacy

    「Customersprivacy」は、特定会員の個人情報に対するリソースです。個人情報が流出されないように、使用に注意を払う必要があります。

    Endpoints 
    GET /api/v2/admin/customersprivacy
GET /api/v2/admin/customersprivacy/count
GET /api/v2/admin/customersprivacy/{member_id}
PUT /api/v2/admin/customersprivacy/{member_id}

    Customersprivacy properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    member_id

    Max Length : [20]

    会員ID
    name

    お名前

    会員の名前
    name_english

    お名前(ローマ字)

    会員の名前(ローマ字）
    name_phonetic

    お名前(フリガナ)(日本語)

    会員の名前のフリガナ表記
    phone

    電話番号

    会員の固定電話番号
    cellphone

    電話番号(携帯)

    会員の携帯電話番号
    email

    メールアドレス

    会員のメールアドレス
    sms

    SMS

    SMSを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。

    T:受信する
    F:受信しない
    news_mail

    メールマガジン受信の有無

    Ｅメールを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。「絶対受信しない」の場合は主要メールを含めてすべてのメールを受信しない。

    T:受信する
    F:受信しない
    wedding_anniversary

    Date

    結婚記念日

    会員の結婚記念日
    birthday

    Date

    誕生日

    会員の生年月日
    solar_calendar

    新暦/旧暦

    誕生日が新暦か旧暦かを表示

    T:新暦
    F:旧暦
    total_points

    ポイント合計
    available_points

    使用可能ポイント
    used_points

    ポイント利用額
    city

    Max Length : [255]

    市区町村
    state

    Max Length : [255]

    都道府県
    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:設定しない
    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:国際運転免許証
    lifetime_member

    永久会員への切り替えに関する同意の有無

    T：同意する F：同意しない
    corporate_name

    法人名

    会員の法人名
    nationality

    国籍

    会員が「外国人」の場合、その会員の国籍
    shop_name

    ショップ名

    会員の商号
    country_code

    国コード

    会員登録時に入力した国家
    use_mobile_app

    スマホアプリ使用の設定

    会員のモバイルアプリ使用の設定

    T:使用する
    F:使用しない
    join_path

    会員登録ルート

    P:PC
    M：モバイル
    fixed_group

    会員ランクの固定設定

    T：固定する
    F：固定しない
    available_credits

    使用可能預り金

    詳細照会を行う際にのみ確認できる。
    additional_information

    追加項目

    会員の追加項目
    会員詳細検索APIでしか確認できない。

    詳細照会を行う際にのみ確認できる。

    List all customersprivacy

    GET /api/v2/admin/customersprivacy

    GET

    基本スペック

    Property Description
    SCOPE 個人情報の閲覧権限 (mall.read_privacy)
    呼び出し件数制限 40

    要求スペック

    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

    news_mail

    メールマガジン受信の有無

    Ｅメールを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。「絶対受信しない」の場合は主要メールを含めてすべてのメールを受信しない。

    T:受信する
    F:受信しない

    sms

    SMS

    SMSを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。

    T:受信する
    F:受信しない

    group_no

    会員ランク番号

    会員ランクの番号

    search_field

    検索フィールド

    検索したい会員の検索フィールド

    id：会員ID
    name：氏名
    hp：電話番号(携帯)
    tel：電話番号(固定)
    mail：メールアドレス
    shop_name：商号

    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:統合メンバーシップ利用者

    member_class

    会員区分

    Cafe24管理画面(日本, ベトナム) では使用できません。

    p:個人
    c:事業者
    f:外国人

    residence

    地域コード

    会員の居住地域

    ,(コンマ)で複数の件を検索することができる。

    gender

    性別

    会員の性別

    M:男性
    F:女性

    member_authority

    会員権限区分

    会員権限の区分。会員権限は一般会員、代表運営者、副運営者、供給会社に区分される。

    C:一般会員
    P:代表運営者
    A:副運営者
    S:供給会社

    DEFAULT C

    join_path

    会員登録ルート

    P:PC
    M：モバイル

    use_mobile_app

    スマホアプリ使用の設定

    T:使用する
    F:使用しない

    fixed_group

    会員ランクの固定設定

    T：固定する
    F：固定しない

    limit

    Min : [1]~Max : [1000]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 30

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Count all customersprivacy

    GET /api/v2/admin/customersprivacy/count

    GET

    基本スペック

    Property Description
    SCOPE 個人情報の閲覧権限 (mall.read_privacy)
    呼び出し件数制限 40

    要求スペック

    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

    news_mail

    メールマガジン受信の有無

    Ｅメールを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。「絶対受信しない」の場合は主要メールを含めてすべてのメールを受信しない。

    T:受信する
    F:受信しない

    sms

    SMS

    イベントSMSを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。

    T:受信する
    F:受信しない

    group_no

    会員ランク番号

    会員ランクの番号

    search_field

    検索フィールド

    検索したい会員の検索フィールド

    id：会員ID
    name：氏名
    hp：電話番号(携帯)
    tel：電話番号(固定)
    mail：メールアドレス
    shop_name：商号

    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:統合メンバーシップ利用者

    member_class

    会員区分

    Cafe24管理画面(日本, ベトナム) では使用できません。

    p:個人
    c:事業者
    f:外国人

    residence

    地域コード

    会員の居住地域

    ,(コンマ)で複数の件を検索することができる。

    gender

    性別

    会員の性別

    M:男性
    F:女性

    member_authority

    会員権限区分

    会員権限の区分。会員権限は一般会員、代表運営者、副運営者、供給会社に区分される。

    C:一般会員
    P:代表運営者
    A:副運営者
    S:供給会社

    DEFAULT C

    join_path

    会員登録ルート

    P:PC
    M：モバイル

    use_mobile_app

    スマホアプリ使用の設定

    T:使用する
    F:使用しない

    fixed_group

    会員ランクの固定設定

    T：固定する
    F：固定しない

    Request Copy
    Response Copy

    Get a customersprivacy

    GET /api/v2/admin/customersprivacy/{member_id}

    GET

    基本スペック

    Property Description
    SCOPE 個人情報の閲覧権限 (mall.read_privacy)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    member_id
    Required

    Max Length : [20]

    会員ID

    Request Copy
    Response Copy

    Update a customersprivacy

    PUT /api/v2/admin/customersprivacy/{member_id}

    PUT

    基本スペック

    Property Description
    SCOPE 個人情報の投稿権限 (mall.write_privacy)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    member_id
    Required

    Max Length : [20]

    会員ID

    cellphone

    電話番号(携帯)

    email

    Email

    メールアドレス

    sms

    SMS

    T:受信する
    F:受信しない

    news_mail

    メールマガジン受信の有無

    T:受信する
    F:受信しない

    birthday

    誕生日

    solar_calendar

    新暦/旧暦

    T:新暦
    F:旧暦

    address1

    Max Length : [255]

    基本住所

    address2

    Max Length : [255]

    詳細住所

    zipcode

    Max Length : [14]

    郵便番号

    additional_information

    追加項目

    key
    追加項目のキー

    value
    追加項目の値
    city

    Max Length : [255]

    市区町村

    state

    Max Length : [255]

    都道府県

    fixed_group

    会員ランクの固定設定

    T：固定する
    F：固定しない

    Request Copy
    Response Copy

    Products wishlist customers

    「Products wishlist customers」は商品をお気に入りに追加した会員を照会できるリソースです。

    Wishlist Resource関係図

    Endpoints 
    GET /api/v2/admin/products/{product_no}/wishlist/customers
GET /api/v2/admin/products/{product_no}/wishlist/customers/count

    Products wishlist customers properties

    Attribute Description
    shop_no

    ショップ番号
    member_id

    会員ID

    List all products wishlist customers

    GET /api/v2/admin/products/{product_no}/wishlist/customers

    GET

    基本スペック

    Property Description
    SCOPE 個人情報の閲覧権限 (mall.read_privacy)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

    shop_no

    ショップ番号

    DEFAULT 1

    Request Copy
    Response Copy

    Count all products wishlist customers

    GET /api/v2/admin/products/{product_no}/wishlist/customers/count

    GET

    基本スペック

    Property Description
    SCOPE 個人情報の閲覧権限 (mall.read_privacy)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

    shop_no

    ショップ番号

    DEFAULT 1

    Request Copy
    Response Copy

    Mileage

    Credits

    Endpoints 
    GET /api/v2/admin/credits

    Credits properties

    Attribute Description
    shop_no

    ショップ番号
    issue_date

    timezone

    登録日
    member_id

    Max Length : [20]

    会員ID
    group_name

    会員ランク名
    increase_amount

    付与金額
    decrease_amount

    差引金額
    balance

    残額
    admin_id

    管理者ID
    admin_name

    管理者名
    reason

    処理事由
    case

    預金タイプ
    order_id

    注文番号

    List all credits

    GET /api/v2/admin/credits

    GET

    基本スペック

    Property Description
    SCOPE ポイントの閲覧権限 (mall.read_mileage)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    start_date
    Required

    Date
    timezone

    検索開始日

    end_date
    Required

    Date
    timezone

    検索終了日

    type

    預り金の増額・減額設定

    I：お支払い履歴
    D：差引内訳

    case

    預金タイプ

    A：注文キャンセル
    B：預り金で返金
    C：商品購入
    D：任意の調整
    E：現金で返金
    G : 充電

    admin_id

    管理者ID

    order_id

    Order ID

    注文番号

    search_field

    検索フィールド

    id：ID
    reason：処理の理由

    keyword

    検索キーワード

    limit

    Min : [1]~Max : [200]

    検索結果の最大件数

    DEFAULT 50

    offset

    Max : [10000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Credits report

    Endpoints 
    GET /api/v2/admin/credits/report

    Credits report properties

    Attribute Description
    shop_no

    ショップ番号
    increase_amount

    付与金額
    decrease_amount

    差引金額
    credits_total

    預り金合計

    List all credits report

    GET /api/v2/admin/credits/report

    GET

    基本スペック

    Property Description
    SCOPE ポイントの閲覧権限 (mall.read_mileage)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    start_date
    Required

    Date
    timezone

    検索開始日

    end_date
    Required

    Date
    timezone

    検索終了日

    type

    預り金の増額・減額設定

    I：お支払い履歴
    D：差引内訳

    case

    預金タイプ

    A：注文キャンセル
    B：預り金で返金
    C：商品購入
    D：任意の調整
    E：現金で返金
    G : 充電

    admin_id

    管理者ID

    search_field

    検索フィールド

    id：ID
    reason：処理の理由

    keyword

    検索キーワード

    Request Copy
    Response Copy

    Points

    「Mileage(ポイント)」は、特定会員のポイントに関するリソースです。 別途のScopeを持っており、商品購入の際に現金のように使用できる重要なAPIであるため、利用に注意を払う必要があります。

    Endpoints 
    GET /api/v2/admin/points
POST /api/v2/admin/points

    Points properties

    Attribute Description
    shop_no

    ショップ番号
    case

    ポイント付与/差引タイプ
    member_id

    会員ID
    group_name

    会員ランク名
    available_points_increase

    ポイント増額
    available_points_decrease

    ポイント差引
    available_points_total

    使用可能ポイント
    unavailable_points

    仮付与ポイント
    order_date

    timezone

    注文日
    issue_date

    timezone

    ポイント付与日
    available_date

    気付与ポイントの使用可能日
    admin_id

    管理者ID
    admin_name

    管理者名
    order_id

    注文番号
    reason

    付与理由

    ポイントを増額・減額する理由を入力することができる。
    amount

    ポイント

    1回あたり最大%s以下までポイントを付与することができます。
    有効ポイントより高い金額を差し引くことはできません。
    type

    ポイント増額・減額の設定

    ポイントを増額するか減額するかを選択することができる。

    List all points

    GET /api/v2/admin/points

    GET

    基本スペック

    Property Description
    SCOPE ポイントの閲覧権限 (mall.read_mileage)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    member_id

    Max Length : [20]

    会員ID

    order_id

    Max Length : [100]

    注文ID

    group_no

    会員ランク番号

    start_date
    Required

    Date
    timezone

    検索開始日

    end_date
    Required

    Date
    timezone

    検索終了日

    case

    ポイント付与/差引タイプ

    ポイントのタイプを指定せずにすべてを照会する場合は、「D：ポイント返金」は照会範囲に入らないため、「ポイントの返金」タイプを照会するには、タイプを指定する必要があります。

    A : 運営者がポイントを直接付与
    AM：APIによるポイント
    B : 注文キャンセルによる返金の際に返金額をポイントで付与
    C : 付与予定のポイントキャンセル
    D : 返品完了後に使用可能
    E : csvファイルで登録された会員
    F : 注文キャンセルによる商品ポイント差引
    G : 紹介によって登録した新規会員にポイント付与
    H : 注文時に会員ランクによるポイントを付与(会員ランクポ別イント)
    K : 注文時に会員ランクによるポイントを付与(会員ランク別ポイント)
    I : 注文キャンセルによる会員ランク別ポイント差引
    J : 注文キャンセルによるクーポンポイント返金
    L : 注文時に使用したクーポンによるポイント付与(クーポンポイント)
    M : 商品購入時に使用したポイント
    N : 新規登録時にポイント付与
    O : ポイント即時付与クーポン(オンライン/クローズド)
    P : 注文時に購入した商品に対してポイントを付与(購入によるポイント)
    Q : お気に入りポイント
    R : 新規会員を紹介した既存会員にポイント付与
    S : 注文キャンセルした場合
    購入時に使用したポイントを付与(ポイント復元(注文キャンセル))
    T : メルマガ受信に同意した場合のポイント
    U : ショートカット(リンコン)の作成後にログイン
    V : 被紹介者の注文キャンセル時に感謝ポイントを差引
    W : 被紹介者の注文による感謝ポイント付与
    X : ショートカット(リンコン)からアクセスして商品を購入する場合
    追加ポイントを付与
    Y : 注文時に購入した商品に対してポイントを付与(購入ポイント)
    Z : ショートカットアイコンの作成
    9 : [品目交換]運営者直接付与 [会員]ポイント
    8 : [品目交換]運営者直接付与 [商品]ポイント
    7 : [品目追加]運営者直接付与 [会員]ポイント
    6 : [品目追加]運営者直接付与 [商品]ポイント

    points_category

    ポイント詳細

    Available : 使用可能ポイント
    unavailable : 仮付与ポイント
    unavailable_coupon : 会員ランク/クーポンポイント(仮付与)

    DEFAULT available

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    Increase / Decrease point

    POST /api/v2/admin/points

    POST

    基本スペック

    Property Description
    SCOPE ポイントの投稿権限 (mall.write_mileage)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    member_id
    Required

    Max Length : [20]

    会員ID

    order_id

    Order ID

    注文番号

    amount
    Required

    Min : [0]

    ポイント

    type
    Required

    ポイント増額・減額の設定

    increase：増額
    decrease：減額

    reason

    付与理由

    Request Copy
    Response Copy

    Points report

    「Points report」は指定した期間のポイント統計を照会できるリソースです。

    Endpoints 
    GET /api/v2/admin/points/report

    Points report properties

    Attribute Description
    shop_no

    ショップ番号
    available_points_increase

    使用可能ポイント増額
    available_points_decrease

    使用可能ポイント差引
    available_points_total

    使用可能ポイント(すべて)
    unavailable_points

    仮付与ポイント
    unavailable_coupon_points

    会員/クーポンポイント(仮付与)

    List all points report

    GET /api/v2/admin/points/report

    GET

    基本スペック

    Property Description
    SCOPE ポイントの閲覧権限 (mall.read_mileage)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    member_id

    Max Length : [20]

    会員ID

    group_no

    会員ランク番号

    start_date
    Required

    Date
    timezone

    検索開始日

    end_date
    Required

    Date
    timezone

    検索終了日

    Request Copy
    Response Copy

    Notification

    Customers invitation

    Endpoints 
    POST /api/v2/admin/customers/{member_id}/invitation

    Customers invitation properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号
    member_id

    Max Length : [16]

    会員ID

    Create a customers invitation

    POST /api/v2/admin/customers/{member_id}/invitation

    POST

    基本スペック

    Property Description
    SCOPE 通知の投稿権限 (mall.write_notification)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    member_id
    Required

    Max Length : [16]

    会員ID

    invitation_type
    Required

    アカウント有効化案内方法

    Request Copy
    Response Copy

    Sms

    SMSは、注文・配送などのステータスをSMSで自動送信するサービスです。 SMS APIを使用するためには、ショップで「SMS送信サービス」を申込む必要があります。

    Endpoints 
    POST /api/v2/admin/sms

    Sms properties

    Attribute Description
    queue_code

    Queueコード

    Send SMS

    POST /api/v2/admin/sms

    POST

    基本スペック

    Property Description
    SCOPE 通知の投稿権限 (mall.write_notification)
    呼び出し件数制限 1
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    sender_no
    Required

    送信者ID

    送信者の固有一連番号

    content
    Required

    メッセージ

    recipients

    Array Max : [100]

    受信者番号

    member_id

    Array Max : [100]

    会員ID

    exclude_unsubscriber

    受信拒否した人の送信除外設定

    受信拒否した人を除いて送信するかどうかを設定できる。

    T : 除く F : 含む

    DEFAULT T

    type

    送信タイプ

    SMSの送信タイプ_x000D_
    SMSは1通あたり最大90byteまで入力でき、90byteを超える場合には複数通に分けて送信する。_x000D_
    LMSは1通あたり最大2000byteまで入力できる。

    SMS : 短文　LMS : 長文

    DEFAULT SMS

    Request Copy
    Response Copy

    Sms senders

    SMS送信者(Senders)は、SMSを送信する発信番号を意味します。 SMS送信者はSMSに属しているサブリソースです。

    Endpoints 
    GET /api/v2/admin/sms/senders

    Sms senders properties

    Attribute Description
    sender_no

    送信者ID

    送信者の固有一連番号
    sender

    送信者番号

    送信者の電話番号
    auth_status

    認証状態

    送信者の電話番号の認証状態
    認証完了した送信者に対してのみ、SMSを送信することができる。

    00 : 削除 10 : 登録 20 : 審査中 30 : 認証完了 40 : 返上

    List all sms senders

    GET /api/v2/admin/sms/senders

    GET

    基本スペック

    Property Description
    SCOPE 通知の閲覧権限 (mall.read_notification)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Request Copy
    Response Copy

    non-print

    Codes

    display_location code

    PAGE ROLE CODE
    商品カテゴリ PRODUCT_LIST
    商品詳細 PRODUCT_DETAIL
    選択 PRODUCT_SEARCH
    キャンペーン PRODUCT_PROJECT
    最近チェックした商品 PRODUCT_RECENT
    掲示板メイン BOARD_MAIN
    掲示板リスト BOARD_FREE_LIST
    掲示板の詳細を見る BOARD_FREE_DETAIL
    投稿を書く BOARD_FREE_WRITE
    投稿の修正 BOARD_FREE_MODIFY
    投稿コメント BOARD_FREE_REPLY
    商品レビュー一覧 BOARD_PRODUCT_LIST
    商品レビューの詳細を見る BOARD_PRODUCT_DETAIL
    商品レビューを書く BOARD_PRODUCT_WRITE
    商品レビュー修正 BOARD_PRODUCT_MODIFY
    商品レビューコメント BOARD_PRODUCT_REPLY
    アルバム一覧(画像を大きく) BOARD_GALLERY_LIST
    アルバムの詳細を見る BOARD_GALLERY_DETAIL
    アルバムを書く BOARD_GALLERY_WRITE
    アルバムの編集 BOARD_GALLERY_MODIFY
    アルバムコメント BOARD_GALLERY_REPLY
    お急ぎ問い合わせ BOARD_URGENCY
    My質問一覧 BOARD_CONSULT_LIST
    My質問の内容 BOARD_CONSULT_DETAIL
    My質問の作成 BOARD_CONSULT_WRITE
    My質問の編集 BOARD_CONSULT_MODIFY
    My質問への回答 BOARD_CONSULT_REPLY
    会員登録 MEMBER_JOIN
    会員情報の変更 MEMBER_MODIFY
    利用規約 MEMBER_AGREEMENT
    個人情報取扱方針 MEMBER_PRIVACY
    会員登録の結果 MEMBER_JOINRESULT
    ID検索 MEMBER_ID_FIND
    パスワード検索 MEMBER_PW_FIND
    マイページのトップページ MYSHOP_MAIN
    マイページの注文内訳 MYSHOP_ORDER_LIST
    マイページの注文詳細の内訳 MYSHOP_ORDER_DETAIL
    マイページのポイント内訳 MYSHOP_MILEAGE_LIST
    マイページのクーポン内訳 MYSHOP_COUPON_COUPON
    マイページの預り金内訳 MYSHOP_DEPOSIT_LIST
    配送アドレス帳一覧 MYSHOP_ADDR_LIST
    配送アドレス帳登録 MYSHOP_ADDR_REGIST
    配送アドレス帳変更 MYSHOP_ADDR_MODIFY
    トップページ MAIN
    会員のみアクセス可能なページ MAIN_INTRO_MEMBER
    ご利用案内(FAQ) SHOPINFO_FAQ
    会社概要 SHOPINFO_COMPANY
    カート画面 ORDER_BASKET
    注文書作成画面 ORDER_ORDERFORM
    ご注文完了 ORDER_ORDERRESULT
    プレミアムのご案内 ORDER_GIFTLIST
    クーポンゾーン COUPON_COUPONZONE
    ログイン画面 MEMBER_LOGIN
    マイページのお気に入り商品一覧 MYSHOP_WISHLIST
    商品比較 PRODUCT_COMPARE
    投稿コメントを削除 BOARD_FREE_COMMENTDEL
    非公開投稿 BOARD_FREE_SECRET
    アルバムのコメントを削除 BOARD_GALLERY_COMMENTDEL
    アルバムの非公開記事 BOARD_GALLERY_SECRET
    ひとこと投稿一覧 BOARD_MEMO_LIST
    会員パスワード認証 MEMBER_CHECKPW
    ID検索結果 MEMBER_ID_FINDRESULT
    パスワード検索の結果 MEMBER_PW_FINDRESULT
    秘密の質問 MEMBER_PW_FINDQUESTION
    マイ投稿 MYSHOP_BOARDLIST
    無効ポイントの内訳を見る MYSHOP_MILEAGE_UNAVAILLIST
    キャンセル申込 MYSHOP_ORDER_CANCEL
    交換申込 MYSHOP_ORDER_EXCHANGE
    返品申込 MYSHOP_ORDER_RETURN
    出席チェック(コメント型) ATTEND_COMMENT
    出席チェック(カレンダー型) ATTEND_STAMP
    供給会社メイン SUPPLY_INDEX
    Top