닫기
  • Store

  • Product

  • Order

  • Customer

  • Community

  • Design

  • Promotion

  • Application

  • Category

  • Collection

  • Supply

  • Shipping

  • Salesreport

  • Personal

  • Privacy

  • Mileage

  • Notification

    non-print

    API Index

    Introduction

    Cafe24 API

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

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

    API Diagram

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

    Request/Response Format

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

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

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

    要求例題(検索)
    要求例題(登録/修正)
    正常応答例題
    {
      "resource": {
          "key": "value",
          "key": "value"
       }
    }
    エラー応答例題
    {
        "error": {
            "code": "エラーコード",
            "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-09-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

    Activitylogs

    Activitylogs properties

    Attribute Description
    process_no

    操作ログ番号

    mode

    モード

    P:プロモード
    S:スマートモード
    M:モバイル

    type

    区分

    content

    業務内容

    process_date

    timezone

    操作日時

    manager_id

    Type : [a-z0-9]
    Length Min : [4]~Max : [16]

    処理者

    manager_type

    処理者区分

    List all activitylogs

    GET

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

    基本スペック

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

    要求スペック

    Parameter Description
    manager_type

    処理者区分

    P:代表運営者
    A:副運営者
    S:供給会社

    manager_id

    Type : [a-z0-9]
    Length Min : [4]~Max : [16]

    処理者

    mode

    モード

    P:プロモード
    S:スマートモード
    M:モバイル

    type

    区分

    content

    Max Length : [500]

    業務内容

    start_date
    Required

    Date
    timezone

    検索開始日

    end_date
    Required

    Date
    timezone

    検索終了日

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    DEFAULT 0

    Get an activitylog

    GET

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

    基本スペック

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

    要求スペック

    Parameter Description
    process_no
    Required

    操作ログ番号

    Request Copy
    Response Copy

    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

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    Get coupons setting
    Request Copy
    Response Copy

    Update a 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」ではショップの貨幣/為替レートの情報などを確認することができます。

    Currency properties

    Attribute Description
    exchange_rate

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

    standard_currency_code

    基準通貨コード

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

    standard_currency_symbol

    基準通貨シンボル

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

    shop_currency_code

    決済通貨コード

    shop_currency_symbol

    決済通貨シンボル

    Get currency setting

    GET

    基本スペック

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

    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

    掲示板リスト

    ショップの掲示板リスト

    List all dashboard

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    List all dashboard
    Request Copy
    Response Copy

    Kakaopay setting

    Kakaopay setting properties

    Attribute Description
    shop_no

    ショップ番号

    shop_key

    出店時に付与される販売店の一意識別子(UID)

    pixel_code

    連携会社(ASP型/ソフトウェアインストール型ネットショップ)ですでに使用中のKakao広告ピクセルID

    use_kakaopay

    KakaoPay購入を使用するかどうか

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

    product_detail_button_size

    ショップの商品詳細ページボタンのサイズ

    basket_button_size

    ショップのカートページボタンのサイズ

    use_dark_mode

    ショップにダークモードを適用するかどうか

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

    button_authorization_key

    出店時に付与される販売店のボタン認証

    thirdparty_agree

    個人情報の第三者提供に関する同意

    T:同意する
    F:同意しない

    thirdparty_agree_date

    timezone

    個人情報の第三者提供に同意した日付

    List all kakaopay setting

    GET

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

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    List all kakaopay setting
    Request Copy
    Response Copy

    Update a kakaopay setting

    PUT

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

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    shop_key

    出店時に付与される販売店の一意識別子(UID)

    pixel_code

    連携会社(ASP型/ソフトウェアインストール型ネットショップ)ですでに使用中のKakao広告ピクセルID

    use_kakaopay

    KakaoPay購入を使用するかどうか

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

    product_detail_button_size

    ショップの商品詳細ページボタンのサイズ

    pc
    pc

    mobile
    mobile

    basket_button_size

    ショップのカートページボタンのサイズ

    pc
    pc

    mobile
    mobile

    use_dark_mode

    ショップにダークモードを適用するかどうか

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

    button_authorization_key

    出店時に付与される販売店のボタン認証

    thirdparty_agree

    個人情報の第三者提供に関する同意

    T:同意する
    F:同意しない

    thirdparty_agree_date

    Date
    timezone

    個人情報の第三者提供に同意した日付

    Update a kakaopay setting
    Request Copy
    Response Copy
    Attribute Description
    shop_no

    ショップ番号

    mode

    メニューモード

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

    menu_no

    メニュー番号

    name

    メニュー名

    path

    メニュー経路

    contains_app_url

    アプリURLを含むかどうか

    T:含む
    F:含まない

    List all 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:含まない

    Mobile setting

    「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

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    Get mobile setting
    Request Copy
    Response Copy

    Paymentgateway

    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は特定のクライアントでのみ使用が可能です。本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は特定のクライアントでのみ使用が可能です。本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は特定のクライアントでのみ使用が可能です。本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

    Delete a paymentgateway
    Request Copy
    Response Copy

    Paymentgateway paymentmethods

    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は特定のクライアントでのみ使用が可能です。本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は特定のクライアントでのみ使用が可能です。本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]

    決済方法画像パス

    Create a paymentgateway paymentmethod
    Request Copy
    Response Copy

    Update a paymentgateway paymentmethod

    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]

    決済方法画像パス

    Update a paymentgateway paymentmethod
    Request Copy
    Response Copy

    Delete a paymentgateway paymentmethod

    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]

    決済方法コード

    Delete a paymentgateway paymentmethod
    Request Copy
    Response Copy

    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

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    Get products setting
    Request Copy
    Response Copy

    Shops

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

    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

    基本スペック

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

    Get a shop

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no
    Required

    ショップ番号

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

    DEFAULT 1

    Request Copy
    Response Copy

    Sms setting

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

    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

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    Get SMS Setting
    Request Copy
    Response Copy

    Store

    商店(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

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    Get a store
    Request Copy
    Response Copy

    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

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    List all store accounts
    Request Copy
    Response Copy

    Subscription shipments setting

    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

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    subscription_no

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

    Create a 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:含まない

    Create a subscription shipments setting
    Request Copy
    Response Copy

    Update a subscription shipments setting

    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:含まない

    Update a subscription shipments setting
    Request Copy
    Response Copy

    Delete a subscription shipments setting

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    subscription_no
    Required

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

    Delete a subscription shipments setting
    Request Copy
    Response Copy

    Users

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

    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

    基本スペック

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

    要求スペック

    Parameter Description
    search_type

    検索タイプ

    member_id:会員ID
    name:お名前

    keyword

    検索キーワード

    Get an user

    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

    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

    基本スペック

    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]

    検索結果の開始位置

    検索結果の開始位置

    DEFAULT 0

    Get a bundleproduct

    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

    基本スペック

    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

    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:送料

    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

    基本スペック

    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

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

    Delete a bundleproduct

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Delete a bundleproduct
    Request Copy
    Response Copy

    Categories products

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

    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

    基本スペック

    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

    Count all categories 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: 新着商品

    Count all categories products
    Request Copy
    Response Copy

    Create a categories product

    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

    基本スペック

    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:表示順位固定を使用しない

    Update a categories product
    Request Copy
    Response Copy

    Delete a categories product

    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

    Delete a categories product
    Request Copy
    Response Copy

    Mains products

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

    Mains products properties

    Attribute Description
    shop_no

    ショップ番号

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

    product_no

    商品番号

    product_name

    商品名

    fixed_sort

    「固定」設定の有無

    List all mains products

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_group
    Required

    メインカテゴリ番号

    Count all mains products

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_group
    Required

    メインカテゴリ番号

    Count all mains products
    Request Copy
    Response Copy

    Create a mains product

    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

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_group
    Required

    メインカテゴリ番号

    product_no
    Required

    商品番号

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

    fix_product_no

    表示順位固定商品の番号

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

    Update a mains product
    Request Copy
    Response Copy

    Delete a mains product

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_group
    Required

    メインカテゴリ番号

    product_no
    Required

    商品番号

    Delete a mains product
    Request Copy
    Response Copy

    Products



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

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

    Products properties

    Attribute Description
    shop_no

    ショップ番号

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

    product_no

    商品番号

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

    product_code

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

    商品コード

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

    custom_product_code

    Max Length : [40]

    独自商品コード

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

    product_name

    Max Length : [250]

    商品名

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

    eng_product_name

    Max Length : [250]

    英語商品名

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

    supply_product_name

    Max Length : [250]

    供給会社の商品名

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

    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

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

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

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

    approve_status

    承認申込結果

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

    classification_code

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

    独自カテゴリコード

    独自カテゴリを登録すると自動生成されるコードで、商品に特定の独自カテゴリを指定する場合に使う。

    入力しない場合は基本の独自カテゴリ(C000000A)使用

    sold_out

    在庫切れ状況

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

    additional_price

    販売価格の追加金額

    discountprice

    商品の割引価格リソース


    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:分離型セット

    use_kakaopay

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

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

    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

    基本スペック

    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]

    検索結果の開始位置

    検索結果の開始位置

    DEFAULT 0

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    List all products
    Request Copy
    Response Copy

    Count all products

    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:使用しない

    Count all products
    Request Copy
    Response Copy

    Get a product

    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

    基本スペック

    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」と入力します。

    DEFAULT 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

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

    use_kakaopay

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

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

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

    Request Copy
    Response Copy

    Update a product

    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

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

    use_kakaopay

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

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

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

    Delete a product

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Delete a product
    Request Copy
    Response Copy

    Products additionalimages

    「Products additionalimages」は商品の追加画像を照会できるサブリソースであり、「Products」の以下で使用できます。

    Products additionalimages properties

    Attribute Description
    shop_no

    ショップ番号

    additional_image

    追加画像

    Create a products additionalimage

    POST

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    additional_image
    Required

    追加画像

    Create a products additionalimage
    Request Copy
    Response Copy

    Update a products additionalimage

    PUT

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    additional_image
    Required

    追加画像

    Update a products additionalimage
    Request Copy
    Response Copy

    Products approve

    供給会社の商品承認機能を使っているショップでしか使えないAPIです。

    Products approve properties

    Attribute Description
    shop_no

    ショップ番号

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

    status
    Required

    ステータス

    供給会社が承認要求した商品の承認ステータス

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

    product_no
    Required

    商品番号

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

    Get products approve status

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    Get products approve status
    Request Copy
    Response Copy

    Create a products 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

    Create a products approve
    Request Copy
    Response Copy

    Update a products 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:検収進行中ステータス値

    Update a products approve
    Request Copy
    Response Copy

    Products decorationimages

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

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

    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

    基本スペック

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

    List all products decoration images

    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

    基本スペック

    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

    基本スペック

    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
    デコ画像の表示位置(垂直値)

    Deselect a decoration images to a product

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    code
    Required

    デコ画像コード

    product_no
    Required

    商品番号

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

    Deselect a decoration images to a product
    Request Copy
    Response Copy

    Products discountprice

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

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

    Products discountprice properties

    Attribute Description
    pc_discount_price

    PC割引価格

    mobile_discount_price

    モバイル割引価格

    List all products discountprice

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    List all products discountprice
    Request Copy
    Response Copy

    Products hits

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

    Count all products hits

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Count all products hits
    Request Copy
    Response Copy

    Products icons

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

    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

    基本スペック

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

    List all products 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

    基本スペック

    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

    基本スペック

    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

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    code
    Required

    商品アイコンコード

    Deselect a product icons to a product
    Request Copy
    Response Copy

    Products images

    商品画像(Products Images)は商品を販売するためにアップロードした商品の写真や絵を意味します。商品画像APIを使って商品詳細説明に使う画像や商品の画像をアップロードすることができます。
    商品の画像はBase64コードでエンコードしてアップロードできます。

    Products images properties

    Attribute Description
    path

    詳細画像

    shop_no

    ショップ番号

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

    product_no

    商品番号

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

    detail_image

    詳細画像

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

    list_image

    一覧画像

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

    tiny_image

    縮小一覧画像

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

    small_image

    縮小画像

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

    Upload Images

    POST

    基本スペック

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

    要求スペック

    Parameter Description
    image
    Required

    詳細画像

    Upload Images
    Request Copy
    Response Copy

    Upload product 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:個別画像登録

    Upload product images
    Request Copy
    Response Copy

    Delete a products image

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Delete a products image
    Request Copy
    Response Copy

    Products memos

    商品メモは商品に添付する簡単なメモで、商品に関する特異事項を書いたり運営者同士のコミュニケーションツールとして活用することができます。
    商品メモは下位Resourceで、商品(Products)の下位でしか使えません。

    Products memos properties

    Attribute Description
    memo_no

    メモ番号

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

    author_id

    Max Length : [20]

    作成者ID

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

    created_date

    timezone

    作成日

    メモを作成した時間

    memo

    メモ

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

    List all products 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]

    検索結果の開始位置

    DEFAULT 0

    Request Copy
    Response Copy

    Get a products memo

    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

    基本スペック

    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

    基本スペック

    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を使って登録できる。

    Update a products memo
    Request Copy
    Response Copy

    Delete a products memo

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    memo_no
    Required

    メモ番号

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

    Delete a products memo
    Request Copy
    Response Copy

    Products options

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

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

    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

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

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

    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

    基本スペック

    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

    基本スペック

    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

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

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

    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はオプションを修正しながら品目を初期化しません。オプション名とオプション値、追加入力オプションとファイル添付オプションの修正のみ可能で、オプション項目の追加や削除はできません。

    オプションを追加または削除したい場合は、オプション削除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

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

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

    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

    ファイル添付オプション

    Delete a products option

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    Delete a products option
    Request Copy
    Response Copy

    Products seo

    SEOは検索エンジンの最適化(Search Engine Optimization)の略語で、SEO APIは検索エンジンで商品やショップがよりよく検索できるようにします。
    商品の下位Resourceで、SEO APIは商品の検索エンジンの最適化設定ができます。

    Products seo properties

    Attribute Description
    shop_no

    ショップ番号

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

    meta_title

    ブラウザでのタイトル

    商品詳細ページのTitleタグに表示される情報。Titleタグはブラウザーに表示される情報で、検索エンジンで検索時に一番基本的な情報である。

    meta_author

    メタタグ1:Author

    商品詳細ページのタグに表示される情報。authorメタタグにはその商品を製造した人または登録した人を記入する。

    meta_description

    メタタグ2:Description

    商品詳細ページのタグに表示される情報。descriptionタグに検索結果ページで検索結果の下に表示される簡単な情報を入力することができる。

    meta_keywords

    メタタグ3:Keywords

    商品詳細ページのタグに表示される情報。keywordタグにその商品が検索されてほしいと思う検索キーワードを入力することができる。

    meta_alt

    商品画像のalt属性

    商品画像に表示されるAltテキスト情報。Altテキストを入力しておくと検索エンジンで画像検索時に検索される可能性が高くなり、ブラウザーで画像の代わりに関連テキストを出力することができるため、ウェブのアクセス性にも有利である。

    search_engine_exposure

    検索エンジンでの表示設定

    商品を検索エンジンに表示するかどうかを設定。「表示しない」に設定する場合、その商品が検索エンジンに表示されない。

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

    Get products seo

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Get products seo
    Request Copy
    Response Copy

    Update a products 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」の以下で使用可能です。

    Products tags properties

    Attribute Description
    shop_no

    ショップ番号

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

    tag

    商品タグ

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

    tags
    Required

    商品タグ

    product_no

    商品番号

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

    List all products 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

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Count all products tags
    Request Copy
    Response Copy

    Create a products tag

    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

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    tag

    商品タグ

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

    Delete a products tag
    Request Copy
    Response Copy

    Products variants

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

    在庫(Inventories)

    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

    基本スペック

    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

    基本スペック

    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

    基本スペック

    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です。

    基本スペック

    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

    安全在庫数量

    Delete a products variant

    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]

    商品品目コード

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

    Delete a products variant
    Request Copy
    Response Copy

    Products variants inventories

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

    Products variants inventories properties

    Attribute Description
    shop_no

    ショップ番号

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

    variant_code

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

    品目コード

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

    use_inventory

    在庫使用の設定

    品目に対して在庫管理を使うかどうかを設定。在庫管理を使う場合、在庫数を入力することができる。在庫管理を使わない場合、その商品は在庫と関係なく販売可能で、在庫数、在庫数チェック基準、在庫切れ表示の設定を使うことができない。

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

    important_inventory

    重要在庫の有無

    在庫を重要管理するかどうかを設定。ショップでは検索するための区分データとして使う。

    A:一般在庫
    B:重要在庫

    inventory_control_type

    在庫数量チェックの基準

    在庫数量をどの時点で差し引くかという基準。銀行振込のように決済時点と注文時点が異なる場合は在庫を差し引く基準をそれぞれ設定することができる。

    注文基準: 注文した時点で在庫を差し引く。銀行振込の場合は入金が完了しなくても在庫を差し引く。
    決済基準: 決済した時点で在庫を差し引く。銀行振込の場合は入金が完了した後、在庫を差し引く。

    A:注文基準
    B:決済基準

    display_soldout

    在庫切れ表示の設定

    在庫がすべて販売された場合、その品目を在庫切れと表示するかどうかの設定。在庫切れと表示されると注文ができない。すべての品目が在庫切れになる場合はその商品に在庫切れアイコンが表示される。
    「表示しない」を選択すると在庫がすべて販売されても注文が可能で、在庫がマイナス(-)と表記される。

    T:在庫切れ表示を使用する
    F:在庫切れ表示を使用しない

    quantity

    数量

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

    safety_inventory

    安全在庫数量

    Get products variants inventory

    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

    基本スペック

    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

    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

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    claim_code
    Required

    キャンセル番号

    Request Copy
    Response Copy

    Create 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

    基本スペック

    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

    Cancellationrequests properties

    Attribute Description
    shop_no

    ショップ番号

    order_id

    注文番号

    items

    品目別注文一覧

    undone

    受付を拒否するかどうか

    order_item_code

    品目別注文コード

    Create 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

    Create cancellationrequests
    Request Copy
    Response Copy

    Update 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]

    拒否の理由

    Update cancellationrequests
    Request Copy
    Response Copy

    Cashreceipt

    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

    基本スペック

    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]

    検索結果の開始位置

    DEFAULT 0

    List all cashreceipt
    Request Copy
    Response Copy

    Create a 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]

    電話番号(携帯)

    Create a cashreceipt
    Request Copy
    Response Copy

    Update a cashreceipt

    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]

    電話番号(携帯)

    Update a cashreceipt
    Request Copy
    Response Copy

    Cashreceipt cancellation

    Cashreceipt cancellation properties

    Attribute Description
    cashreceipt_no

    現金領収証番号

    order_id

    注文番号

    status

    処理ステータス

    申込み取消し:canceled_request
    発行取消し:canceled_issuance

    Update a cashreceipt 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

    Update a cashreceipt cancellation
    Request Copy
    Response Copy

    Collectrequests

    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

    基本スペック

    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

    Update a collectrequest
    Request Copy
    Response Copy

    Exchange

    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

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    claim_code
    Required

    交換番号

    Request Copy
    Response Copy

    Exchangerequests

    Exchangerequests properties

    Attribute Description
    shop_no

    ショップ番号

    order_id

    注文番号

    items

    品目別注文一覧

    exchange_request_no

    交換申込番号

    undone

    受付を拒否するかどうか

    order_item_code

    品目別注文コード

    Create exchangerequests

    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:お客様都合
    E:商品への不満
    K:不良品
    J:配送ミス
    I:その他

    reason
    Required

    Max Length : [2000]

    交換申込みの理由

    request_pickup

    回収申込の設定

    T:回収申込み
    F:直接発送

    pickup

    回収地域の詳細

    name
    お名前
    Required

    phone
    電話番号

    cellphone
    電話番号(携帯)
    Required

    zipcode
    郵便番号
    Required

    address1
    基本住所
    Required

    address2
    詳細住所
    Required

    tracking_no

    Max Length : [30]

    返品用送り状の送り状番号

    shipping_company_name

    Max Length : [30]

    返品に使用する配送会社名

    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

    exchange_items

    交換商品の情報

    product_no
    商品番号
    Required

    variant_code
    商品品目コード
    Required

    quantity
    数量
    Required

    Create exchangerequests
    Request Copy
    Response Copy

    Update exchangerequests

    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]

    拒否の理由

    Update exchangerequests
    Request Copy
    Response Copy

    Orders

    Orders Resource関係図

    注文(order)はショップでショップの顧客が商品を購入するためにショップに要求した内訳です。ショップの運営者は決済済みの注文情報を見てショップの顧客に商品を配送します。注文情報には注文と決済を行った注文者の情報と商品を受け取る受取人の情報が含まれています。


    注文は下記のようなResourceを下位Resourceとして持っています。
    品目別注文(Items)
    受取人情報(Receivers)

    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

    品目別注文エンティティ

    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パラメーターを使って照会することができる。

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

    total_discount_amount

    割引金額合計

    process_status

    注文ステータス

    prepare:発送準備中
    prepareproduct:商品準備中
    hold:配送保留
    unhold:配送保留解除

    order_item_code

    品目別注文コード

    List all 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:返品保留
    R13:返品受付 - 回収完了(自動)
    R30:返品処理中 - 回収前
    R34:返品処理中 - 返金前
    R36:返品処理中 - 返金保留
    R40:返品完了 - 返金完了
    E00:交換申込み
    E10:交換受付
    N01:交換受付 - 交換商品
    E12:交換保留
    E13:交換受付 - 回収完了(自動)
    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]

    検索結果の開始位置

    DEFAULT 0

    Count all orders

    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:返品保留
    R13:返品受付 - 回収完了(自動)
    R30:返品処理中 - 回収前
    R34:返品処理中 - 返金前
    R36:返品処理中 - 返金保留
    R40:返品完了 - 返金完了
    E00:交換申込み
    E10:交換受付
    N01:交換受付 - 交換商品
    E12:交換保留
    E13:交換受付 - 回収完了(自動)
    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

    Count all orders
    Request Copy
    Response Copy

    Get an order

    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

    Create orders

    POST

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

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_type
    Required

    注文経路

    openmarket:モール型ECサイト注文
    self:Cafe24注文
    tollgate:トールゲートビジネス
    externalpay:決済を伴う外部からの注文

    market_seller_id

    ECサイト販売者ID

    paid
    Required

    決済の有無

    T:決済完了
    F:決済前

    payment_request

    決済リクエストを行うかどうかの有無

    T:決済リクエストを行う
    F:決済リクエストを行わない

    DEFAULT F

    order_place_id

    Type : [a-zA-Z0-9_-]
    Max Length : [40]

    注文ルート

    self : PCショップ(Cafe24注文のみ使用可能)
    mobile : Mobileショップ(Web)(Cafe24注文のみ使用可能)
    mobile_d : Mobileショップ(App)(Cafe24注文のみ使用可能)

    inflow_id

    Max Length : [40]

    流入経路

    market_order_no

    Type : [a-zA-Z0-9_-]
    Max Length : [40]

    モール型ECサイトの注文番号

    member_id

    Max Length : [20]

    会員ID

    guest_password

    非会員注文確認用パスワード

    buyer_name
    Required

    Max Length : [100]

    注文者名

    buyer_zipcode
    Required

    Length Min : [2]~Max : [14]

    注文者の郵便番号

    buyer_address1
    Required

    Max Length : [250]

    注文者の住所(基本)

    buyer_address2
    Required

    注文者の住所(詳細)

    buyer_phone

    注文者の固定電話番号

    buyer_cellphone

    注文者の電話番号(携帯)

    buyer_email

    Email

    注文者のメールアドレス

    no_shipping_required

    配送先の住所無し

    T:配送先の住所無し
    F:配送先の住所有り

    DEFAULT F

    buyer_ip

    IP

    注文者ip

    receiver_name
    Required

    Max Length : [100]

    受取人名

    receiver_name_en

    Max Length : [100]

    受取人名(ローマ字)

    receiver_name_furigana

    Max Length : [100]

    受取人名(フリガナ)

    receiver_zipcode

    Length Min : [2]~Max : [14]

    受取人の郵便番号

    receiver_address1

    受取人の住所(基本)

    receiver_address2

    受取人の住所(詳細)

    receiver_city

    受取人住所(市)

    receiver_state

    受取人住所(都道府県)

    receiver_phone
    Required

    受取人の電話番号(固定)

    receiver_cellphone
    Required

    受取人の電話番号(携帯)

    shipping_message

    配送メッセージ

    billing_name
    Required

    決済者名

    payment_amount
    Required

    最終決済金額

    shipping_fee
    Required

    送料

    payment_method

    Max Length : [10]

    決済方法コード

    cash:銀行振込
    card:クレジットカード
    icash:バーチャル口座
    tcash:口座振込
    cell:キャリア決済
    deferpay:後払い
    point:ポイント

    bank_code

    Type : [a-z0-9_-]

    銀行コード

    bank_account_no

    Max Length : [30]

    口座番号

    bank_account_owner_name

    Max Length : [100]

    口座名義

    payment_gateway_name

    Max Length : [20]

    決済代行会社名

    transaction_id

    Max Length : [100]

    クレジットカード取引ID

    sub_payment_method_code

    Max Length : [10]

    海外決済方法のコード

    additional_discount_name

    Max Length : [255]

    特典名

    additional_discount_price

    商品追加割引金額

    shipping_type
    Required

    配送タイプ

    A:国内
    B:海外

    country_code

    国コード

    order_from_mobile

    モバイル区分

    T : モバイル注文
    F : PC注文

    DEFAULT F

    wished_delivery_date

    Date

    配送希望日

    wished_delivery_date_asap

    可能な限り早い日

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

    wished_delivery_start_hour

    Min : [0]~Max : [23]

    配達希望開始時間

    wished_delivery_end_hour

    Min : [0]~Max : [23]

    配達希望終了時間

    wished_delivery_hour_asap

    可能な限り早い時間

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

    send_order_message

    新規注文案内メッセージの送信設定

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

    DEFAULT F

    send_payment_guide_message

    入金案内メッセージの送信設定

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

    DEFAULT F

    send_order_email

    新規注文案内メールの送信設定

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

    DEFAULT F

    open_market_status

    モール型ECサイト決済完了/発注後のステータスチェック

    10:発注前
    20:発注後

    market_order_info

    モール型ECサイトのその他の情報

    include_not_mall_product
    Required

    連携しない外部商品を含むかどうか

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

    update_inventory
    Required

    在庫数を差引するかどうか

    T : 差し引く
    F : 差し引かない

    subscription

    定期購入利用状況

    T : 利用中
    F : 非利用

    DEFAULT F

    order_date

    Date

    注文日

    payment_date

    Date

    決済日

    clearance_information_type

    通関情報タイプ

    I:身分証明書(ID)番号
    P:パスポート番号
    C:個人通関固有符号

    clearance_information

    通関情報

    self_payment_cancel

    PayPal決済のみキャンセルが可能かどうか

    T:キャンセル可能
    F:キャンセル不可

    DEFAULT F

    self_payment_cancel_url

    「PayPal決済のみキャンセル」APIのURL

    items

    注文商品リスト

    market_item_sequence
    外部品目別番号

    market_item_no
    外部品目別番号

    product_code
    商品コード
    Required

    product_no
    商品番号
    Required

    product_name
    商品名
    Required

    options
    オプション

    option_id
    商品オプションID
    Required

    quantity
    注文数量
    Required

    supply_price
    商品仕入れ価格

    product_price
    商品販売価格
    Required

    option_price
    オプション追加価格

    hs_code
    HSコード

    supplier_id
    供給会社のID

    individual_shipping_fee
    個別送料

    shipping_fee_type
    送料タイプ
    DEFAULT X
    X : 基本配送、T : 個別配送 - 送料無料、M : 個別配送 - 固定送料の使用または購入金額によって課金、D : 個別配送 -「購入金額別に別に異なる送料を適用」を使用、W : 個別配送 - 商品重量別に異なる送料を適用、C : 個別配送 - 商品数量別に異なる送料を適用、N : 個別配送 - 商品の数量に比例して送料を課金

    product_tax_type
    商品の税金区分

    A : 課税、B : 免税、C : 非課税

    tax_amount
    税率

    tax_round_unit
    税率計算時の切り捨て設定

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

    supplier_transaction_type
    供給会社の取引タイプ

    D : 供給価格基準、P : 手数料基準

    commission
    供給会社の手数料率

    discount_price
    割引価格

    market_additional_product_id
    モール型ECサイトの追加構成商品

    market_custom_variant_code
    モール型ECサイト独自品目コード

    additional_option_values Array
    追加オプション

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

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

    name
    追加オプション名

    value
    追加オプション値

    Request Copy
    Response Copy

    Update 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

    品目別注文コード

    Update an order

    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

    品目別注文コード

    Orders autocalculation

    Orders autocalculation properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id

    注文番号

    Delete an orders 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

    注文番号

    Delete an orders autocalculation
    Request Copy
    Response Copy

    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

    基本スペック

    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]

    検索結果の開始位置

    DEFAULT 0

    List all orders benefits
    Request Copy
    Response Copy

    Orders buyer

    「Buyer」は、注文者の名前、連絡先、住所などを表示します。 購入者情報はサブリソースであるため、「Order」の以下で使用可能です。

    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

    基本スペック

    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

    基本スペック

    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

    お客様へのお知らせ

    お客様へのお知らせ

    Update an orders buyer
    Request Copy
    Response Copy

    Orders 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

    基本スペック

    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 calculation

    Orders calculation properties

    Attribute Description
    shop_no

    ショップ番号

    mobile

    モバイル/PC

    member_id

    会員ID

    shipping_type

    配送タイプ

    A:国内
    B:海外

    payment_method

    決済方法コード

    cash:銀行振込
    card:クレジットカード
    icash:バーチャル口座
    tcash:口座振込
    cell:キャリア決済
    deferpay:後払い
    point:ポイント

    country_code

    国コード

    carrier_id

    配送会社ID

    zipcode

    郵便番号

    address_full

    アドレス

    items

    注文商品リスト

    membership_discount_amount

    会員ランク割引金額

    shipping_fee_discount_amount

    送料割引金額

    product_discount_amount

    商品別の割引金額

    order_price_amount

    商品購入金額

    total_discount_amount

    割引金額合計

    shipping_fee

    送料

    total_amount_due

    決済予定金額

    shipping_fee_information

    배송비 상세정보

    Create an orders calculation

    POST

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

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    mobile

    モバイル/PC

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

    DEFAULT F

    member_id

    Max Length : [20]

    会員ID

    shipping_type

    配送タイプ

    A:国内
    B:海外

    DEFAULT A

    payment_method

    決済方法コード

    cash:銀行振込
    card:クレジットカード
    icash:バーチャル口座
    tcash:口座振込
    cell:キャリア決済
    deferpay:後払い
    point:ポイント

    country_code

    国コード

    carrier_id

    配送会社ID

    zipcode

    郵便番号

    address_full

    Max Length : [1000]

    アドレス

    items

    注文商品リスト

    product_no
    商品番号
    Required

    variant_code
    商品品目コード
    Required

    quantity
    数量
    Required

    product_price
    商品販売価格
    Required

    option_price
    オプション追加価格

    product_bundle
    セット商品の有無
    DEFAULT F
    T:セット商品、F:セット商品ではない

    product_bundle_no
    セット商品番号

    prefaid_shipping_fee
    送料前払いの設定
    DEFAULT P
    P:前払い、C:着払い

    Request Copy
    Response Copy

    Orders cancellation

    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

    基本スペック

    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

    基本スペック

    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

    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

    基本スペック

    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]

    検索結果の開始位置

    DEFAULT 0

    List all orders coupons
    Request Copy
    Response Copy

    Orders exchangerequests

    Orders exchangerequests properties

    Attribute Description
    shop_no

    ショップ番号

    order_id

    注文番号

    undone

    受付を拒否するかどうか

    order_item_code

    品目別注文コード

    Update an orders exchangerequests

    PUT

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    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]

    拒否の理由

    Update an orders exchangerequests
    Request Copy
    Response Copy

    Orders inflowgroups

    Orders inflowgroups properties

    Attribute Description
    inflow_group_id

    流入経路グループID

    inflow_group_name

    流入経路グループ名

    List all orders inflowgroups

    GET

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

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40
    Request Copy
    Response Copy

    Create an orders inflowgroup

    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は特定のクライアントでのみ使用が可能です。本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]

    流入経路グループ名

    Update an orders inflowgroup
    Request Copy
    Response Copy

    Delete an orders inflowgroup

    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

    Delete an orders inflowgroup
    Request Copy
    Response Copy

    Orders inflowgroups inflows

    Orders inflowgroups inflows properties

    Attribute Description
    inflow_id

    流入経路グループのサービスID

    inflow_name

    流入経路グループのサービス名

    inflow_icon

    流入経路のアイコン

    group_id

    流入経路グループID

    List all orders inflowgroups 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は特定のクライアントでのみ使用が可能です。本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は特定のクライアントでのみ使用が可能です。本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]

    流入経路のアイコン

    Update an orders inflowgroups inflow
    Request Copy
    Response Copy

    Delete an orders inflowgroups inflow

    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

    Delete an orders inflowgroups inflow
    Request Copy
    Response Copy

    Orders items

    品目別注文(Items)はショップの顧客が注文時に購入した品目の情報です。ショップの品目はショップで販売する商品の基本単位で、品目別注文では購入した商品の品目情報と共に購入時に選択したオプション、注文数量などの情報を追加で確認することができます。
    品目別注文番号は下位 Resourceで、注文(Order)の下位でしか使えません。

    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

    基本スペック

    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

    基本スペック

    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

    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

    基本スペック

    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]

    検索結果の開始位置

    DEFAULT 0

    Request Copy
    Response Copy

    List all orders 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

    基本スペック

    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

    基本スペック

    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

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    memo_no
    Required

    メモ番号

    Delete an orders memo
    Request Copy
    Response Copy

    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

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_item_code
    Required

    品目別注文コード

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

    List all orders paymentamount
    Request Copy
    Response Copy

    Orders 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

    基本スペック

    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]

    決済金額変更の理由

    Update an orders payment
    Request Copy
    Response Copy

    Orders paymenttimeline

    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

    基本スペック

    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:決済日

    Get an orders paymenttimeline

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    payment_no
    Required

    Min : [1]

    決済番号

    Get an orders paymenttimeline
    Request Copy
    Response Copy

    Orders receivers

    受取人情報(Receivers)は注文した商品を受け取る人の名前、連絡先、住所情報です。
    受取人情報は下位Resourceで、注文(Order)の下位でしか使えません。

    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:変更しない

    use_fast_delivery_date

    「配送希望日指定なし」設定を使用するかどうか

    T: 使用
    F: 未使用

    use_fast_delivery_time

    「配送希望時間指定なし」設定を使用するかどうか

    T: 使用
    F: 未使用

    List all orders receivers

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    shipping_code

    配送番号

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

    List all orders receivers
    Request Copy
    Response Copy

    Update orders 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

    受取人の安心番号

    wished_delivery_date

    配送希望日

    use_fast_delivery_date

    「配送希望日指定なし」設定を使用するかどうか

    T: 使用
    F: 未使用

    wished_delivery_time

    配達希望時間

    start_hour
    配送希望時間の開始時間

    end_hour
    配送希望時間の終了時間

    use_fast_delivery_time

    「配送希望時間指定なし」設定を使用するかどうか

    T: 使用
    F: 未使用

    Update orders receivers
    Request Copy
    Response Copy

    Update an orders receiver

    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

    受取人の安心番号

    wished_delivery_date

    配送希望日

    use_fast_delivery_date

    「配送希望日指定なし」設定を使用するかどうか

    T: 使用
    F: 未使用

    wished_delivery_time

    配達希望時間

    start_hour
    配送希望時間の開始時間

    end_hour
    配送希望時間の終了時間

    use_fast_delivery_time

    「配送希望時間指定なし」設定を使用するかどうか

    T: 使用
    F: 未使用

    Request Copy
    Response Copy

    Orders 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

    基本スペック

    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

    Orders return properties

    Attribute Description
    shop_no

    ショップ番号

    order_id

    注文番号

    status

    注文ステータス

    canceled:キャンセル完了

    claim_code

    キャンセル番号

    items

    品目別注文コード

    Create an orders 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

    Orders saleschannels properties

    Attribute Description
    sales_channel_id

    販売先ID

    sales_channel_name

    販売先名

    sales_channel_icon

    販売先のアイコン

    List all 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]

    検索結果の開始位置

    DEFAULT 0

    Request Copy
    Response Copy

    Create an orders saleschannel

    POST

    本APIは特定のクライアントでの