닫기

  • Category

  • Product

  • Collection

  • Supply

  • Personal

  • Order

  • Community

  • Customer

  • Notification

  • Store

  • Promotion

  • Design

  • Application

  • Salesreport

  • Privacy

  • Mileage

  • Shipping

    • API Index

    non-print

    API Index

    Introduction

    Cafe24 API

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

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

    Request/Response Format

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

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

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

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

    Method

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

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

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

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

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

    Admin API Intro

    Admin API

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

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

    API Status Code

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

    How to use GET API

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

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

    1. 検索条件を追加

    API検索時に検索条件はエンドポイントにパラメーターを追加して検索できます。

    複数の条件で同時に検索する場合は、区切り文字「&」を使って検索条件を追加することができます。

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

    全てのショップの情報検索 
    例) 特定のブランド内で価格が100円以上の商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?brand_code=B000000A&price_min=1000

例) 商品登録日の検索
GET https://{mallid}.cafe24api.com/api/v2/products?created_start_date=2018-01-03&created_end_date=2018-02-03

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

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

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

    パラメーターで複数の条件で検索する 
    例) 11番、12番、13番商品の情報を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13

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

    API検索時に特定のshop_noを明示すると、該当する全てのショップの情報を検索することができます。

    特定のshop_noを明示しない場合は1番目のショップ(基本ショップ)の情報を検索します。

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

    4. 詳細検索と1件検索

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

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

    詳細検索と1件検索 
    例) 128番商品を詳細検索する方法
GET https://{mallid}.cafe24api.com/api/v2/admin/products/128


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

    5. Pagination

    リスト検索時に検索する項目が多すぎる場合は、すべての結果が一気に検索されないこともあります。

    1回の検索でより多くの結果を得たい場合は、「limit」パラメーターを使って検索件数を拡張することができます。

    「limit」パラメーターを使わない場合は「limit」の基本値だけ検索されます。

    「limit」パラメーターで拡張できる検索件数は、各APIに定義されている「最大値」までです。

    もし「limit 最大値」ですべてのデータを検索することができない場合は、「offset」パラメーターを使うことができます。

    「offset」パラメーターは何番目の商品から検索を始めるかを決定し、その商品から「limit」数だけの商品を再度検索します。

    Pagination 
    例) 商品を1回に100個検索する
GET https://{mallid}.cafe24api.com/api/v2/admin/products?limit=100


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

    6. Fieldパラメーター

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

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

    7. Embedパラメーター

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

    「embed」パラメーターは対応する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 2020-12-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": "2017-10-19T19:17:57.902",
    "refresh_token": "Cuq6H1WLKBxqqf.......",
    "client_id": "BrIfqEKoP.......",
    "mall_id": "yourmall",
    "user_id": "test",
    "scopes": [
        "mall.read_order",
        "mall.read_product",
        "mall.read_store",
        "...etc...",
    ],
    "issued_at": "2017-10-19T17:17:57.911"
}

    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": "0iqR5nM5EJIq.......",
    "expires_at": "2017-10-19T19:17:57.902",
    "refresh_token": "Cuq6H1WLKBxqqf.......",
    "client_id": "BrIfqEKoP.......",
    "mall_id": "yourmall",
    "user_id": "test",
    "scopes": [
        "mall.read_order",
        "mall.read_product",
        "mall.read_store",
        "...etc...",
    ],
    "issued_at": "2017-10-19T17:17:57.911"
}

    Category

    Autodisplay

    Endpoints 
    GET /api/v2/admin/autodisplay
POST /api/v2/admin/autodisplay
PUT /api/v2/admin/autodisplay/{display_no}
DELETE /api/v2/admin/autodisplay/{display_no}

    Autodisplay properties

    Attribute Description
    shop_no

    ショップ番号
    display_no

    自動入替番号
    use_main

    メインカテゴリかどうか

    T: メインカテゴリ
    F: 商品カテゴリ
    category_no

    カテゴリ番号
    display_group

    商品カテゴリの詳細
    display_count

    Min : [1]~Max : [200]

    自動入替え可能な最大商品数
    use_reservation

    入替予約機能の使用有無

    T: 使用
    F: 未使用
    start_date

    timezone

    予約開始日
    use_hashtag

    ハッシュタグ使用有無

    T: 使用
    F: 未使用
    hash_tags

    ハッシュタグ
    display_sort

    ソート順

    AOD: 現在の注文数(降順)
    AOA: 現在の注文数(昇順)
    AVD: 現在の閲覧数(降順)
    AVA: 現在の閲覧数(昇順)
    ARD: 現在の注文率(降順)
    ARA: 現在の注文率(昇順)
    ACD: クリック単価(降順)
    AND: 新着商品順
    APD: 販売価格(降順)
    APA: 販売価格(昇順)→AOD: 注文数(降順)
    AOA: 注文数(昇順)
    AVD: 閲覧数(降順)
    AVA: 閲覧数(昇順)
    ARD: 注文率(降順)
    ARA: 注文率(昇順)
    ACD: クリック単価(降順)
    AND: 新着商品順
    APD: 販売価格(降順)
    APA: 販売価格(昇順)
    RD : 最近の登録商品を上に
    RA : 最近の登録商品を下に
    UD : 最近の修正商品を上に
    UA : 最近の修正商品を下に
    NA : 商品名五十音昇順
    ND : 商品名五十音降順
    PD : 販売価格が高い商品を上に
    PA :販売価格が高い商品を下に
    SD : 販売数の多い商品を上に
    SA : 販売数の多い商品を下に
    CD : 閲覧数の多い商品を上に
    CA : 閲覧数の多い商品を下に
    LD : いいね数が多い商品を上に
    LA : いいね数が多い商品を下に
    timetable

    Array Max : [24]

    アップデート時間
    period

    データの集計期間

    1.1日
    3: 3日
    7: 1週間(7日)
    30: 30日
    except_categories

    除外カテゴリ

    List all autodisplay

    GET

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_no

    自動入替番号

    Definition Copy
    Request example: Copy
    Response example:

    Create an autodisplay

    POST

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    use_main
    Required

    メインカテゴリかどうか

    T: メインカテゴリ
    F: 商品カテゴリ

    category_no
    Required

    カテゴリ番号

    display_group
    Required

    商品カテゴリの詳細

    display_count
    Required

    Min : [1]~Max : [200]

    自動入替え可能な最大商品数

    use_reservation
    Required

    入替予約機能の使用有無

    T: 使用
    F: 未使用

    start_date

    timezone

    予約開始日

    use_hashtag
    Required

    ハッシュタグ使用有無

    T: 使用
    F: 未使用

    hash_tags

    ハッシュタグ

    display_sort

    ソート順

    AOD: 現在の注文数(降順)
    AOA: 現在の注文数(昇順)
    AVD: 現在の閲覧数(降順)
    AVA: 現在の閲覧数(昇順)
    ARD: 現在の注文率(降順)
    ARA: 現在の注文率(昇順)
    ACD: クリック単価(降順)
    AND: 新着商品順
    APD: 販売価格(降順)
    APA: 販売価格(昇順)→AOD: 注文数(降順)
    AOA: 注文数(昇順)
    AVD: 閲覧数(降順)
    AVA: 閲覧数(昇順)
    ARD: 注文率(降順)
    ARA: 注文率(昇順)
    ACD: クリック単価(降順)
    AND: 新着商品順
    APD: 販売価格(降順)
    APA: 販売価格(昇順)
    RD : 最近の登録商品を上に
    RA : 最近の登録商品を下に
    UD : 最近の修正商品を上に
    UA : 最近の修正商品を下に
    NA : 商品名五十音昇順
    ND : 商品名五十音降順
    PD : 販売価格が高い商品を上に
    PA :販売価格が高い商品を下に
    SD : 販売数の多い商品を上に
    SA : 販売数の多い商品を下に
    CD : 閲覧数の多い商品を上に
    CA : 閲覧数の多い商品を下に
    LD : いいね数が多い商品を上に
    LA : いいね数が多い商品を下に

    timetable

    Array Max : [24]

    アップデート時間

    period

    データの集計期間

    1.1日
    3: 3日
    7: 1週間(7日)
    30: 30日

    except_categories

    除外カテゴリ

    Definition Copy
    Request example: Copy
    Response example:

    Update an autodisplay

    PUT

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_no
    Required

    自動入替番号

    display_count

    Min : [1]~Max : [200]

    自動入替え可能な最大商品数

    use_reservation

    入替予約機能の使用有無

    T: 使用
    F: 未使用

    start_date

    timezone

    予約開始日

    use_hashtag

    ハッシュタグ使用有無

    T: 使用
    F: 未使用

    hash_tags

    ハッシュタグ

    display_sort

    ソート順

    AOD: 現在の注文数(降順)
    AOA: 現在の注文数(昇順)
    AVD: 現在の閲覧数(降順)
    AVA: 現在の閲覧数(昇順)
    ARD: 現在の注文率(降順)
    ARA: 現在の注文率(昇順)
    ACD: クリック単価(降順)
    AND: 新着商品順
    APD: 販売価格(降順)
    APA: 販売価格(昇順)→AOD: 注文数(降順)
    AOA: 注文数(昇順)
    AVD: 閲覧数(降順)
    AVA: 閲覧数(昇順)
    ARD: 注文率(降順)
    ARA: 注文率(昇順)
    ACD: クリック単価(降順)
    AND: 新着商品順
    APD: 販売価格(降順)
    APA: 販売価格(昇順)
    RD : 最近の登録商品を上に
    RA : 最近の登録商品を下に
    UD : 最近の修正商品を上に
    UA : 最近の修正商品を下に
    NA : 商品名五十音昇順
    ND : 商品名五十音降順
    PD : 販売価格が高い商品を上に
    PA :販売価格が高い商品を下に
    SD : 販売数の多い商品を上に
    SA : 販売数の多い商品を下に
    CD : 閲覧数の多い商品を上に
    CA : 閲覧数の多い商品を下に
    LD : いいね数が多い商品を上に
    LA : いいね数が多い商品を下に

    timetable

    Array Max : [24]

    アップデート時間

    period

    データの集計期間

    1.1日
    3: 3日
    7: 1週間(7日)
    30: 30日

    except_categories

    除外カテゴリ

    Definition Copy
    Request example: Copy
    Response example:

    Delete an autodisplay

    DELETE

    基本スペック

    Property Description
    SCOPE 商品カテゴリの投稿権限 (mall.write_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_no
    Required

    自動入替番号

    Definition Copy
    Request example: Copy
    Response example:

    Categories

    Categories Resource関係図

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

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

    Categories properties

    Attribute Description
    shop_no

    ショップ番号

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

    カテゴリ番号

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

    Min : [1]~Max : [4]

    カテゴリdepth

    下位何次の商品カテゴリにあるカテゴリかを表示する。1~4次まで商品カテゴリが存在する。
    parent_category_no

    親カテゴリ番号

    商品カテゴリが2次(中カテゴリ)、3次(小カテゴリ)、4次(細カテゴリ)の場合、上位にある商品カテゴリの番号を表示する。

    parent_category_no = 1の場合、そのカテゴリは大カテゴリを意味する。
    category_name

    Max Length : [50]

    カテゴリ名

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

    ショップの表示設定

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

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

    カテゴリ全体の名前

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

    全てのカテゴリ番号

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

    最上位カテゴリ番号

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

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

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

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

    表示ステータス

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

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

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

    表示順序

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

    在庫切れ商品の表示

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

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

    下位カテゴリ商品の表示

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

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

    ハッシュタグ商品の表示

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

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

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

    ハッシュタグ

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

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

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

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

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

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

    A:すべて
    G:エリア別
    product_display_type

    商品カテゴリの表示方法

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

    A : 自動並べ替え
    U : 運営者指定
    M : 自動並べ替え＋運営者指定
    product_display_key

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

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

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

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

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

    D:降順
    A:昇順
    product_display_period

    表示順序に対する期間

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

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

    商品カテゴリの表示方法

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

    A : 自動並べ替え
    U : 運営者指定
    M : 自動並べ替え＋運営者指定
    normal_product_display_key

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

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

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

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

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

    D:降順
    A:昇順
    normal_product_display_period

    表示順序に対する期間

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

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

    商品カテゴリの表示方法

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

    A : 自動並べ替え
    U : 運営者指定
    M : 自動並べ替え＋運営者指定
    recommend_product_display_key

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

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

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

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

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

    D:降順
    A:昇順
    recommend_product_display_period

    表示順序に対する期間

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

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

    商品カテゴリの表示方法

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

    A : 自動並べ替え
    U : 運営者指定
    M : 自動並べ替え＋運営者指定
    new_product_display_key

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

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

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

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

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

    D:降順
    A:昇順
    new_product_display_period

    表示順序に対する期間

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

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

    アクセス権限

    F : 全て利用可能
    T : 会員のみ利用可能
    G : 特定の会員ランクのみ利用可能
    A : 特定の運営者のみ利用可能

    List all categories

    GET

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    category_depth

    Min : [1]~Max : [4]

    カテゴリdepth

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

    category_no

    カテゴリ番号

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

    parent_category_no

    親カテゴリ番号

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

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

    category_name

    カテゴリ名

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

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    Definition Copy
    Request example: Copy
    Response example:

    Count all categories

    GET

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    category_depth

    Min : [1]~Max : [4]

    カテゴリdepth

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

    category_no

    カテゴリ番号

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

    parent_category_no

    親カテゴリ番号

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

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

    category_name

    カテゴリ名

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

    Definition Copy
    Request example: Copy
    Response example:

    Get a category

    GET

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

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

    Definition Copy
    Request example: Copy
    Response example:

    Create a category

    POST

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    parent_category_no

    親カテゴリ番号

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

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

    category_name
    Required

    Max Length : [50]

    カテゴリ名

    該当する商品カテゴリ名

    display_type

    ショップの表示設定

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

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

    use_main

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

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

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

    use_display

    表示ステータス

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

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

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

    soldout_product_display

    在庫切れ商品の表示

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

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

    sub_category_product_display

    下位カテゴリ商品の表示

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

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

    hashtag_product_display

    ハッシュタグ商品の表示

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

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

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

    hash_tags

    ハッシュタグ

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

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

    product_display_scope

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

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

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

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

    A:すべて
    G:エリア別

    product_display_type

    商品カテゴリの表示方法

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

    A : 自動並べ替え
    U : 運営者指定
    M : 自動並べ替え＋運営者指定

    product_display_key

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

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

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

    product_display_sort

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

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

    D:降順
    A:昇順

    product_display_period

    表示順序に対する期間

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

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

    normal_product_display_type

    商品カテゴリの表示方法

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

    A : 自動並べ替え
    U : 運営者指定
    M : 自動並べ替え＋運営者指定

    normal_product_display_key

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

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

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

    normal_product_display_sort

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

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

    D:降順
    A:昇順

    normal_product_display_period

    表示順序に対する期間

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

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

    recommend_product_display_type

    商品カテゴリの表示方法

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

    A : 自動並べ替え
    U : 運営者指定
    M : 自動並べ替え＋運営者指定

    recommend_product_display_key

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

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

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

    recommend_product_display_sort

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

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

    D:降順
    A:昇順

    recommend_product_display_period

    表示順序に対する期間

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

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

    new_product_display_type

    商品カテゴリの表示方法

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

    A : 自動並べ替え
    U : 運営者指定
    M : 自動並べ替え＋運営者指定

    new_product_display_key

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

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

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

    new_product_display_sort

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

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

    D:降順
    A:昇順

    new_product_display_period

    表示順序に対する期間

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

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

    Definition Copy
    Request example: Copy
    Response example:

    Update a category

    PUT

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    category_name

    Max Length : [50]

    カテゴリ名

    該当する商品カテゴリ名

    display_type

    ショップの表示設定

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

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

    use_main

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

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

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

    use_display

    表示ステータス

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

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

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

    soldout_product_display

    在庫切れ商品の表示

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

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

    sub_category_product_display

    下位カテゴリ商品の表示

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

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

    hashtag_product_display

    ハッシュタグ商品の表示

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

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

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

    hash_tags

    ハッシュタグ

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

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

    product_display_scope

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

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

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

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

    A:すべて
    G:エリア別

    product_display_type

    商品カテゴリの表示方法

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

    A : 自動並べ替え
    U : 運営者指定
    M : 自動並べ替え＋運営者指定

    product_display_key

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

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

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

    product_display_sort

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

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

    D:降順
    A:昇順

    product_display_period

    表示順序に対する期間

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

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

    normal_product_display_type

    商品カテゴリの表示方法

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

    A : 自動並べ替え
    U : 運営者指定
    M : 自動並べ替え＋運営者指定

    normal_product_display_key

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

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

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

    normal_product_display_sort

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

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

    D:降順
    A:昇順

    normal_product_display_period

    表示順序に対する期間

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

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

    recommend_product_display_type

    商品カテゴリの表示方法

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

    A : 自動並べ替え
    U : 運営者指定
    M : 自動並べ替え＋運営者指定

    recommend_product_display_key

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

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

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

    recommend_product_display_sort

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

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

    D:降順
    A:昇順

    recommend_product_display_period

    表示順序に対する期間

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

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

    new_product_display_type

    商品カテゴリの表示方法

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

    A : 自動並べ替え
    U : 運営者指定
    M : 自動並べ替え＋運営者指定

    new_product_display_key

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

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

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

    new_product_display_sort

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

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

    D:降順
    A:昇順

    new_product_display_period

    表示順序に対する期間

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

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

    Definition Copy
    Request example: Copy
    Response example:

    Delete a category

    DELETE

    基本スペック

    Property Description
    SCOPE 商品カテゴリの投稿権限 (mall.write_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    category_no
    Required

    カテゴリ番号

    Definition Copy
    Request example: Copy
    Response example:

    Categories decorationimages

    Endpoints 
    GET /api/v2/admin/categories/{category_no}/decorationimages
PUT /api/v2/admin/categories/{category_no}/decorationimages

    Categories decorationimages properties

    Attribute Description
    shop_no

    ショップ番号
    category_no

    カテゴリ番号
    use_menu_image_pc

    カテゴリメニュー画像の使用設定(PC)

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

    カテゴリメニューのデフォルト画像(PC)
    menu_over_image_pc

    カテゴリメニューのマウスオーバー画像(PC)
    use_top_image_pc

    カテゴリ上部画像の使用設定(PC)

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

    カテゴリの上部画像(PC)
    use_title_image_pc

    カテゴリタイトル画像の使用設定(PC)

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

    カテゴリのタイトル画像(PC)
    use_menu_image_mobile

    カテゴリメニュー画像の使用設定(モバイル)

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

    カテゴリメニューのデフォルト画像(モバイル)
    use_top_image_mobile

    カテゴリ上部画像の使用設定(モバイル)

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

    Array Max : [3]

    カテゴリの上部画像(モバイル)
    use_title_image_mobile

    カテゴリタイトル画像の使用設定(モバイル)

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

    カテゴリのタイトル画像(モバイル)

    List all categories decoration images

    GET

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    Definition Copy
    Request example: Copy
    Response example:

    Update a categories decorationimage

    PUT

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    use_menu_image_pc

    カテゴリメニュー画像の使用設定(PC)

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

    menu_image_pc

    カテゴリメニューのデフォルト画像(PC)

    menu_over_image_pc

    カテゴリメニューのマウスオーバー画像(PC)

    use_top_image_pc

    カテゴリ上部画像の使用設定(PC)

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

    top_images_pc

    Array Max : [3]

    カテゴリの上部画像(PC)

    use_title_image_pc

    カテゴリタイトル画像の使用設定(PC)

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

    title_image_pc

    カテゴリのタイトル画像(PC)

    use_menu_image_mobile

    カテゴリメニュー画像の使用設定(モバイル)

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

    menu_image_mobile

    カテゴリメニューのデフォルト画像(モバイル)

    use_top_image_mobile

    カテゴリ上部画像の使用設定(モバイル)

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

    top_images_mobile

    Array Max : [3]

    カテゴリの上部画像(モバイル)

    use_title_image_mobile

    カテゴリタイトル画像の使用設定(モバイル)

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

    title_image_mobile

    カテゴリのタイトル画像(モバイル)

    Definition Copy
    Request example: Copy
    Response example:

    Categories seo

    Endpoints 
    GET /api/v2/admin/categories/{category_no}/seo
PUT /api/v2/admin/categories/{category_no}/seo

    Categories seo properties

    Attribute Description
    shop_no

    ショップ番号
    category_no

    カテゴリ番号
    search_engine_exposure

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

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

    ブラウザでのタイトル
    meta_author

    メタタグ1:Author
    meta_description

    メタタグ2:Description
    meta_keywords

    メタタグ3:Keywords

    List all categories seo

    GET

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    Definition Copy
    Request example: Copy
    Response example:

    Update a categories seo

    PUT

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    category_no
    Required

    カテゴリ番号

    search_engine_exposure

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

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

    meta_title

    ブラウザでのタイトル

    meta_author

    メタタグ1:Author

    meta_description

    メタタグ2:Description

    meta_keywords

    メタタグ3:Keywords

    Definition Copy
    Request example: Copy
    Response example:

    Mains

    Mains Resource関係図

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

    Endpoints 
    GET /api/v2/admin/mains

    Mains properties

    Attribute Description
    shop_no

    ショップ番号

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

    モジュールコード

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

    メインカテゴリ番号
    group_name

    メインカテゴリ名

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

    在庫切れ商品の表示

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

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

    List all mains

    GET

    基本スペック

    Property Description
    SCOPE 商品カテゴリの閲覧権限 (mall.read_category)
    呼び出し件数制限 40
    Definition Copy
    Request example: Copy
    Response example:

    Product

    Bundleproducts

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

    Bundleproducts properties

    Attribute Description
    shop_no

    ショップ番号

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

    商品番号

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

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

    商品コード

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

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

    Max Length : [40]

    独自商品コード

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

    Max Length : [250]

    商品名

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

    Max Length : [250]

    英語商品名

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

    Max Length : [250]

    供給会社の商品名

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

    Max Length : [50]

    管理用商品名
    model_name

    Max Length : [100]

    モデル名

    商品のモデル名
    display

    表示ステータス

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

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

    販売ステータス

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

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

    商品ステータス

    販売する商品のステータス表示

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

    Max : [2147483647]

    中古商品の使用月数
    summary_description

    Max Length : [255]

    商品要約説明

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

    Max Length : [200]

    商品検索キーワード

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

    Max Length : [20]

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

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

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

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

    購入制限

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

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

    購入できる会員ランク
    repurchase_restriction

    再購入制限

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

    単独購入制限

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

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

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

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

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

    ポイント設定情報
    except_member_points

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

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

    年齢認証

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

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

    詳細画像

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

    一覧画像

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

    縮小一覧画像

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

    縮小画像

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

    Naver Payの使用有無

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

    Naver Pay販売タイプ

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

    アイコンの表示期間

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

    Array Max : [5]

    アイコン

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

    HSコード

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

    ※ HSコード : 世界貿易機関(WTO)及び世界関税機構(WCO)が貿易統計及び関税分類の目的で輸出入商品を数字コードでカテゴリ化したもので、輸入時の税金賦課と輸出品の統制及び統計のための分類法
    product_weight

    商品重量

    商品の全体重量(kg)。配送のために商品の重量だけでなく、ボックスと包装の重量も含めた重量を記載する必要がある。
    product_material

    商品素材

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

    timezone

    作成日

    商品が生成された日時
    updated_date

    timezone

    修正日

    商品が修正された日時
    english_product_material

    英語商品素材

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

    生地

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

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

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

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

    ※ 在庫切れアイコン

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

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

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

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

    在庫切れ状況

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

    商品の割引価格リソース


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

    デコ画像リソース


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

    特典リソース


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

    Array Max : [20]

    追加の画像リソース


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

    商品表示制限の範囲

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

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

    セット割引情報
    category

    カテゴリ番号

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

    キャンペーン番号
    description

    商品詳細説明

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

    モバイル商品詳細説明

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

    モバイル用登録

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

    Array Max : [20]

    追加画像

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

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

    商品決済ガイド

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

    商品配送ガイド

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

    交換・返品ガイド

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

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

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

    国別HSコード

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

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

    商品簡略説明

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

    個別配送の設定

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

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

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

    配送方法

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

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

    送料前払いの設定

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

    配送期間

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

    配送情報

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

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

    Max Length : [255]

    配送地域

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

    送料タイプ

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

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

    範囲別送料

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

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

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

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

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

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

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

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

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

    海外通関コード
    additional_information

    追加項目

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

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

    画像アップロードタイプ

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

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

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

    メイン表示

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

    Array Max : [200]

    関連商品

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

    メモリソース


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

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

    商品閲覧数リソース


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

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

    商品Seo リソース


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

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

    商品タグリソース


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

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

    List all bundleproducts

    GET

    基本スペック

    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]

    検索結果の開始位置

    検索結果の開始位置

    Definition Copy
    Request example: Copy
    Response example:

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

    Definition Copy
    Request example: Copy
    Response example:

    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

    selling

    販売ステータス

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

    DEFAULT F

    add_category_no

    追加カテゴリ番号

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

    category_no
    カテゴリ番号
    Required

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

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

    Max Length : [40]

    独自商品コード

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

    eng_product_name

    Max Length : [250]

    英語商品名

    supply_product_name

    Max Length : [250]

    供給会社の商品名

    internal_product_name

    Max Length : [50]

    管理用商品名

    model_name

    Max Length : [100]

    モデル名

    use_naverpay

    Naver Payの使用有無

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

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

    naverpay_type

    Naver Pay販売タイプ

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

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

    product_weight

    Min : [0]~Max : [999999.99]

    商品重量

    description

    商品詳細説明

    mobile_description

    モバイル商品詳細説明

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

    summary_description

    Max Length : [255]

    商品要約説明

    simple_description

    商品簡略説明

    product_tag

    Max Length : [200]

    商品検索キーワード

    payment_info

    商品決済ガイド

    shipping_info

    商品配送ガイド

    exchange_info

    交換・返品ガイド

    service_info

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

    icon

    Array Max : [5]

    アイコン

    hscode

    Max Length : [20]

    HSコード

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

    shipping_scope

    配送情報

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

    ※ショッピングモールがEC Globalモールの場合は必須で入力する必要がある。

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

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

    DEFAULT A

    shipping_method

    配送方法

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

    DEFAULT 01

    shipping_fee_by_product

    個別配送の設定

    T:個別配送
    F:基本配送

    DEFAULT F

    shipping_area

    Max Length : [255]

    配送地域

    shipping_period

    Array Max : [2]

    配送期間

    minimum
    期間設定の最小値
    DEFAULT 1

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

    送料タイプ

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

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

    DEFAULT T

    shipping_rates

    送料金額

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

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

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

    prepaid_shipping_fee

    送料前払いの設定

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

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

    DEFAULT B

    clearance_category_code

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

    海外通関コード

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

    detail_image

    詳細画像

    list_image

    一覧画像

    tiny_image

    縮小一覧画像

    small_image

    縮小画像

    image_upload_type

    画像アップロードタイプ

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

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

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

    DEFAULT A

    additional_information

    追加項目

    key
    追加項目のキー
    Required

    value
    追加項目の値
    price_content

    Max Length : [20]

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

    buy_limit_by_product

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

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

    DEFAULT F

    buy_limit_type

    購入制限

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

    DEFAULT F

    buy_group_list

    購入できる会員ランク

    repurchase_restriction

    再購入制限

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

    DEFAULT F

    single_purchase_restriction

    単独購入制限

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

    DEFAULT F

    points_by_product

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

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

    DEFAULT F

    points_setting_by_payment

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

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

    points_amount

    ポイント設定情報

    except_member_points

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

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

    DEFAULT F

    main

    メイン表示

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

    relational_product

    Array Max : [200]

    関連商品

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

    product_no
    商品番号
    Required

    interrelated
    関連商品の相互登録    
    Required

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

    商品素材

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

    english_product_material

    英語商品素材

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

    cloth_fabric

    生地

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

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

    additional_image

    追加画像

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

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

    adult_certification

    年齢認証

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

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

    DEFAULT F

    exposure_limit_type

    商品表示制限の範囲

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

    DEFAULT A

    exposure_group_list

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

    Definition Copy
    Request example: Copy
    Response example:

    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:表示しない

    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]

    独自商品コード

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

    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

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

    Definition Copy
    Request example: Copy
    Response example:

    Delete a bundleproduct

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Definition Copy
    Request example: Copy
    Response example:

    Categories products

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

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

    Categories products properties

    Attribute Description
    shop_no

    ショップ番号
    product_no

    商品番号

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

    表示順序
    auto_sort

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

    在庫切れ状況
    fixed_sort

    「固定」設定の有無
    not_for_sale

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

    Min : [1]~Max : [3]

    商品カテゴリの詳細

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

    DEFAULT 1
    sequence

    Min : [1]~Max : [999998]

    表示順序

    List all categories products

    GET

    基本スペック

    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

    Definition Copy
    Request example: Copy
    Response example:

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

    Definition Copy
    Request example: Copy
    Response example:

    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

    商品番号

    Definition Copy
    Request example: Copy
    Response example:

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

    Definition Copy
    Request example: Copy
    Response example:

    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

    Definition Copy
    Request example: Copy
    Response example:

    Mains products

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

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

    Mains products properties

    Attribute Description
    shop_no

    ショップ番号

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

    商品番号
    product_name

    商品名
    fixed_sort

    「固定」設定の有無

    List all mains products

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_group
    Required

    メインカテゴリ番号

    Definition Copy
    Request example: Copy
    Response example:

    Count all mains products

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_group
    Required

    メインカテゴリ番号

    Definition Copy
    Request example: Copy
    Response example:

    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

    商品番号

    Definition Copy
    Request example: Copy
    Response example:

    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

    表示順位固定商品の番号

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

    Definition Copy
    Request example: Copy
    Response example:

    Delete a mains product

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    display_group
    Required

    メインカテゴリ番号

    product_no
    Required

    商品番号

    Definition Copy
    Request example: Copy
    Response example:

    Products

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

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

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

    Products properties

    Attribute Description
    shop_no

    ショップ番号

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

    商品番号

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

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

    商品コード

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

    Max Length : [40]

    独自商品コード

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

    Max Length : [250]

    商品名

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

    Max Length : [250]

    英語商品名

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

    Max Length : [250]

    供給会社の商品名

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

    Max Length : [50]

    管理用商品名
    model_name

    Max Length : [100]

    モデル名

    商品のモデル名
    price_excluding_tax

    商品価格(税別)
    price

    商品販売価格

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

    商品の定価

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

    商品仕入れ価格

    商品の原価。原価に売上総利益率を加えて販売価格を計算することができる。APIで原価は参照の目的でしか使われない。
    display

    表示ステータス

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

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

    販売ステータス

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

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

    商品ステータス

    販売する商品のステータス表示

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

    Max : [2147483647]

    中古商品の使用月数
    summary_description

    Max Length : [255]

    商品要約説明

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

    Max Length : [200]

    商品検索キーワード

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

    Min : [-999.99]~Max : [999.99]

    売上総利益率

    商品の原価に加えて販売価格を計算するための売上総利益率。APIでその値は参照の目的でしか使われない。
    tax_type

    課税区分

    商品の課税情報

    消費税込みのタイプ
    課税商品 = 税金が賦課される商品
    免税商品 = 税金が免除される商品。加工されていない農/水/畜産物、練炭、図書類、保険、女性専用などの商品で、課税事業者として登録しなければならない。
    零細商品 = 付加価値税が0%適用される輸出向け外貨稼ぎ商品

    A:課税商品
    B:免税商品
    C:ゼロ税率商品
    tax_amount

    Min : [0]~Max : [100]

    税率

    課税商品の場合、その商品に適用される消費税率を明示する。
    消費税は国家及び地域によって異なることがある。
    price_content

    Max Length : [20]

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

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

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

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

    購入制限

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

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

    購入できる会員ランク
    repurchase_restriction

    再購入制限

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

    単独購入制限

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

    購入単位のタイプ

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

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

    購入単位

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

    注文数量の制限基準

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

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

    Max : [2147483647]

    最小注文数量

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

    Max : [2147483647]

    最大注文数量

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

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

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

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

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

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

    ポイント設定情報
    except_member_points

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

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

    商品容積情報
    adult_certification

    年齢認証

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

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

    詳細画像

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

    一覧画像

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

    縮小一覧画像

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

    縮小画像

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

    オプション使用の設定

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

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

    オプション構成方式

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

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

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

    Naver Payの使用有無

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

    Naver Pay販売タイプ

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

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

    メーカーコード

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

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

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

    トレンドコード

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

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

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

    ブランドコード

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

    入力しない場合は独自ブランド(B0000000)使用
    supplier_code

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

    供給会社のコード

    供給会社を登録すると自動生成されるコードで、商品に特定供給会社を指定する時に使う。
    made_date

    製造日

    商品を製造した製造日
    release_date

    発売開始日

    商品が市場で発売開始された日
    expiration_date

    Array Max : [2]

    有効期間

    商品を正常に使える期間。商品券やチケットのような無形商品、食品や化粧品のような有形商品の有効期間を表示

    主に商品券やチケットのような無形商品に使われ、その無形商品の有効期間を表示。
    origin_classification

    原産国 国内/国外/その他

    F:国内
    T:海外
    E:その他
    origin_place_no

    原産国番号

    List all Origin APIで原産国を検索して原産国番号を入力
    origin_classificationがF(国内)の場合、海外の有無(foreign)が「F」の原産国のみ入力可能
    origin_classificationがT(海外)の場合、海外の有無(foreign)が「T」の原産国のみ入力可能
    origin_place_value

    Max Length : [30]

    原産国のその他の情報

    原産国が「その他(1800)」の場合、原産国として入力可能な情報
    made_in_code

    国名(原産国)コード
    icon_show_period

    アイコンの表示期間

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

    Array Max : [5]

    アイコン

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

    HSコード

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

    ※ HSコード : 世界貿易機関(WTO)及び世界関税機構(WCO)が貿易統計及び関税分類の目的で輸出入商品を数字コードでカテゴリ化したもので、輸入時の税金賦課と輸出品の統制及び統計のための分類法
    product_weight

    商品重量

    商品の全体重量(kg)。配送のために商品の重量だけでなく、ボックスと包装の重量も含めた重量を記載する必要がある。
    product_material

    商品素材

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

    timezone

    作成日

    商品が生成された日時
    updated_date

    timezone

    修正日

    商品が修正された日時
    english_product_material

    英語商品素材

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

    生地

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

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

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

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

    ※ 在庫切れアイコン

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

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

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

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

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

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

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

    承認申込結果

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

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

    独自カテゴリコード

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

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

    在庫切れ状況

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

    販売価格の追加金額
    discountprice

    商品の割引価格リソース


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

    デコ画像リソース


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

    特典リソース


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

    商品オプションリソース


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

    品目リソース


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

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

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

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

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

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

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

    海外通関コード

    clearance_category_code
    additionalimages

    追加の画像リソース


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

    商品表示制限の範囲

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

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

    セット商品のタイプ

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

    メモリソース


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

    商品閲覧数リソース


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

    商品Seo リソース


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

    カテゴリ番号

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

    キャンペーン番号
    description

    商品詳細説明

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

    モバイル商品詳細説明

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

    モバイル用登録

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

    関連商品

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

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

    product_bundle

    セット商品の有無

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

    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

    sort

    並べ替え順序の値

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

    order

    並べ替え順序

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

    offset

    Max : [5000]

    検索結果の開始位置

    検索結果の開始位置

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    Definition Copy
    Request example: Copy
    Response example:

    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

    Definition Copy
    Request example: Copy
    Response example:

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

    Definition Copy
    Request example: Copy
    Response example:

    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

    商品簡略説明

    product_tag

    Max Length : [200]

    商品検索キーワード

    payment_info

    商品決済ガイド

    shipping_info

    商品配送ガイド

    exchange_info

    交換・返品ガイド

    service_info

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

    icon

    Array Max : [5]

    アイコン

    hscode

    Max Length : [20]

    HSコード

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

    shipping_scope

    配送情報

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

    ※ショッピングモールがEC Globalモールの場合は必須で入力する必要がある。

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

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

    shipping_method

    配送方法

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

    shipping_fee_by_product

    個別配送の設定

    T:個別配送
    F:基本配送

    DEFAULT F

    shipping_area

    Max Length : [255]

    配送地域

    shipping_period

    Array Max : [2]

    配送期間

    minimum
    期間設定の最小値
    DEFAULT 1

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

    送料タイプ

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

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

    shipping_rates

    Array Max : [200]

    送料金額

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

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

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

    shipping_rates_min
    送料を適用する範囲の開始値

    shipping_rates_max
    送料を適用する範囲の終了値

    shipping_fee
    送料
    prepaid_shipping_fee

    送料前払いの設定

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

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

    clearance_category_code

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

    海外通関コード

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

    detail_image

    詳細画像

    list_image

    一覧画像

    tiny_image

    縮小一覧画像

    small_image

    縮小画像

    image_upload_type

    画像アップロードタイプ

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

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

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

    DEFAULT A

    additional_information

    追加項目

    key
    追加項目のキー
    Required

    value
    追加項目の値
    price_content

    Max Length : [20]

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

    buy_limit_by_product

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

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

    DEFAULT F

    buy_limit_type

    購入制限

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

    DEFAULT F

    buy_group_list

    購入できる会員ランク

    repurchase_restriction

    再購入制限

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

    DEFAULT F

    single_purchase_restriction

    単独購入制限

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

    DEFAULT F

    buy_unit_type

    購入単位のタイプ

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

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

    DEFAULT O

    buy_unit

    Max : [2147483647]

    購入単位

    DEFAULT 1

    order_quantity_limit_type

    注文数量の制限基準

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

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

    DEFAULT O

    minimum_quantity

    Max : [2147483647]

    最小注文数量

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

    DEFAULT 1

    maximum_quantity

    Max : [2147483647]

    最大注文数量

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

    最大注文数を「制限なし」と入力するには「0」と入力します。

    points_by_product

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

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

    DEFAULT F

    points_setting_by_payment

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

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

    points_amount

    ポイント設定情報

    payment_method
    ポイント決済方法

    naverpay : Naver Pay、smilepay：SmilePay、kakaopay：Kakaopay、payco : PAYCO、paynow：Paynow、kpay：KPAY、icash：バーチャル口座、deposit：預り金、tcash：リアルタイム口座振替、cell：キャリア決済、 card：クレジットカード、mileage：ポイント、cash：銀行振込

    points_rate
    付与率

    points_unit_by_payment
    決済方法別のポイント付与単位

    P：百分率基準、W：ウォン基準
    except_member_points

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

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

    DEFAULT F

    product_volume

    商品容積情報

    use_product_volume
    商品体積の使用有無

    product_width
    幅(W)

    product_height
    奥行(D)

    product_length
    高さ(H)
    origin_classification

    原産国 国内/国外/その他

    F:国内
    T:海外
    E:その他

    origin_place_no

    原産国番号

    List all Origin APIで原産国を検索して原産国番号を入力
    origin_classificationがF(国内)の場合、海外の有無(foreign)が「F」の原産国のみ入力可能
    origin_classificationがT(海外)の場合、海外の有無(foreign)が「T」の原産国のみ入力可能

    origin_place_value

    Max Length : [30]

    原産国のその他の情報

    原産国が「その他(1800)」の場合、原産国として入力可能な情報

    made_in_code

    国名(原産国)コード

    main

    メイン表示

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

    relational_product

    Array Max : [200]

    関連商品

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

    product_no
    商品番号
    Required

    interrelated
    関連商品の相互登録    
    Required

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

    商品素材

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

    english_product_material

    英語商品素材

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

    cloth_fabric

    生地

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

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

    classification_code

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

    独自カテゴリ

    additional_price

    Max : [2147483647]

    販売価格の追加金額

    販売価格の計算時に商品の原価と売上総利益率に加えて追加計算される金額。APIでその金額は参照の目的でしか使われない。

    margin_rate

    Min : [-999.99]~Max : [999.99]

    売上総利益率

    商品の原価に加えて販売価格を計算するための売上総利益率。APIでその値は参照の目的でしか使われない。

    tax_type

    課税区分

    商品の課税情報

    消費税込みのタイプ
    課税商品 = 税金が賦課される商品
    免税商品 = 税金が免除される商品。加工されていない農/水/畜産物、練炭、図書類、保険、女性専用などの商品で、課税事業者として登録しなければならない。
    零細商品 = 付加価値税が0%適用される輸出向け外貨稼ぎ商品

    A:課税商品
    B:免税商品
    C:ゼロ税率商品

    DEFAULT A

    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

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

    Definition Copy
    Request example: Copy
    Response example:

    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

    モバイル商品詳細説明

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

    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

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

    Definition Copy
    Request example: Copy
    Response example:

    Delete a product

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Definition Copy
    Request example: Copy
    Response example:

    Products additionalimages

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

    Endpoints 
    POST /api/v2/admin/products/{product_no}/additionalimages
PUT /api/v2/admin/products/{product_no}/additionalimages

    Products additionalimages properties

    Attribute Description
    shop_no

    ショップ番号
    additional_image

    追加画像

    Create a products additionalimage

    POST

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    additional_image
    Required

    追加画像

    Definition Copy
    Request example: Copy
    Response example:

    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

    追加画像

    Definition Copy
    Request example: Copy
    Response example:

    Products approve

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

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

    Products approve properties

    Attribute Description
    shop_no

    ショップ番号

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

    ステータス

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

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

    商品番号

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

    Get products approve status

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    Definition Copy
    Request example: Copy
    Response example:

    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

    Definition Copy
    Request example: Copy
    Response example:

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

    Definition Copy
    Request example: Copy
    Response example:

    Products decorationimages

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

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

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

    Products decorationimages properties

    Attribute Description
    code

    デコ画像コード
    path

    デコ画像URL
    shop_no

    ショップ番号
    use_show_date

    表示期間の使用の有無

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

    timezone

    表示期間の開始日
    show_end_date

    timezone

    表示期間の終了日
    image_list

    デコ画像一覧

    List all decoration images

    GET

    基本スペック

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

    List all products decoration images

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Definition Copy
    Request example: Copy
    Response example:

    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
    デコ画像の表示位置(垂直値)
    Definition Copy
    Request example: Copy
    Response example:

    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
    デコ画像の表示位置(垂直値)
    Definition Copy
    Request example: Copy
    Response example:

    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

    商品番号

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

    Definition Copy
    Request example: Copy
    Response example:

    Products discountprice

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

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

    Endpoints 
    GET /api/v2/admin/products/{product_no}/discountprice

    Products discountprice properties

    Attribute Description
    pc_discount_price

    PC割引価格
    mobile_discount_price

    モバイル割引価格

    List all products discountprice

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    Definition Copy
    Request example: Copy
    Response example:

    Products hits

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

    Endpoints 
    GET /api/v2/admin/products/{product_no}/hits/count

    Count all products hits

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Definition Copy
    Request example: Copy
    Response example:

    Products icons

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

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

    Products icons properties

    Attribute Description
    code

    商品アイコンコード
    path

    アイコンURL
    shop_no

    ショップ番号
    use_show_date

    表示期間の使用の有無

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

    timezone

    表示期間の開始日
    show_end_date

    timezone

    表示期間の終了日
    image_list

    商品アイコン一覧

    List all icons

    GET

    基本スペック

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

    List all products icons

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Definition Copy
    Request example: Copy
    Response example:

    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
    Definition Copy
    Request example: Copy
    Response example:

    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
    Definition Copy
    Request example: Copy
    Response example:

    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

    商品アイコンコード

    Definition Copy
    Request example: Copy
    Response example:

    Products images

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

    Endpoints 
    POST /api/v2/admin/products/images
POST /api/v2/admin/products/{product_no}/images
DELETE /api/v2/admin/products/{product_no}/images

    Products images properties

    Attribute Description
    path

    詳細画像
    shop_no

    ショップ番号

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

    商品番号

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

    詳細画像

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

    一覧画像

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

    縮小一覧画像

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

    縮小画像

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

    Upload Images

    POST

    基本スペック

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

    要求スペック

    Parameter Description
    image
    Required

    詳細画像

    Definition Copy
    Request example: Copy
    Response example:

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

    Definition Copy
    Request example: Copy
    Response example:

    Delete a products image

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Definition Copy
    Request example: Copy
    Response example:

    Products memos

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

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

    Products memos properties

    Attribute Description
    memo_no

    メモ番号

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

    Max Length : [20]

    作成者ID

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

    timezone

    作成日

    メモを作成した時間
    memo

    メモ

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

    List all products memos

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Definition Copy
    Request example: Copy
    Response example:

    Get a products memo

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    memo_no
    Required

    メモ番号

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

    Definition Copy
    Request example: Copy
    Response example:

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

    Definition Copy
    Request example: Copy
    Response example:

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

    Definition Copy
    Request example: Copy
    Response example:

    Delete a products memo

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    memo_no
    Required

    メモ番号

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

    Definition Copy
    Request example: Copy
    Response example:

    Products options

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

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

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

    Products options properties

    Attribute Description
    shop_no

    ショップ番号

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

    商品番号

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

    オプション使用の設定

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

    オプション構成方式

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

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

    T:組み合わせ型
    E:連携型
    F:独立型
    option_list_type

    オプション表示方式

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

    * 組合一体選択型 : 一つのセレクトボックス(ボタンまたはラジオボタン)にすべてのオプションが組み合わせられて表示される。
    * 組合分離選択型 : オプションをそれぞれのセレクトボックス(ボタンまたはラジオボタン)で選択でき、オプション名を基準にオプション値を組み合わせることができる。

    独立型や商品連動型オプションを使っている場合、S(分離型)と入力される。

    C:一体型
    S:分離型
    option_preset_code

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

    バリエーションコード

    商品連動型オプションを使う場合、オプションセットコード表示
    options

    オプション
    select_one_by_option

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

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

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

    連動型バリエーション名

    商品連動型オプションを使う場合、オプションセットの名前表示
    use_additional_option

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

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

    追加入力オプション
    use_attached_file_option

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

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

    ファイル添付オプション

    List all products options

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Definition Copy
    Request example: Copy
    Response example:

    Create a products option

    POST

    商品オプション登録APIを使ってオプションを登録することができます。オプション登録APIでオプションを登録すると、品目は自動生成されます。

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    has_option

    オプション使用の設定

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

    option_type

    オプション構成方式

    オプションを使う場合、オプションのタイプを入力

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

    T:組み合わせ型
    E:連携型
    F:独立型

    option_list_type

    オプション表示方式

    組合型オプションを使う場合、組合型オプションのタイプを入力

    * 組合一体選択型 : 一つのセレクトボックス(ボタンまたはラジオボタン)にすべてのオプションが組み合わせられて表示される。
    * 組合分離選択型 : オプションをそれぞれのセレクトボックス(ボタンまたはラジオボタン)で選択でき、オプション名を基準にオプション値を組み合わせることができる。

    独立型や商品連動型オプションを使っている場合、S(分離型)と入力される。

    S:組み合わせ分離選択型
    C:組み合わせ一体選択型

    options

    オプション

    option_name
    オプション名
    Required

    option_value Array
    オプション値
    Required

    option_text
    オプション値

    option_image_file
    オプションボタンの画像    

    option_color
    カラーチップの色    

    option_display_type
    オプション表示方式
    DEFAULT S
    S：セレクトボックス、P：プレビュー、B：テキストボタン、R：ラジオボタン
    select_one_by_option

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

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

    T:使用する
    F:使用しない　「独立型だけに存在」をチェックするとオプション別に一つずつ選択値を処理

    option_preset_code

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

    バリエーションコード

    option_preset_name

    連動型バリエーション名

    商品連動型オプションを使う場合、オプションセットの名前を入力

    use_additional_option

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

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

    additional_options

    追加入力オプション

    additional_option_name
    追加入力オプション名    
    Required

    additional_option_text_length
    追加入力オプションの文字数制限
    Required

    1~30
    50
    100
    200

    required_additional_option
    追加入力オプションの必須設定    
    Required
    DEFAULT T
    T：必須、F：任意    
    use_attached_file_option

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

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

    attached_file_option

    ファイル添付オプション

    Definition Copy
    Request example: Copy
    Response example:

    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

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

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

    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

    ファイル添付オプション

    Definition Copy
    Request example: Copy
    Response example:

    Delete a products option

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    product_no
    Required

    商品番号

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

    Definition Copy
    Request example: Copy
    Response example:

    Products seo

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

    Endpoints 
    GET /api/v2/admin/products/{product_no}/seo
PUT /api/v2/admin/products/{product_no}/seo

    Products seo properties

    Attribute Description
    shop_no

    ショップ番号

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

    ブラウザでのタイトル

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

    メタタグ1:Author

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

    メタタグ2:Description

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

    メタタグ3:Keywords

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

    商品画像のalt属性

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

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

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

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

    Get products seo

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Definition Copy
    Request example: Copy
    Response example:

    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

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

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

    Definition Copy
    Request example: Copy
    Response example:

    Products tags

    「Tags」は、商品を特定のキーワードで検索したときにその検索結果に商品を表示させる機能です。 商品名や商品詳細説明に含まれていないキーワードで商品を検索結果に表示させるためには、キーワードを追加することができます。

    検索キーワードはサブリソースであるため、「Products」の以下で使用可能です。

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

    Products tags properties

    Attribute Description
    shop_no

    ショップ番号

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

    商品タグ

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

    商品タグ
    product_no

    商品番号

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

    List all products tags

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Definition Copy
    Request example: Copy
    Response example:

    Count all products tags

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    Definition Copy
    Request example: Copy
    Response example:

    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

    商品タグ

    Definition Copy
    Request example: Copy
    Response example:

    Delete a products tag

    DELETE

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    tag

    商品タグ

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

    Definition Copy
    Request example: Copy
    Response example:

    Products variants

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

    ● 在庫(Inventories)

    Endpoints 
    GET /api/v2/admin/products/{product_no}/variants
GET /api/v2/admin/products/{product_no}/variants/{variant_code}
PUT /api/v2/admin/products/{product_no}/variants/{variant_code}
PUT /api/v2/admin/products/{product_no}/variants
DELETE /api/v2/admin/products/{product_no}/variants/{variant_code}

    Products variants properties

    Attribute Description
    shop_no

    ショップ番号

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

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

    商品品目コード

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

    オプション
    custom_variant_code

    Max Length : [40]

    独自品目コード

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

    表示ステータス

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

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

    販売ステータス

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

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

    追加金額

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

    在庫使用の設定

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

    重要在庫の有無

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

    在庫数量チェックの基準

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

    在庫切れ表示の設定

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

    数量
    safety_inventory

    安全在庫数量
    inventories

    在庫リソース

    品目の在庫Resource
    duplicated_custom_variant_code

    独自品目コードの重複有無

    T:重複する
    F:重複しない
    product_no

    商品番号

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

    List all products variants

    GET

    基本スペック

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

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    product_no
    Required

    商品番号

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

    inventories
    embed

    在庫リソース

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

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

    Definition Copy
    Request example: Copy
    Response example:

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

    Definition Copy
    Request example: Copy
    Response example:

    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

    安全在庫数量

    Definition Copy
    Request example: Copy
    Response example:

    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

    安全在庫数量

    Definition Copy
    Request example: Copy
    Response example:

    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]

    商品品目コード

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

    Definition Copy
    Request example: Copy
    Response example:

    Products variants inventories

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

    Endpoints 
    GET /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories
PUT /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories

    Products variants inventories properties

    Attribute Description
    shop_no

    ショップ番号

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

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

    品目コード

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

    在庫使用の設定

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

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

    重要在庫の有無

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

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

    在庫数量チェックの基準

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

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

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

    在庫切れ表示の設定

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

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

    数量

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

    安全在庫数量

    Get products variants inventory

    GET

    基本スペック

    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]

    品目コード

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

    Definition Copy
    Request example: Copy
    Response example:

    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

    安全在庫数量

    Definition Copy
    Request example: Copy
    Response example:

    Collection

    Brands

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

    Endpoints 
    GET /api/v2/admin/brands
GET /api/v2/admin/brands/count
POST /api/v2/admin/brands
PUT /api/v2/admin/brands/{brand_code}
DELETE /api/v2/admin/brands/{brand_code}

    Brands properties

    Attribute Description
    shop_no

    ショップ番号

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

    DEFAULT 1
    brand_code

    ブランドコード
    brand_name

    Max Length : [50]

    ブランド名
    use_brand

    ブランドの使用有無

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

    Max Length : [200]

    検索キーワード設定
    product_count

    商品数
    created_date

    timezone

    作成日

    List all brands

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    brand_code

    ブランドコード

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

    brand_name

    ブランド名

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

    use_brand

    ブランドの使用有無

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

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Definition Copy
    Request example: Copy
    Response example:

    Count all brands

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    brand_code

    ブランドコード

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

    brand_name

    ブランド名

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

    use_brand

    ブランドの使用有無

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

    Definition Copy
    Request example: Copy
    Response example:

    Create a brand

    POST

    基本スペック

    Property Description
    SCOPE 販売カテゴリの投稿権限 (mall.write_collection)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    brand_name
    Required

    ブランド名

    use_brand

    ブランドの使用有無

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

    DEFAULT T

    search_keyword

    Max Length : [200]

    検索キーワード設定

    Definition Copy
    Request example: Copy
    Response example:

    Update a brand

    PUT

    基本スペック

    Property Description
    SCOPE 販売カテゴリの投稿権限 (mall.write_collection)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    brand_code
    Required

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

    ブランドコード

    brand_name

    ブランド名

    use_brand

    ブランドの使用有無

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

    DEFAULT T

    search_keyword

    Max Length : [200]

    検索キーワード設定

    Definition Copy
    Request example: Copy
    Response example:

    Delete a brand

    DELETE

    基本スペック

    Property Description
    SCOPE 販売カテゴリの投稿権限 (mall.write_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    brand_code
    Required

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

    ブランドコード

    Definition Copy
    Request example: Copy
    Response example:

    Classifications

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

    Endpoints 
    GET /api/v2/admin/classifications
GET /api/v2/admin/classifications/count

    Classifications properties

    Attribute Description
    shop_no

    ショップ番号

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

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

    独自カテゴリコード
    classification_name

    Max Length : [200]

    独自カテゴリ名
    classification_description

    Max Length : [300]

    独自カテゴリの説明
    use_classification

    使用設定
    created_date

    timezone

    作成日
    product_count

    商品数

    List all classifications

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    classification_code

    独自カテゴリコード

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

    classification_name

    独自カテゴリ名

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

    use_classification

    使用設定

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Definition Copy
    Request example: Copy
    Response example:

    Count all classifications

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    classification_code

    独自カテゴリコード

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

    classification_name

    独自カテゴリ名

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

    use_classification

    使用設定

    Definition Copy
    Request example: Copy
    Response example:

    Manufacturers

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

    Endpoints 
    GET /api/v2/admin/manufacturers
GET /api/v2/admin/manufacturers/count
GET /api/v2/admin/manufacturers/{manufacturer_code}
POST /api/v2/admin/manufacturers
PUT /api/v2/admin/manufacturers/{manufacturer_code}

    Manufacturers properties

    Attribute Description
    shop_no

    ショップ番号

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

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

    メーカーコード

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

    Max Length : [50]

    メーカー名

    メーカーの名前。メーカー名はショップ管理者画面でメーカーを区分する基本的な情報である。
    president_name

    Max Length : [30]

    代表者名

    メーカーの代表者の名前
    use_manufacturer

    使用設定

    そのメーカーを使うかどうかを表示

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

    Max Length : [255]

    メールアドレス

    メーカーのお問い合わせメールアドレス

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

    Max Length : [20]

    電話番号

    メーカーの電話番号

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

    Max Length : [255]

    ホームページ

    メーカーのホームページアドレス

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

    郵便番号

    メーカーの事業所の郵便番号

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

    Max Length : [255]

    基本住所

    メーカーの住所(市区町村単位で表記)

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

    Max Length : [255]

    詳細住所

    メーカーの住所(詳細住所表記)

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

    timezone

    作成日

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

    List all manufacturers

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    manufacturer_code

    メーカーコード

    検索したいメーカーのコード

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

    manufacturer_name

    メーカー名

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

    use_manufacturer

    メーカー使用の設定

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

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

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

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    検索結果の開始位置

    Definition Copy
    Request example: Copy
    Response example:

    Count all manufacturers

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    manufacturer_code

    メーカーコード

    検索したいメーカーのコード

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

    manufacturer_name

    メーカー名

    検索キーワードがメーカー名に含まれている供給会社検索(大文字・小文字を区別しない)

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

    use_manufacturer

    メーカー使用の設定

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

    Definition Copy
    Request example: Copy
    Response example:

    Get a manufacturer

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

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

    DEFAULT 1

    manufacturer_code
    Required

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

    メーカーコード

    Definition Copy
    Request example: Copy
    Response example:

    Create a manufacturer

    POST

    基本スペック

    Property Description
    SCOPE 販売カテゴリの投稿権限 (mall.write_collection)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    manufacturer_name
    Required

    メーカー名

    president_name
    Required

    Max Length : [30]

    代表者名

    email

    Max Length : [255]
    Email

    メールアドレス

    phone

    Max Length : [20]
    Phone Number

    電話番号

    homepage

    Max Length : [255]

    ホームページ

    zipcode

    郵便番号

    address1

    Max Length : [255]

    基本住所

    address2

    Max Length : [255]

    詳細住所

    use_manufacturer

    使用設定

    T:使用する
    F:使用しない

    Definition Copy
    Request example: Copy
    Response example:

    Update a manufacturer

    PUT

    基本スペック

    Property Description
    SCOPE 販売カテゴリの投稿権限 (mall.write_collection)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    manufacturer_code
    Required

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    メーカーコード

    manufacturer_name

    メーカー名

    president_name

    代表者名

    email

    Max Length : [255]
    Email

    メールアドレス

    phone

    Max Length : [20]
    Phone Number

    電話番号

    homepage

    Max Length : [255]

    ホームページ

    zipcode

    郵便番号

    address1

    Max Length : [255]

    基本住所

    address2

    Max Length : [255]

    詳細住所

    use_manufacturer

    使用設定

    T:使用する
    F:使用しない

    Definition Copy
    Request example: Copy
    Response example:

    Origin

    原産国(Origin)は商品が生産された地域を意味します。原産国は国外配送などに重要なデータです。カフェ24は多数の原産国をコード化しているため、原産国検索APIで原産国コード情報を確認することができます。

    Endpoints 
    GET /api/v2/admin/origin

    Origin properties

    Attribute Description
    origin_place_no

    原産国番号
    origin_place_name

    原産国名
    foreign

    海外
    made_in_code

    国名(原産国)コード

    List all origin

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    origin_place_no

    原産国番号

    origin_place_name

    Max Length : [50]

    原産国名

    foreign

    海外

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Definition Copy
    Request example: Copy
    Response example:

    トレンド(Trends)は商品の「製作情報」の中でトレンドに入力する情報を意味します。トレンドは商品を区分する販売カテゴリの一つで、商品は必ず一つのトレンドを持っています(指定しない場合は「基本トレンド」を使う)。

    Endpoints 
    GET /api/v2/admin/trends
GET /api/v2/admin/trends/count
    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    trend_code

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    トレンドコード
    trend_name

    Max Length : [50]

    トレンド名
    use_trend

    トレンド使用の設定

    T:使用する
    F:使用しない
    created_date

    timezone

    作成日
    product_count

    商品数
    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    trend_code

    トレンドコード

    ,(コンマ)で複数の件を検索することができる。

    trend_name

    トレンド名

    ,(コンマ)で複数の件を検索することができる。

    use_trend

    トレンド使用の設定

    T:使用する
    F:使用しない

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    GET

    基本スペック

    Property Description
    SCOPE 販売カテゴリの閲覧権限 (mall.read_collection)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    trend_code

    トレンドコード

    ,(コンマ)で複数の件を検索することができる。

    trend_name

    トレンド名

    ,(コンマ)で複数の件を検索することができる。

    use_trend

    トレンド使用の設定

    T:使用する
    F:使用しない

    Supply

    Suppliers

    供給会社(Suppliers)は商品の「製作情報」の中で供給会社に入力する情報を意味します。供給会社はショップに商品を供給して販売できるようにする会社または個人を意味します。供給会社は商品を区分する販売カテゴリの一つで、商品は必ず一つの供給会社を持っています(指定しない場合は「独自供給」を使う)。

    Endpoints 
    GET /api/v2/admin/suppliers
GET /api/v2/admin/suppliers/count
GET /api/v2/admin/suppliers/{supplier_code}
POST /api/v2/admin/suppliers
PUT /api/v2/admin/suppliers/{supplier_code}
DELETE /api/v2/admin/suppliers/{supplier_code}

    Suppliers properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    supplier_code

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。
    supplier_name

    Max Length : [100]

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。
    status

    ステータス

    供給会社との取引現況情報

    A:取引中
    P:取引中止
    N:取引解除
    commission

    手数料

    精算タイプが手数料型(P)の場合に使う手数料情報
    payment_period

    精算周期

    供給会社に対する精算周期を設定することができる。

    0：選択しない
    C：日次精算
    B：週次精算
    A：月次精算
    business_item

    Max Length : [255]

    取引商品タイプ

    供給会社と取り引きする商品のタイプ情報
    payment_type

    精算タイプ

    供給会社に払う金額をどのようなタイプで精算するかを設定することができる。
    手数料型 : 商品の販売価格に対する手数料を策定し、手数料金額を反映して精算する。
    買入型 : 商品登録時に入力した供給価格を基準に精算する。

    P:手数料型
    D:仕入れ型
    supplier_type

    供給会社のタイプ

    供給会社の営業形態

    卸売業者 : 最終消費者には販売せず、小売業者に販売する業者
    仕入れ業者 : 卸売業者から商品を購入して小売業者に販売する業者
    出品業者 : ショップに入店して販売している会社

    WS:卸売業者
    SF:仕入れ業者
    BS:出品業者
    ET:その他
    use_supplier

    使用設定

    その供給会社を使うかどうかを表示

    T:使用する
    F:使用しない
    created_date

    timezone

    登録日

    供給会社の情報が登録された日付
    updated_date

    timezone

    修正日

    供給会社情報が変更された日付
    country_code

    事業所住所の国コード

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    ETC : その他
    zipcode

    Max Length : [10]

    郵便番号

    供給会社の住所の郵便番号
    address1

    Max Length : [255]

    基本住所

    供給会社の住所(市区町村単位で表記)
    address2

    Max Length : [255]

    詳細住所

    供給会社の住所(詳細住所表記)
    manager_information

    担当者

    供給会社の担当者の連絡先情報
    trading_type

    供給会社の仕入れ方法

    商品が供給会社から配送される形態

    仕入れ: 商品を販売者が購入して購入者に配送する。
    直接配送: 商品の注文が入ると供給会社が購入者に直接配送する。

    詳細検索時のみ確認可能である。

    D:仕入れ
    C:直接配送
    payment_method

    精算時期

    精算基準時期
    10：決済完了
    30：配送開始
    40：配送完了

    詳細検索時のみ確認可能である。

    10 : 決済完了
    30 : 配送開始
    40 : 配送完了
    payment_start_day

    Min : [0]~Max : [6]

    精算開始曜日

    精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。
    0 : 毎週日曜日に精算
    1 : 毎週月曜日に精算
    2 : 毎週火曜日に精算
    3 : 毎週水曜日に精算
    4 : 毎週木曜日に精算
    5 : 毎週金曜日に精算
    6 : 毎週土曜日に精算

    詳細検索時のみ確認可能である。

    0 : 日曜日
    1 : 月曜日
    2 : 火曜日
    3 : 水曜日
    4 : 木曜日
    5 : 金曜日
    6 : 土曜日
    payment_end_day

    Min : [0]~Max : [6]

    精算終了曜日

    精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。
    0 : 毎週日曜日に精算
    1 : 毎週月曜日に精算
    2 : 毎週火曜日に精算
    3 : 毎週水曜日に精算
    4 : 毎週木曜日に精算
    5 : 毎週金曜日に精算
    6 : 毎週土曜日に精算

    詳細検索時のみ確認可能である。

    0 : 日曜日
    1 : 月曜日
    2 : 火曜日
    3 : 水曜日
    4 : 木曜日
    5 : 金曜日
    6 : 土曜日
    payment_start_date

    Min : [1]~Max : [31]

    精算開始日

    精算周期が月間精算(A)である場合、該当日付を精算開始日とする。

    詳細検索時のみ確認可能である。
    payment_end_date

    Min : [1]~Max : [31]

    精算終了日

    精算周期が月間精算(A)である場合、該当日付を精算終了日とする。

    詳細検索時のみ確認可能である。
    bank_code

    Max Length : [50]

    銀行コード

    供給会社精算時に使う口座の入金銀行コード

    bank_code

    詳細検索時のみ確認可能である。
    bank_account_no

    口座番号

    供給会社精算時に使う口座の番号

    詳細検索時のみ確認可能である。
    bank_account_name

    口座名義

    供給会社精算時に使う口座の名義

    詳細検索時のみ確認可能である。
    phone

    Max Length : [20]

    電話番号

    供給会社の事業所の電話番号

    詳細検索時のみ確認可能である。
    fax

    Max Length : [20]

    ファックス番号

    供給会社のファックス番号

    詳細検索時のみ確認可能である。
    market_country_code

    市場の住所の国コード

    詳細検索時のみ確認可能である。

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    ETC : その他
    market_zipcode

    Max Length : [10]

    市場の郵便番号

    詳細検索時のみ確認可能である。
    market_address1

    市場の住所(基本)

    詳細検索時のみ確認可能である。
    market_address2

    市場の住所(詳細)

    詳細検索時のみ確認可能である。
    exchange_country_code

    事業所住所の国コード

    詳細検索時のみ確認可能である。

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    ETC : その他
    exchange_zipcode

    Max Length : [10]

    返品先の郵便番号

    詳細検索時のみ確認可能である。
    exchange_address1

    Max Length : [255]

    返品先の住所(基本)

    詳細検索時のみ確認可能である。
    exchange_address2

    Max Length : [255]

    返品先の住所(詳細)

    詳細検索時のみ確認可能である。
    homepage_url

    Max Length : [100]

    ホームページアドレス

    詳細検索時のみ確認可能である。
    mall_url

    Max Length : [100]

    ショップのアドレス

    詳細検索時のみ確認可能である。
    account_start_date

    Max Length : [10]

    取引開始日

    詳細検索時のみ確認可能である。
    account_stop_date

    Max Length : [10]

    取引中止日

    詳細検索時のみ確認可能である。
    show_supplier_info

    Max Length : [100]

    供給会社情報の表示

    詳細検索時のみ確認可能である。

    SP:電話番号
    SM:事業場の住所
    MA:市場の住所
    EA:返品先の住所
    MN:担当者名
    MI:担当者の連絡先
    memo

    Max Length : [255]

    メモ

    供給会社に対する管理用メモ

    詳細検索時のみ確認可能である。
    company_registration_no

    Max Length : [12]

    事業者登録番号

    供給会社の事業者登録番号。国別に事業者に固有の登録番号が発行される場合に表示する。

    詳細検索時のみ確認可能である。
    company_name

    商号

    事業者登録時に供給会社が登録した商号

    詳細検索時のみ確認可能である。
    president_name

    代表者名

    事業者登録時に供給会社が登録した代表者名

    詳細検索時のみ確認可能である。
    company_condition

    業態

    事業者登録時に供給会社が登録した業態

    詳細検索時のみ確認可能である。
    company_line

    種目

    事業者登録時に供給会社が登録した業種

    詳細検索時のみ確認可能である。
    company_introduction

    会社紹介

    供給会社について簡単に紹介。ネットショップの会社概要画面に表示される。

    詳細検索時のみ確認可能である。

    List all suppliers

    GET

    基本スペック

    Property Description
    SCOPE 供給会社の情報の閲覧権限 (mall.read_supply)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    supplier_code

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。

    ,(コンマ)で複数の件を検索することができる。

    supplier_name

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

    ,(コンマ)で複数の件を検索することができる。

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Definition Copy
    Request example: Copy
    Response example:

    Count all suppliers

    GET

    基本スペック

    Property Description
    SCOPE 供給会社の情報の閲覧権限 (mall.read_supply)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    supplier_code

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。

    ,(コンマ)で複数の件を検索することができる。

    supplier_name

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

    ,(コンマ)で複数の件を検索することができる。

    Definition Copy
    Request example: Copy
    Response example:

    Get a supplier

    GET

    基本スペック

    Property Description
    SCOPE 供給会社の情報の閲覧権限 (mall.read_supply)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    supplier_code
    Required

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。

    Definition Copy
    Request example: Copy
    Response example:

    Create a supplier

    POST

    基本スペック

    Property Description
    SCOPE 供給会社の情報の投稿権限 (mall.write_supply)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    supplier_name
    Required

    Max Length : [50]

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

    manager_information

    Array Max : [3]

    担当者

    no
    担当者の一連番号
    Required

    name
    担当者の氏名
    Required

    phone
    担当者の連絡先

    email
    担当者のメールアドレス
    use_supplier

    使用設定

    その供給会社を使うかどうかを表示

    T:使用する
    F:使用しない

    DEFAULT T

    trading_type

    供給会社の仕入れ方法

    商品が供給会社から配送される形態

    仕入れ: 商品を販売者が購入して購入者に配送する。
    直接配送: 商品の注文が入ると供給会社が購入者に直接配送する。

    D:仕入れ
    C:直接配送

    DEFAULT D

    supplier_type

    供給会社のタイプ

    供給会社の営業形態

    卸売業者 : 最終消費者には販売せず、小売業者に販売する業者
    仕入れ業者 : 卸売業者から商品を購入して小売業者に販売する業者
    出品業者 : ショップに入店して販売している会社

    WS:卸売業者
    SF:仕入れ業者
    BS:出品業者
    ET:その他

    DEFAULT WS

    status

    ステータス

    供給会社との取引現況情報

    A:取引中
    P:取引中止
    N:取引解除

    DEFAULT A

    business_item

    Max Length : [255]

    取引商品タイプ

    供給会社と取り引きする商品のタイプ情報

    payment_type

    精算タイプ

    供給会社に払う金額をどのようなタイプで精算するかを設定することができる。
    手数料型 : 商品の販売価格に対する手数料を策定し、手数料金額を反映して精算する。
    買入型 : 商品登録時に入力した供給価格を基準に精算する。

    P:手数料型
    D:仕入れ型

    DEFAULT P

    payment_period

    精算周期

    供給会社に対する精算周期を設定することができる。

    0：選択しない
    C：日次精算
    B：週次精算
    A：月次精算

    payment_method

    精算時期

    精算基準時期
    10：決済完了
    30：配送開始
    40：配送完了

    10 : 決済完了
    30 : 配送開始
    40 : 配送完了

    payment_start_day

    Min : [0]~Max : [6]

    精算開始曜日

    精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。
    0 : 毎週日曜日に精算
    1 : 毎週月曜日に精算
    2 : 毎週火曜日に精算
    3 : 毎週水曜日に精算
    4 : 毎週木曜日に精算
    5 : 毎週金曜日に精算
    6 : 毎週土曜日に精算

    0 : 日曜日
    1 : 月曜日
    2 : 火曜日
    3 : 水曜日
    4 : 木曜日
    5 : 金曜日
    6 : 土曜日

    payment_end_day

    Min : [0]~Max : [6]

    精算終了曜日

    精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。
    0 : 毎週日曜日に精算
    1 : 毎週月曜日に精算
    2 : 毎週火曜日に精算
    3 : 毎週水曜日に精算
    4 : 毎週木曜日に精算
    5 : 毎週金曜日に精算
    6 : 毎週土曜日に精算

    0 : 日曜日
    1 : 月曜日
    2 : 火曜日
    3 : 水曜日
    4 : 木曜日
    5 : 金曜日
    6 : 土曜日

    payment_start_date

    Min : [1]~Max : [31]

    精算開始日

    精算周期が月間精算(A)である場合、該当日付を精算開始日とする。

    payment_end_date

    Min : [1]~Max : [31]

    精算終了日

    精算周期が月間精算(A)である場合、該当日付を精算終了日とする。

    commission

    手数料率

    精算タイプが手数料型(P)の場合に使う手数料情報

    DEFAULT 10

    phone

    Max Length : [20]
    Phone Number

    電話番号

    供給会社の事業所の電話番号

    fax

    Max Length : [20]
    Phone Number

    ファックス番号

    供給会社のファックス番号

    country_code

    事業所住所の国コード

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    VNM : ベトナム
    ETC : その他

    zipcode

    Max Length : [10]

    郵便番号

    供給会社の住所の郵便番号

    address1

    Max Length : [255]

    基本住所

    供給会社の住所(市区町村単位で表記)

    address2

    Max Length : [255]

    詳細住所

    供給会社の住所(詳細住所表記)

    market_country_code

    市場の住所の国コード

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    VNM : ベトナム
    ETC : その他

    market_zipcode

    Max Length : [10]

    市場の郵便番号

    market_address1

    市場の住所(基本)

    market_address2

    市場の住所(詳細)

    exchange_country_code

    事業所住所の国コード

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    VNM : ベトナム
    ETC : その他

    exchange_zipcode

    Max Length : [10]

    返品先の郵便番号

    exchange_address1

    Max Length : [255]

    返品先の住所(基本)

    exchange_address2

    Max Length : [255]

    返品先の住所(詳細)

    homepage_url

    Max Length : [100]

    ホームページアドレス

    mall_url

    Max Length : [100]

    ショップのアドレス

    account_start_date

    Max Length : [10]
    Date

    取引開始日

    account_stop_date

    Max Length : [10]
    Date

    取引中止日

    memo

    Max Length : [255]

    メモ

    供給会社に対する管理用メモ

    company_registration_no

    Max Length : [12]
    Business Number

    事業者登録番号

    供給会社の事業者登録番号。国別に事業者に固有の登録番号が発行される場合に表示する。

    company_name

    Max Length : [30]

    商号

    事業者登録時に供給会社が登録した商号

    president_name

    Max Length : [20]

    代表者名

    事業者登録時に供給会社が登録した代表者名

    company_condition

    Max Length : [20]

    業態

    事業者登録時に供給会社が登録した業態

    company_line

    Max Length : [20]

    種目

    事業者登録時に供給会社が登録した業種

    company_introduction

    会社紹介

    供給会社について簡単に紹介。ネットショップの会社概要画面に表示される。

    Definition Copy
    Request example: Copy
    Response example:

    Update a supplier

    PUT

    基本スペック

    Property Description
    SCOPE 供給会社の情報の投稿権限 (mall.write_supply)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    supplier_code
    Required

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。

    supplier_name

    Max Length : [50]

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

    use_supplier

    使用設定

    その供給会社を使うかどうかを表示

    T:使用する
    F:使用しない

    trading_type

    供給会社の仕入れ方法

    商品が供給会社から配送される形態

    仕入れ: 商品を販売者が購入して購入者に配送する。
    直接配送: 商品の注文が入ると供給会社が購入者に直接配送する。

    D:仕入れ
    C:直接配送

    supplier_type

    供給会社のタイプ

    供給会社の営業形態

    卸売業者 : 最終消費者には販売せず、小売業者に販売する業者
    仕入れ業者 : 卸売業者から商品を購入して小売業者に販売する業者
    出品業者 : ショップに入店して販売している会社

    WS:卸売業者
    SF:仕入れ業者
    BS:出品業者
    ET:その他

    status

    ステータス

    供給会社との取引現況情報

    A:取引中
    P:取引中止
    N:取引解除

    payment_type

    精算タイプ

    供給会社に払う金額をどのようなタイプで精算するかを設定することができる。
    手数料型 : 商品の販売価格に対する手数料を策定し、手数料金額を反映して精算する。
    買入型 : 商品登録時に入力した供給価格を基準に精算する。

    P:手数料型
    D:仕入れ型

    payment_period

    精算周期

    供給会社に対する精算周期を設定することができる。

    0：選択しない
    C：日次精算
    B：週次精算
    A：月次精算

    commission

    手数料率

    精算タイプが手数料型(P)の場合に使う手数料情報

    manager_information

    Array Max : [3]

    担当者

    no
    担当者の一連番号
    Required

    name
    担当者の氏名
    Required

    phone
    担当者の連絡先

    email
    担当者のメールアドレス

    use_sms
    SMS

    T:受信する、F:受信しない
    business_item

    Max Length : [255]

    取引商品タイプ

    供給会社と取り引きする商品のタイプ情報

    payment_method

    精算時期

    精算基準時期
    10：決済完了
    30：配送開始
    40：配送完了

    10 : 決済完了
    30 : 配送開始
    40 : 配送完了

    payment_start_day

    Min : [0]~Max : [6]

    精算開始曜日

    精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。
    0 : 毎週日曜日に精算
    1 : 毎週月曜日に精算
    2 : 毎週火曜日に精算
    3 : 毎週水曜日に精算
    4 : 毎週木曜日に精算
    5 : 毎週金曜日に精算
    6 : 毎週土曜日に精算

    0 : 日曜日
    1 : 月曜日
    2 : 火曜日
    3 : 水曜日
    4 : 木曜日
    5 : 金曜日
    6 : 土曜日

    payment_end_day

    Min : [0]~Max : [6]

    精算終了曜日

    精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。
    0 : 毎週日曜日に精算
    1 : 毎週月曜日に精算
    2 : 毎週火曜日に精算
    3 : 毎週水曜日に精算
    4 : 毎週木曜日に精算
    5 : 毎週金曜日に精算
    6 : 毎週土曜日に精算

    0 : 日曜日
    1 : 月曜日
    2 : 火曜日
    3 : 水曜日
    4 : 木曜日
    5 : 金曜日
    6 : 土曜日

    payment_start_date

    Min : [1]~Max : [31]

    精算開始日

    精算周期が月間精算(A)である場合、該当日付を精算開始日とする。

    payment_end_date

    Min : [1]~Max : [31]

    精算終了日

    精算周期が月間精算(A)である場合、該当日付を精算終了日とする。

    phone

    Max Length : [20]
    Phone Number

    電話番号

    供給会社の事業所の電話番号

    fax

    Max Length : [20]
    Phone Number

    ファックス番号

    供給会社のファックス番号

    country_code

    事業所住所の国コード

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    VNM : ベトナム
    ETC : その他

    zipcode

    Max Length : [10]

    郵便番号

    供給会社の住所の郵便番号

    address1

    Max Length : [255]

    基本住所

    供給会社の住所(市区町村単位で表記)

    address2

    Max Length : [255]

    詳細住所

    供給会社の住所(詳細住所表記)

    market_country_code

    市場の住所の国コード

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    VNM : ベトナム
    ETC : その他

    market_zipcode

    Max Length : [10]

    市場の郵便番号

    market_address1

    市場の住所(基本)

    market_address2

    市場の住所(詳細)

    exchange_country_code

    事業所住所の国コード

    KOR : 韓国
    JPN : 日本
    CHN : 中国
    TWN : 台湾
    VNM : ベトナム
    ETC : その他

    exchange_zipcode

    Max Length : [10]

    返品先の郵便番号

    exchange_address1

    Max Length : [255]

    返品先の住所(基本)

    exchange_address2

    Max Length : [255]

    返品先の住所(詳細)

    homepage_url

    Max Length : [100]

    ホームページアドレス

    mall_url

    Max Length : [100]

    ショップのアドレス

    account_start_date

    Max Length : [10]
    Date

    取引開始日

    account_stop_date

    Max Length : [10]
    Date

    取引中止日

    memo

    Max Length : [255]

    メモ

    供給会社に対する管理用メモ

    company_registration_no

    Max Length : [12]
    Business Number

    事業者登録番号

    供給会社の事業者登録番号。国別に事業者に固有の登録番号が発行される場合に表示する。

    company_name

    Max Length : [30]

    商号

    事業者登録時に供給会社が登録した商号

    president_name

    Max Length : [20]

    代表者名

    事業者登録時に供給会社が登録した代表者名

    company_condition

    Max Length : [20]

    業態

    事業者登録時に供給会社が登録した業態

    company_line

    Max Length : [20]

    種目

    事業者登録時に供給会社が登録した業種

    company_introduction

    会社紹介

    供給会社について簡単に紹介。ネットショップの会社概要画面に表示される。

    Definition Copy
    Request example: Copy
    Response example:

    Delete a supplier

    DELETE

    基本スペック

    Property Description
    SCOPE 供給会社の情報の投稿権限 (mall.write_supply)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    supplier_code
    Required

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    供給会社のコード

    Definition Copy
    Request example: Copy
    Response example:

    Suppliers users

    供給会社の運営者(Supplier Users)は供給会社がショップにログインして商品を直接登録する場合に使います。供給会社の運営者に商品のアップロード、カテゴリ管理、掲示板管理など制限的な権限を付与することができます。

    Endpoints 
    GET /api/v2/admin/suppliers/users
GET /api/v2/admin/suppliers/users/count
GET /api/v2/admin/suppliers/users/{user_id}

    Suppliers users properties

    Attribute Description
    user_id

    Type : [a-zA-Z0-9]
    Max Length : [20]

    供給会社の運営者ID

    供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。
    supplier_code

    Max Length : [8]

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。
    supplier_name

    Max Length : [100]

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。
    permission_category_select

    商品登録時のカテゴリ選択権限

    供給会社の運営者が商品登録時に商品カテゴリを選択して登録できる権限を設定

    T:許容する
    F:許容しない
    permission_product_modify

    商品修正の権限

    供給会社の運営者が商品を登録した後、商品情報を修正できる権限を設定

    T:許容する
    F:許容しない
    permission_product_display

    商品表示の権限

    供給会社の運営者が商品を登録した後、ショップの画面に表示できる権限を設定

    T:許容する
    F:許容しない
    permission_product_selling

    商品販売の権限

    供給会社の運営者が商品を登録した後、その商品の販売有無を設定できる権限を設定

    T:許容する
    F:許容しない
    permission_product_delete

    登録商品の削除権限

    供給会社の運営者が自分で登録した商品を削除できる権限を設定

    T:許容する
    F:許容しない
    permission_board_manage

    掲示板の権限設定

    供給会社の運営者がショップの掲示板にアクセスできる権限を設定

    T:許容する
    F:許容しない
    user_name

    供給会社の運営者

    供給会社の運営者の名前。供給会社の運営者名は供給会社の運営者がショップ管理者画面で作業をする場合、「作業を実行した人(処理者)」の部分に表示される名前を意味する。
    供給会社運営者の詳細検索APIでしか確認できない。

    詳細検索時のみ確認可能である。
    nick_name

    Length Min : [4]~Max : [20]

    運営者ニックネーム

    供給会社の運営者のニックネーム。供給会社の運営者のニックネームは供給会社の運営者が掲示板に投稿する際に「投稿者」に表示されるニックネームを意味する(ただ、その掲示板が作成者名の代わりに「ニックネーム」を表示するように設定されている場合に限る)。
    供給会社の運営者の詳細検索APIでしか確認できない。

    詳細検索時のみ確認可能である。
    nick_name_icon_type

    ニックネームアイコンのタイプ

    供給会社の運営者のニックネームの横に表示されるアイコンを設定することができる。

    直接アイコン登録 : ニックネームアイコンを直接アップロードして設定することができる。
    サンプルアイコン登録 : 事前に提供されているアイコンを選択して設定することができる。
    供給会社運営者の詳細検索APIでしか確認できない。

    詳細検索時のみ確認可能である。

    D:直接
    S:サンプル
    nick_name_icon_url

    Max Length : [255]

    ニックネームアイコンのURL

    供給会社の運営者のニックネームアイコンの画像経路

    供給会社運営者の詳細検索APIでしか確認できない。

    詳細検索時のみ確認可能である。
    use_nick_name_icon

    掲示板へのニックネームアイコン表示設定

    供給会社の運営者が掲示板に投稿する際、ニックネームアイコンを表示するかどうかを設定

    供給会社運営者の詳細検索APIでしか確認できない。

    詳細検索時のみ確認可能である。

    T:表示
    F:表示しない
    use_writer_name_icon

    掲示板への作成者表示設定

    供給会社の運営者が掲示板に投稿する際、作成者名を表示するかどうかを設定

    供給会社運営者の詳細検索APIでしか確認できない。

    詳細検索時のみ確認可能である。

    T:表示
    F:表示しない
    email

    メールアドレス

    供給会社の運営者のメールアドレス。供給会社の運営者の連絡先を保存する目的で使う。

    供給会社の運営者の詳細検索APIでしか確認できない。

    詳細検索時のみ確認可能である。
    phone

    電話番号

    供給会社の運営者の電話番号。供給会社の運営者の連絡先を保存する目的で使う。

    供給会社の運営者の詳細検索APIでのみ確認が可能。

    詳細検索時のみ確認可能である。
    permission_shop_no

    アクセス可能ショップ

    マルチショップを区分するために使うショップ番号

    詳細検索時のみ確認可能である。
    permitted_category_list

    商品登録時に許容される商品カテゴリ

    供給会社の運営者が商品登録時に選択可能な商品カテゴリ。供給会社の運営者は商品登録時にその商品カテゴリにしか商品をアップロードすることができない。

    供給会社運営者の詳細検索APIでしか確認できない。

    詳細検索時のみ確認可能である。

    List all suppliers users

    GET

    基本スペック

    Property Description
    SCOPE 供給会社の情報の閲覧権限 (mall.read_supply)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    user_id

    Type : [a-zA-Z0-9]
    Max Length : [20]

    供給会社の運営者ID

    供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。

    supplier_code

    Max Length : [8]

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。

    supplier_name

    Max Length : [100]

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

    Definition Copy
    Request example: Copy
    Response example:

    Count all suppliers users

    GET

    基本スペック

    Property Description
    SCOPE 供給会社の情報の閲覧権限 (mall.read_supply)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    user_id

    Type : [a-zA-Z0-9]
    Max Length : [20]

    供給会社の運営者ID

    供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。

    supplier_code

    Max Length : [8]

    供給会社のコード

    システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。

    supplier_name

    Max Length : [100]

    供給会社名

    供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

    Definition Copy
    Request example: Copy
    Response example:

    Get a suppliers user

    GET

    基本スペック

    Property Description
    SCOPE 供給会社の情報の閲覧権限 (mall.read_supply)
    呼び出し件数制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    user_id

    Type : [a-zA-Z0-9]
    Max Length : [20]

    供給会社の運営者ID

    供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。

    Definition Copy
    Request example: Copy
    Response example:

    Personal

    Carts

    Endpoints 
    GET /api/v2/admin/carts

    Carts properties

    Attribute Description
    shop_no

    ショップ番号
    basket_product_no

    カート内の商品番号
    member_id

    会員ID
    created_date

    timezone

    追加日
    product_no

    商品番号
    additional_option_values

    追加入力オプション
    variant_code

    Type : [A-Z0-9]
    Length Min : [12]~Max : [12]

    商品品目コード
    quantity

    数量
    product_price

    商品販売価格
    option_price

    オプション追加価格
    product_bundle

    セット商品の有無

    T:セット商品
    F:セット商品ではない
    shipping_type

    配送タイプ

    A:国内
    B:海外
    category_no

    カテゴリ番号

    List all carts

    GET

    基本スペック

    Property Description
    SCOPE 個人化情報の閲覧権限 (mall.read_personal)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    member_id
    Required

    会員ID

    ,(コンマ)で複数の件を検索することができる。

    offset

    Max : [10000]

    検索結果の開始位置

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    DEFAULT 10

    Definition Copy
    Request example: Copy
    Response example:

    Customers wishlist

    「Customers wishlist」は会員のお気に入りを照会できるリレーショナルリソースです。

    Endpoints 
    GET /api/v2/admin/customers/{member_id}/wishlist
GET /api/v2/admin/customers/{member_id}/wishlist/count

    Customers wishlist properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    wishlist_no

    お気に入り番号
    product_no

    商品番号
    variant_code

    Type : [A-Z0-9]
    Length Min : [12]~Max : [12]

    品目コード

    システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。
    additional_option

    追加入力オプション
    attached_file_option

    ファイル添付オプション
    price

    商品販売価格

    商品の販売価格。クーポン及び特典を適用する前の価格
    商品登録時にはマルチショップに同じ価格で登録するが、ショップ別に異なる価格を入力したい場合は商品修正を通じて異なる価格を入力することができる。
    ※ 販売価格 = [ 原価 + (原価 * 売上総利益率) + 追加金額 ]
    product_bundle

    セット商品の有無
    created_date

    timezone

    追加日

    商品をお気に入りに追加した日付
    price_content

    Max Length : [20]

    販売価格の代替メッセージ

    List all customers wishlist

    GET

    会員のお気に入り商品リストを照会

    基本スペック

    Property Description
    SCOPE 個人化情報の閲覧権限 (mall.read_personal)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    member_id
    Required

    会員ID

    shop_no

    ショップ番号

    DEFAULT 1

    Definition Copy
    Request example: Copy
    Response example:

    Count all customers wishlist

    GET

    会員のお気に入り商品数を照会

    基本スペック

    Property Description
    SCOPE 個人化情報の閲覧権限 (mall.read_personal)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    member_id
    Required

    会員ID

    shop_no

    ショップ番号

    DEFAULT 1

    Definition Copy
    Request example: Copy
    Response example:

    Products carts

    Endpoints 
    GET /api/v2/admin/products/{product_no}/carts
GET /api/v2/admin/products/{product_no}/carts/count

    Products carts properties

    Attribute Description
    shop_no

    ショップ番号
    member_id

    会員ID
    created_date

    timezone

    追加日
    product_no

    商品番号
    variant_code

    商品品目コード
    quantity

    数量
    product_bundle

    セット商品の有無

    T:セット商品
    F:セット商品ではない

    List all products carts

    GET

    基本スペック

    Property Description
    SCOPE 個人化情報の閲覧権限 (mall.read_personal)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    limit

    Min : [1]~Max : [100]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [10000]

    検索結果の開始位置

    Definition Copy
    Request example: Copy
    Response example:

    Count all products carts

    GET

    基本スペック

    Property Description
    SCOPE 個人化情報の閲覧権限 (mall.read_personal)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    product_no
    Required

    商品番号

    Definition Copy
    Request example: Copy
    Response example:

    Order

    Cancellation

    Endpoints 
    GET /api/v2/admin/cancellation/{claim_code}
POST /api/v2/admin/cancellation

    Cancellation properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号
    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

    使用済み預り金の返還額

    詳細検索時のみ確認可能である。
    items

    品目別注文コード
    status

    注文ステータス

    canceled:キャンセル完了

    Get a cancellation

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    claim_code
    Required

    キャンセル番号

    Definition Copy
    Request example: Copy
    Response example:

    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
    Definition Copy
    Request example: Copy
    Response example:

    Cashreceipt

    Endpoints 
    GET /api/v2/admin/cashreceipt
POST /api/v2/admin/cashreceipt
PUT /api/v2/admin/cashreceipt/{cashreceipt_no}

    Cashreceipt properties

    Attribute Description
    cashreceipt_no

    現金領収証番号
    approval_no

    承認番号
    request_date

    申込日
    order_id

    注文番号
    member_id

    会員ID
    name

    要請者名
    order_price_amount

    商品購入金額
    vat

    消費税
    subtotal

    申込み金額合計
    order_status

    注文ステータス

    入金前：unpaid
    未配送：unshipped
    配送中：shipping
    出荷待ち：standby
    配送完了：shipped
    一部キャンセル：partially_canceled
    すべてキャンセル： canceled
    status

    処理ステータス

    申込み：request
    発行待ち：await_issuance
    発行：issued
    発行拒否：issuance_rejected
    申込み取消し：canceled_request
    発行取消し：canceled_issuance
    発行失敗：failed_issuance
    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]

    検索結果の開始位置

    Definition Copy
    Request example: Copy
    Response example:

    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]

    電話番号(携帯)

    Definition Copy
    Request example: Copy
    Response example:

    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]

    電話番号(携帯)

    Definition Copy
    Request example: Copy
    Response example:

    Cashreceipt cancellation

    Endpoints 
    PUT /api/v2/admin/cashreceipt/{cashreceipt_no}/cancellation

    Cashreceipt cancellation properties

    Attribute Description
    cashreceipt_no

    現金領収証番号
    order_id

    注文番号
    status

    処理ステータス

    申込み取消し：canceled_request
    発行取消し：canceled_issuance

    Update a cashreceipt cancellation

    PUT

    基本スペック

    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

    Definition Copy
    Request example: Copy
    Response example:

    Collectrequests

    Endpoints 
    PUT /api/v2/admin/collectrequests/{request_no}

    Collectrequests properties

    Attribute Description
    shop_no

    ショップ番号
    request_no

    LIBSPECDATAREQUEST.NUMBER
    order_id

    注文番号
    order_item_code

    品目別注文コード
    shipping_company_name

    LIBSPECDATACOLLECT.SHIPPING.COMPANY.NAME
    collect_tracking_no

    LIBSPECDATACOLLECTION.TRACKING.NUMBER

    Update a collectrequest

    PUT

    基本スペック

    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

    Definition Copy
    Request example: Copy
    Response example:

    Exchange

    Endpoints 
    GET /api/v2/admin/exchange/{claim_code}

    Exchange properties

    Attribute Description
    shop_no

    ショップ番号

    詳細検索時のみ確認可能である。
    order_id

    注文番号

    詳細検索時のみ確認可能である。
    claim_code

    交換番号

    詳細検索時のみ確認可能である。
    claim_reason_type

    区分

    詳細検索時のみ確認可能である。

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他
    claim_reason

    理由

    詳細検索時のみ確認可能である。
    claim_due_date

    交換処理の予定日

    詳細検索時のみ確認可能である。
    receiver

    受取人

    詳細検索時のみ確認可能である。
    reshipping_detail

    交換による再発送の情報

    詳細検索時のみ確認可能である。
    pickup

    受取人の住所

    詳細検索時のみ確認可能である。
    additional_payment

    追加決済

    詳細検索時のみ確認可能である。
    return_invoice_no

    返品用送り状の送り状番号

    詳細検索時のみ確認可能である。
    return_shipping_company_name

    返品に使用する配送会社名

    詳細検索時のみ確認可能である。
    refund_method

    返金方式

    詳細検索時のみ確認可能である。
    refund_reason

    備考

    詳細検索時のみ確認可能である。
    order_price_amount

    商品購入金額

    詳細検索時のみ確認可能である。
    refund_amount

    返金額

    詳細検索時のみ確認可能である。
    shipping_fee

    送料

    詳細検索時のみ確認可能である。
    return_ship_type

    返品送料の適用区分

    詳細検索時のみ確認可能である。
    defer_commission

    後払い手数料

    詳細検索時のみ確認可能である。
    partner_discount_amount

    提携割引のキャンセル金額

    詳細検索時のみ確認可能である。
    add_discount_amount

    商品別追加割引の
    キャンセル金額

    詳細検索時のみ確認可能である。
    member_grade_discount_amount

    会員ランク割引の
    キャンセル金額

    詳細検索時のみ確認可能である。
    shipping_discount_amount

    送料割引のキャンセル金額

    詳細検索時のみ確認可能である。
    coupon_discount_amount

    クーポン割引の
    キャンセル金額

    詳細検索時のみ確認可能である。
    point_used

    使用済みポイントの返還額

    詳細検索時のみ確認可能である。
    credit_used

    使用済み預り金の返還額

    詳細検索時のみ確認可能である。
    items

    品目別注文エンティティ

    詳細検索時のみ確認可能である。
    exchanged_items

    交換商品

    詳細検索時のみ確認可能である。

    Get an exchange

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    claim_code
    Required

    交換番号

    Definition Copy
    Request example: Copy
    Response example:

    Orders

    Orders Resource関係図

    注文(order)はショップでショップの顧客が商品を購入するためにショップに要求した内訳です。ショップの運営者は決済済みの注文情報を見てショップの顧客に商品を配送します。注文情報には注文と決済を行った注文者の情報と商品を受け取る受取人の情報が含まれています。


    注文は下記のようなResourceを下位Resourceとして持っています。
    ● 品目別注文(Items)
    ● 受取人情報(Receivers)

    Endpoints 
    GET /api/v2/admin/orders
GET /api/v2/admin/orders/count
GET /api/v2/admin/orders/{order_id}
PUT /api/v2/admin/orders/{order_id}
PUT /api/v2/admin/orders

    Orders properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    currency

    通貨単位

    マルチショップの通貨単位
    order_id

    注文番号
    market_id

    モール型ECサイトの区分値

    価格比較サイトを経由してモール型ECサイトなどで商品を購入する場合、そのサイトを区分するためのID
    market_order_info

    モール型ECサイトのその他の情報

    モール型ECサイトまたは注文経路に関するその他の情報
    member_id

    会員ID
    member_email

    会員メールアドレス
    member_authentication

    会員認証の有無

    会員認証の設定。設定によって会員は3つのタイプに分けられる。

    T:承認
    B:特別管理会員
    J:14歳未満の会員
    billing_name

    決済者名

    入金者の名前。注文者または受取人の名前と違う場合がある。
    bank_code

    銀行コード

    bank_code
    bank_code_name

    入金銀行名
    payment_method

    決済方法コード

    注文者が利用した決済方法のコード

    cash : 銀行振込
    card : クレジットカード
    cell : キャリア決済
    tcash : 口座振込
    icash : バーチャル口座
    prepaid : 前払い
    credit : 預り金
    point : ポイント
    pointfy : 総合ポイント
    cvs : コンビニ
    cod : 後払い
    coupon : クーポン
    market_discount : モール型ECサイト割引
    etc : その他
    payment_method_name

    決済方法名

    注文者が利用した決済方法の名前
    payment_gateway_name

    決済代行サービス名

    注文者が利用した決済代行会社の名前
    sub_payment_method_name

    海外決済方法名
    sub_payment_method_code

    海外決済方法のコード

    sub_payment_method_code
    paid

    決済の有無

    決済が完了したかどうかの表示

    T：決済
    F：未決済
    M：一部決済
    order_date

    timezone

    注文日
    first_order

    初注文の有無

    初めての注文であるかどうかの表示

    T:初注文
    F:初注文ではない
    payment_date

    timezone

    決済日
    order_from_mobile

    モバイル区分

    注文をモバイルで行ったかどうかの区分

    T:モバイル注文
    F:モバイル注文ではない
    use_escrow

    エスクロー使用設定

    エスクローを使ったかどうかを設定

    T：エスクローを使用する
    F：エスクローを使用しない
    group_no_when_ordering

    注文時の会員ランク
    initial_order_amount

    最初の注文金額
    actual_order_amount

    現在の注文金額
    bank_account_no

    口座番号

    注文件に対するショップの口座番号
    bank_account_owner_name

    口座名義
    market_customer_id

    モール型ECサイトの注文者ID
    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:配送保留
    wished_delivery_date

    配送希望日
    wished_delivery_time

    配達希望時間
    wished_carrier_id

    希望配送会社コード
    wished_carrier_name

    希望配送会社名
    return_confirmed_date

    timezone

    返品承認日時
    total_supply_price

    仕入れ価格合計
    naver_point

    Naverポイント
    additional_order_info_list

    注文書の追加項目
    store_pickup

    店舗受取の設定

    T:店舗にて受取り
    F:店舗にて受取りではない
    easypay_name

    簡単決済の決済代行会社名
    loan_status

    与信状態

    OK : GOOD
    NG : NOT GOOD
    ER : ERROR
    subscription

    定期購入利用状況

    T : 利用中
    F : 非利用
    items

    品目別注文エンティティ


    Embedパラメーターを使って照会することができる。
    receivers

    受取人情報エンティティ


    Embedパラメーターを使って照会することができる。
    buyer

    注文者情報のリソース


    Embedパラメーターを使って照会することができる。
    shipping_fee_detail

    送料情報
    regional_surcharge_detail

    地域別送料情報
    return

    返品詳細リソース


    Embedパラメーターを使って照会することができる。
    cancellation

    キャンセル詳細リソース


    Embedパラメーターを使って照会することができる。
    exchange

    交換詳細リソース


    Embedパラメーターを使って照会することができる。
    multiple_addresses

    複数配送注文かどうか

    T : 複数配送注文
    F : 複数配送注文ではない
    exchange_rate

    決済通貨の為替レート情報
    first_payment_method

    最初に使用した決済方法のコード

    cash : 銀行振込
    card : クレジットカード
    cell : キャリア決済
    tcash : 口座振込
    icash : バーチャル口座
    prepaid : 前払い
    credit : 預り金
    point : ポイント
    pointfy : 総合ポイント
    cvs : コンビニ
    cod : 後払い
    etc : その他
    naverpay_payment_information

    Naver Pay決済代行サービス(PG)の決済情報

    P：決済代行サービス(PG)決済
    N：Naver Pay決済
    customer_group_no_when_ordering

    注文時の会員ランク

    注文当時の会員ランク

    詳細検索時のみ確認可能である。
    benefits

    特典リソース


    Embedパラメーターを使って照会することができる。

    詳細検索時のみ確認可能である。
    coupons

    クーポンリソース


    Embedパラメーターを使って照会することができる。

    詳細検索時のみ確認可能である。
    refunds

    返金詳細リソース


    Embedパラメーターを使って照会することができる。

    詳細検索時のみ確認可能である。
    process_status

    注文ステータス

    prepare：発送準備中
    prepareproduct：商品準備中
    hold：配送保留
    unhold：配送保留解除
    order_item_code

    品目別注文コード

    List all orders

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    items
    embed

    品目別注文エンティティ


    Embedパラメーターを使って照会することができる。

    receivers
    embed

    受取人情報エンティティ


    Embedパラメーターを使って照会することができる。

    buyer
    embed

    注文者情報のリソース


    Embedパラメーターを使って照会することができる。

    return
    embed

    返品詳細リソース


    Embedパラメーターを使って照会することができる。

    cancellation
    embed

    キャンセル詳細リソース


    Embedパラメーターを使って照会することができる。

    exchange
    embed

    交換詳細リソース


    Embedパラメーターを使って照会することができる。

    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    start_date
    Required

    Date
    timezone

    検索開始日

    検索を開始する基準日

    end_date
    Required

    Date
    timezone

    検索終了日

    検索を終了する基準日
    検索開始日と一緒に使用しなければならない。

    order_id

    Order ID

    注文番号

    ,(コンマ)で複数の件を検索することができる。

    order_status

    注文ステータス

    注文ステータス。注文ステータス別にそれぞれのコードがある。

    ,(コンマ)で複数の件を検索することができる。

    N00:入金前
    N10:商品準備中
    N20:発送準備中
    N21:出荷待ち
    N22:配送保留
    N30:配送中
    N40:配送完了
    C00:キャンセル申込み
    C10:キャンセル受付-管理者
    C34:キャンセル処理中-返金前
    C36:キャンセル処理中-返金保留
    C40:キャンセル完了
    C47:入金前キャンセル-購入者
    C48:入金前キャンセル-自動キャンセル
    C49:入金前キャンセル-管理者
    R00:返品申込み
    R10:返品受付
    R12:返品保留
    R30:返品処理中-回収前
    R34:返品処理中-返金前
    R36:返品処理中-返金保留
    R40:返品完了-返金完了
    E00:交換申込み
    E10:交換受付
    E12:交換保留
    E20:交換準備
    E30:交換処理中-回収前
    E32:交換処理中-入金前
    E34:交換処理中-返金前
    E36:交換処理中-返金保留
    E40:交換完了

    member_type

    会員/非会員

    会員の有無。会員と非会員、それぞれのコードがある。

    2:会員
    3:非会員

    group_no

    会員ランク番号

    buyer_name

    注文者名

    注文者の名前。入金者または受取人の名前と異なる場合がある。

    receiver_name

    受取人名

    受取人の名前。注文者または入金者の名前と違う場合がある。

    name_furigana

    受取人名(フリガナ)

    receiver_address

    受取人の住所

    受取人の住所。注文者または入金者の住所と違う場合がある。

    member_id

    会員ID

    会員ID

    member_email

    会員メールアドレス

    product_no

    商品番号

    商品番号

    product_code

    商品コード

    商品コード

    date_type

    検索日付のタイプ

    検索するための日付タイプ基準。基本値は注文日に設定されている。

    order_date：注文日
    pay_date：決済日
    shipbegin_date：配送開始日
    shipend_date：配送完了日
    cancel_date：注文キャンセル日
    place_date：発注日
    updatereceiver_date：受取人情報変更日
    cancel_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

    limit

    Min : [1]~Max : [500]

    検索結果の最大件数

    検索したい最大件数を指定することができる。
    例)10を入力すると10件まで表示

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Definition Copy
    Request example: Copy
    Response example:

    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:返品保留
    R30:返品処理中-回収前
    R34:返品処理中-返金前
    R36:返品処理中-返金保留
    R40:返品完了-返金完了
    E00:交換申込み
    E10:交換受付
    E12:交換保留
    E20:交換準備
    E30:交換処理中-回収前
    E32:交換処理中-入金前
    E34:交換処理中-返金前
    E36:交換処理中-返金保留
    E40:交換完了

    member_type

    会員/非会員

    会員の有無。会員と非会員、それぞれのコードがある。

    2:会員
    3:非会員

    group_no

    会員ランク番号

    buyer_name

    注文者名

    注文者の名前。入金者または受取人の名前と異なる場合がある。

    receiver_name

    受取人名

    受取人の名前。注文者または入金者の名前と違う場合がある。

    name_furigana

    受取人名(フリガナ)

    receiver_address

    受取人の住所

    受取人の住所。注文者または入金者の住所と違う場合がある。

    member_id

    会員ID

    会員ID

    member_email

    会員メールアドレス

    product_no

    商品番号

    商品番号

    product_code

    商品コード

    検索キーワードが商品コードに含まれている商品検索(大文字・小文字を区別する)

    date_type

    検索日付のタイプ

    検索するための日付タイプ基準。基本値は注文日に設定されている。

    order_date：注文日
    pay_date：決済日
    shipbegin_date：配送開始日
    shipend_date：配送完了日
    cancel_date：注文キャンセル日
    place_date：発注日
    updatereceiver_date：受取人情報変更日
    cancel_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

    Definition Copy
    Request example: Copy
    Response example:

    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パラメーターを使って照会することができる。

    Definition Copy
    Request example: Copy
    Response example:

    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

    品目別注文コード

    Definition Copy
    Request example: Copy
    Response example:

    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

    品目別注文コード

    Definition Copy
    Request example: Copy
    Response example:

    Orders autocalculation

    Endpoints 
    DELETE /api/v2/admin/orders/{order_id}/autocalculation

    Orders autocalculation properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1
    order_id

    注文番号

    Delete an orders autocalculation

    DELETE

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    Definition Copy
    Request example: Copy
    Response example:

    Orders buyer

    「Buyer」は、注文者の名前、連絡先、住所などを表示します。 購入者情報はサブリソースであるため、「Order」の以下で使用可能です。

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/buyer
PUT /api/v2/admin/orders/{order_id}/buyer

    Orders buyer properties

    Attribute Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号
    member_id

    会員ID
    member_group_no

    注文当時の注文者の会員ランク番号
    name

    注文者名
    names_furigana

    注文者名のふりがな
    email

    注文者のメールアドレス

    会員のメールアドレス
    phone

    注文者の固定電話番号
    cellphone

    注文者の携帯電話番号
    customer_notification

    お客様へのお知らせ

    お客様へのお知らせ
    updated_date

    timezone

    修正日
    user_id

    注文者を変更した人のID

    注文者情報を修正した人のID
    user_name

    注文者を変更した人の名前

    注文者情報を修正した人の名前
    order_id

    Order ID

    注文番号

    Get an orders buyer

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    Definition Copy
    Request example: Copy
    Response example:

    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

    お客様へのお知らせ

    お客様へのお知らせ

    Definition Copy
    Request example: Copy
    Response example:

    Orders buyer history

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/buyer/history

    Orders buyer history properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号
    name

    注文者名
    email

    Email

    注文者のメールアドレス
    phone

    注文者の固定電話番号
    cellphone

    注文者の携帯電話番号
    customer_notification

    お客様へのお知らせ
    updated_date

    timezone

    修正日
    user_id

    注文者を変更した人のID
    user_name

    注文者を変更した人の名前

    List all orders buyer history

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    Definition Copy
    Request example: Copy
    Response example:

    Orders cancellation

    Endpoints 
    POST /api/v2/admin/orders/{order_id}/cancellation

    Orders cancellation properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号
    order_id

    注文番号
    status

    注文ステータス

    canceled:キャンセル完了
    claim_code

    キャンセル番号
    items

    品目別注文コード

    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
    Definition Copy
    Request example: Copy
    Response example:

    Orders inflowgroups

    Endpoints 
    GET /api/v2/admin/orders/inflowgroups
POST /api/v2/admin/orders/inflowgroups
PUT /api/v2/admin/orders/inflowgroups/{inflow_group_id}
DELETE /api/v2/admin/orders/inflowgroups/{inflow_group_id}

    Orders inflowgroups properties

    Attribute Description
    inflow_group_id

    アクセスルートのサイトID
    inflow_group_name

    アクセスルートのサイト名

    List all orders inflowgroups

    GET

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40
    Definition Copy
    Request example: Copy
    Response example:

    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]

    アクセスルートのサイト名

    Definition Copy
    Request example: Copy
    Response example:

    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]

    アクセスルートのサイト名

    Definition Copy
    Request example: Copy
    Response example:

    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

    Definition Copy
    Request example: Copy
    Response example:

    Orders inflowgroups inflows

    Endpoints 
    GET /api/v2/admin/orders/inflowgroups/{group_id}/inflows
POST /api/v2/admin/orders/inflowgroups/{group_id}/inflows
PUT /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}
DELETE /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}

    Orders inflowgroups inflows properties

    Attribute Description
    inflow_id

    アクセスルートのサービスーID
    inflow_name

    アクセスルートのサービス名
    inflow_icon

    アクセスルートアイコン
    group_id

    アクセスルートのサイトID

    List all orders inflowgroups inflows

    GET

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    group_id
    Required

    Max Length : [40]

    アクセスルートのサイトID

    Definition Copy
    Request example: Copy
    Response example:

    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]

    アクセスルートアイコン

    Definition Copy
    Request example: Copy
    Response example:

    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]

    アクセスルートアイコン

    Definition Copy
    Request example: Copy
    Response example:

    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

    Definition Copy
    Request example: Copy
    Response example:

    Orders items

    品目別注文(Items)はショップの顧客が注文時に購入した品目の情報です。ショップの品目はショップで販売する商品の基本単位で、品目別注文では購入した商品の品目情報と共に購入時に選択したオプション、注文数量などの情報を追加で確認することができます。
    品目別注文番号は下位 Resourceで、注文(Order)の下位でしか使えません。

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/items
PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}

    Orders items properties

    Attribute Description
    shop_no

    ショップ番号
    item_no

    品目別注文ID

    品目別注文番号のID
    order_item_code

    品目別注文コード

    品目別注文番号のコード
    variant_code

    品目コード

    システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。
    product_no

    商品番号

    商品固有の一連番号。ショップ内で商品番号は重複しない。
    product_code

    商品コード

    システムにより商品に付与されたコード。ショップ内で商品コードは重複しない。
    custom_product_code

    Max Length : [40]

    独自商品コード
    custom_variant_code

    独自品目コード
    eng_product_name

    英語商品名

    商品の英語名。海外配送などに使用可能
    option_id

    商品オプションID

    商品オプションのID
    option_value

    オプション値

    注文した商品のオプション値
    option_value_default

    基本オプション値
    additional_option_value

    追加入力オプション値
    additional_option_values

    追加入力オプション一覧
    product_name

    商品名

    商品の名前。商品名は商品を区分する一番基礎的な情報で、検索情報になる。
    product_name_default

    基本商品名
    product_price

    商品販売価格

    商品の販売価格。マルチショップを運営する場合には販売価格をショッピング別通貨単位で換算して表示
    option_price

    オプション追加価格

    オプション別に追加価格がある場合、その追加価格
    additional_discount_price

    商品追加割引金額

    商品に対する追加割引金額
    coupon_discount_price

    商品別のクーポンによる割引金額
    app_item_discount_amount

    アプリによる商品割引金額
    actual_payment_amount

    実際の決済金額(品目別)
    quantity

    数量

    注文した商品の数量
    product_tax_type

    商品の税金区分

    A : 課税
    B : 免税
    C : 非課税
    tax_amount

    税率
    supplier_product_name

    供給会社の商品名

    供給会社の商品名
    supplier_transaction_type

    供給会社の取引タイプ

    供給会社の取引タイプ

    D:直接登録型
    P:手数料型
    supplier_id

    供給会社のID

    供給会社のID
    supplier_name

    供給会社名

    供給会社の名前
    tracking_no

    送り状番号
    shipping_code

    配送番号

    配送番号。品目別注文番号を配送準備中に処理すると、システムにより自動的に付与される番号
    claim_code

    キャンセル/交換/返品番号
    claim_reason_type

    キャンセル/交換/返品の申込理由のタイプ

    購入者のキャンセル/交換/返品の申込み理由の区分
    販売者の受付理由は、各キャンセル/交換/返品リソースの「claim_reason_type」で照会できます。
    claim_reason

    キャンセル/交換/返品の理由

    購入者のキャンセル/交換/返品の申込み理由の詳細
    購入者の申込み理由は、各キャンセル/交換/返品リソースの「claim_reason」で照会できます。
    refund_bank_name

    返金先の銀行名
    refund_bank_account_no

    返金の口座番号
    refund_bank_account_holder

    返金先の口座名義
    post_express_flag

    ゆうパック連動

    ゆうパック連動ステータス
    order_status

    注文ステータス

    注文ステータス。注文ステータス別にそれぞれのコードがある。
    request_undone

    取消ステータス

    Cancellation：キャンセル取消し
    Exchange：交換取消し
    Return：返品取消し
    order_status_additional_info

    注文ステータスの追加情報

    注文ステータスの追加情報
    claim_quantity

    キャンセル/交換/返品の申込数量
    status_code

    現在の処理ステータスコード

    現在の処理ステータスのコード

    N1:正常
    N2:交換商品
    C1:入金前のキャンセル
    C2:配送前のキャンセル
    C3:返品
    E1:交換
    status_text

    現在の処理ステータス

    現在の処理ステータスに関する説明
    open_market_status

    モール型ECサイト連動ステータス値
    bundled_shipping_type

    まとめて配送のタイプ

    配送対象の注文に対してまとめて配送するタイプ

    N:単一注文の一般配送(Normal)
    C :複合注文のまとめて配送(Combination)
    shipping_company_id

    配送会社ID

    配送会社のID
    shipping_company_name

    配送会社名

    配送会社の名前
    shipping_company_code

    配送会社コード

    shipping_company_code
    product_bundle

    セット商品の有無

    T:セット商品
    F:セット商品ではない
    product_bundle_no

    セット商品番号

    分離型セット商品の番号
    一体型セット商品の番号はproduct_noに表示される。
    product_bundle_name

    セット商品名

    分離型セット商品の名前
    一体型セット商品の名前はproduct_nameに表示される。
    product_bundle_name_default

    セット商品名(基本)

    分離型セット商品の名前
    一体型セット商品の名前はproduct_nameに表示される。
    product_bundle_type

    セット商品のタイプ

    セット商品のタイプ

    C:一体型
    S:分離型
    was_product_bundle

    セット品目別注文の分離設定

    セット商品の品目注文番号を分離するかどうかを設定

    T:分離履歴ある
    original_bundle_item_no

    分離したセット商品の既存の品目別注文番号

    分離されたセット商品の既存の品目別注文番号
    naver_pay_order_id

    Naver Pay商品別注文番号

    Naver Pay注文の商品別注文番号
    naver_pay_claim_status

    Naver Payクレームタイプ

    Naver Pay注文のクレームタイプ

    PAYMENT_WAITING:入金待ち
    PAYED:決済完了
    DELIVERING:配送中
    DELIVERED:配送完了
    PURCHASE_DECIDED:購入確定
    EXCHANGED:交換
    CANCELED:キャンセル
    RETURNED:返品
    CANCELED_BY_NOPAYMENT:未入金キャンセル
    NOT_YET:発注未確認
    OK:発注確認
    CANCEL:発注確認の解除
    CANCEL_REQUEST:キャンセル申込み
    CANCELING:キャンセル処理中
    CANCEL_DONE:キャンセル処理完了
    CANCEL_REJECT:キャンセル取消し
    RETURN_REQUEST:返品申込み
    COLLECTING:回収処理中
    COLLECT_DONE:回収完了
    RETURN_DONE:返品完了
    RETURN_REJECT:返品取消し
    EXCHANGE_REQUEST:交換申込み
    COLLECTING:回収処理中
    COLLECT_DONE:回収完了
    EXCHANGE_REDELIVERING:交換後に再配送中
    EXCHANGE_DONE:交換完了
    EXCHANGE_REJECT:交換拒否
    PURCHASE_DECISION_HOLDBACK:購入確定保留
    PURCHASE_DECISION_HOLDBACK_REDELIVERING:購入確定保留後に再配送中
    PURCHASE_DECISION_REQUEST:購入確定要請
    PURCHASE_DECISION_HOLDBACK_RELEASE:購入確定保留の解除
    ADMIN_CANCELING:購入確定後キャンセル中
    ADMIN_CANCEL_DONE:購入確定後キャンセル完了
    individual_shipping_fee

    個別送料

    個別送料
    shipping_fee_type

    送料タイプ

    (個別送料を利用する場合)商品の送料タイプ

    T:無料
    F:着払い
    D:等差(金額)
    M:条件(金額)
    I:固定
    N:比例(数量)
    W:等差(重さ)
    C:等差(数量)
    X:基本配送
    shipping_fee_type_text

    送料タイプ

    送料タイプの説明
    shipping_payment_option

    前払い/着払いの区分

    C：着払い
    P：前払い
    F：無料
    payment_info_id

    決済情報ID
    original_item_no

    既存の品目別注文ID
    store_pickup

    店舗受取の設定

    実店舗で受け取る商品かどうかを設定

    T:店舗にて受取り
    F:店舗にて受取りではない
    ordered_date

    timezone

    注文日
    shipped_date

    timezone

    配送開始日

    配送開始日
    delivered_date

    timezone

    配送完了日

    配送完了日
    cancel_date

    timezone

    注文キャンセル日

    注文のキャンセル日
    return_confirmed_date

    timezone

    返品承認日時
    return_request_date

    timezone

    返品申込日

    返品申込日
    return_collected_date

    timezone

    返品集荷日
    cancel_request_date

    timezone

    キャンセル申込日

    注文の取消申込日
    refund_date

    timezone

    返金完了日

    返金完了日
    exchange_request_date

    timezone

    交換申込日

    交換申込日
    exchange_date

    timezone

    交換完了日

    交換完了日
    product_material

    商品素材

    商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。
    product_material_eng

    英語商品素材

    商品素材の英語説明
    cloth_fabric

    生地

    商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。
    product_weight

    商品重量

    商品の全体重量(kg)。配送のために商品の重量だけでなく、ボックスと包装の重量も含めた重量を記載する必要がある。
    volume_size

    商品容積

    商品の体積
    volume_size_weight

    商品の容積・重量

    商品の体積と重量
    clearance_category

    海外通関用商品区分
    clearance_category_info

    海外通関用商品情報
    clearance_category_code

    海外通関コード

    clearance_category_code
    hs_code

    HSコード

    通関のためのHSコード
    one_plus_n_event

    1+Nイベントの有無

    1個購入時にN個を提供するイベントの設定
    origin_place

    原産国情報

    商品の原産国
    origin_place_no

    原産国コード
    made_in_code

    国名(原産国)コード
    gift

    ノベルティであるかどうか

    商品がプレミアムかどうかを設定

    T：ノベルティ
    F：ノベルティではない
    item_granting_gift

    ノベルティ贈呈条件となる品目の一覧
    subscription

    定期購入利用状況

    T : 利用中
    F : 非利用
    product_bundle_list

    セット商品一覧
    market_cancel_request

    ECサイトキャンセル申込み有無

    T : キャンセル申込みしたECサイト注文
    F : キャンセル申込みしていないECサイト注文
    market_cancel_request_quantity

    モール型ECサイトからのキャンセル申込数量
    market_fail_reason

    モール型ECサイトでの処理失敗の原因
    market_fail_reason_guide

    モール型ECサイトでの処理失敗の原因に対する説明
    market_custom_variant_code

    モール型ECサイト独自品目コード
    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

    注文番号

    Definition Copy
    Request example: Copy
    Response example:

    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

    キャンセル/交換/返品の申込数量

    Definition Copy
    Request example: Copy
    Response example:

    Orders memos

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/memos
POST /api/v2/admin/orders/{order_id}/memos
PUT /api/v2/admin/orders/{order_id}/memos/{memo_no}
DELETE /api/v2/admin/orders/{order_id}/memos/{memo_no}

    Orders memos properties

    Attribute Description
    shop_no

    ショップ番号
    memo_no

    メモ番号
    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

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    Definition Copy
    Request example: Copy
    Response example:

    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

    商品リスト

    Definition Copy
    Request example: Copy
    Response example:

    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

    商品リスト

    Definition Copy
    Request example: Copy
    Response example:

    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

    メモ番号

    Definition Copy
    Request example: Copy
    Response example:

    Orders payments

    Endpoints 
    PUT /api/v2/admin/orders/{order_id}/payments

    Orders payments properties

    Attribute Description
    shop_no

    ショップ番号
    order_id

    注文番号
    change_payment_amount

    決済金額変更の有無

    T:使用する
    F:使用しない
    change_payment_method

    決済方法変更の有無

    T:使用する
    F:使用しない
    payment_method

    決済方法
    payment_gateway_failure_message

    決済代行会社の決済キャンセルエラーメッセージ
    admin_additional_amount

    運営者入力金額
    commission

    決済手数料
    initial_estimated_payment_amount

    初期決済予定金額
    change_payment_amount_reason

    決済金額変更の理由

    Update an orders payment

    PUT

    基本スペック

    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]

    決済金額変更の理由

    Definition Copy
    Request example: Copy
    Response example:

    Orders paymenttimeline

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/paymenttimeline
GET /api/v2/admin/orders/{order_id}/paymenttimeline/{payment_no}

    Orders paymenttimeline properties

    Attribute Description
    shop_no

    ショップ番号
    payment_no

    決済番号
    payment_settle_type

    決済タイプ

    O：最初決済
    R：追加決済
    P：返金
    order_amount

    注文金額
    additional_payment_amount

    併用決済金額
    paid_amount

    決済金額
    payment_methods

    決済方法
    payment_datetime

    timezone

    決済日
    created_datetime

    timezone

    入力日
    payment_method_detail

    決済方法別の決済金額

    payment_method_detail code

    詳細検索時のみ確認可能である。
    order_amount_detail

    注文金額の詳細

    order_amount_detail code

    詳細検索時のみ確認可能である。

    List all orders paymenttimeline

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    Definition Copy
    Request example: Copy
    Response example:

    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]

    決済番号

    Definition Copy
    Request example: Copy
    Response example:

    Orders receivers

    受取人情報(Receivers)は注文した商品を受け取る人の名前、連絡先、住所情報です。
    受取人情報は下位Resourceで、注文(Order)の下位でしか使えません。

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/receivers
PUT /api/v2/admin/orders/{order_id}/receivers
PUT /api/v2/admin/orders/{order_id}/receivers/{shipping_code}

    Orders receivers properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1
    name

    受取人名
    name_furigana

    受取人名(フリガナ)
    phone

    電話番号
    cellphone

    受取人の電話番号(携帯)
    virtual_phone_no

    受取人の安心番号
    zipcode

    郵便番号
    address1

    基本住所
    address2

    詳細住所
    address_state

    都道府県
    address_city

    市区町村
    address_street

    道路名
    address_full

    アドレス
    name_en

    受取人名(ローマ字)
    city_en

    受取人の都市(ローマ字)
    state_en

    受取人の住所(ローマ字)
    street_en

    受取人の住所 (ローマ字)
    country_code

    国コード
    country_name

    国名
    country_name_en

    国名(ローマ字)
    shipping_message

    配送メッセージ
    clearance_information_type

    通関情報タイプ

    I：身分証明書(ID)番号
    P：パスポート番号
    C：個人通関固有符号
    clearance_information

    通関情報
    wished_delivery_date

    配送希望日
    wished_delivery_time

    配達希望時間
    shipping_code

    配送番号
    change_default_shipping_address

    基本お届け先の変更有無

    T：変更する
    F：変更しない

    List all orders receivers

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    マルチショップを区分するために使うショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    shipping_code

    配送番号

    ,(コンマ)で複数の件を検索することができる。

    Definition Copy
    Request example: Copy
    Response example:

    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

    受取人の安心番号

    Definition Copy
    Request example: Copy
    Response example:

    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

    受取人の安心番号

    Definition Copy
    Request example: Copy
    Response example:

    Orders receivers history

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/receivers/history

    Orders receivers history properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号
    name

    受取人名
    phone

    電話番号
    cellphone

    受取人の電話番号(携帯)
    zipcode

    郵便番号
    address1

    基本住所
    address2

    詳細住所
    address_state

    都道府県
    address_city

    市区町村
    address_street

    道路名
    address_full

    アドレス
    name_en

    受取人名(ローマ字)
    city_en

    受取人の都市(ローマ字)
    state_en

    受取人の住所(ローマ字)
    street_en

    受取人の住所 (ローマ字)
    country_code

    国コード
    country_name

    国名
    country_name_en

    国名(ローマ字)
    shipping_message

    配送メッセージ
    updated_date

    timezone

    修正日
    user_id

    注文者を変更した人のID
    user_name

    注文者を変更した人の名前
    shipping_code

    配送番号

    List all orders receivers history

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    Definition Copy
    Request example: Copy
    Response example:

    Orders return

    Endpoints 
    POST /api/v2/admin/orders/{order_id}/return

    Orders return properties

    Attribute Description
    shop_no

    ショップ番号
    order_id

    注文番号
    status

    注文ステータス

    canceled:キャンセル完了
    claim_code

    キャンセル番号
    items

    品目別注文コード

    Create an orders return

    POST

    基本スペック

    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
    Definition Copy
    Request example: Copy
    Response example:

    Orders shipments

    「Shipments」は、注文の配送処理をするために必要な配送情報を意味します。 注文の配送情報には送り状番号や配送会社の情報、配送ステータスなどがあります。

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/shipments
POST /api/v2/admin/orders/{order_id}/shipments
PUT /api/v2/admin/orders/{order_id}/shipments/{shipping_code}
DELETE /api/v2/admin/orders/{order_id}/shipments/{shipping_code}

    Orders shipments properties

    Attribute Description
    shop_no

    ショップ番号

    DEFAULT 1
    shipping_code

    配送番号
    order_id

    注文番号
    tracking_no

    送り状番号
    tracking_no_updated_date

    timezone

    送り状情報の入力日
    shipping_company_code

    配送会社コード

    shipping_company_code
    items

    品目別注文一覧
    status

    注文ステータス

    standby : 配送待ち
    shipping : 配送中
    shipped : 配送完了
    order_item_code

    品目別注文コード
    status_additional_info

    注文ステータスの追加情報

    List all orders shipments

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    Order ID

    注文番号

    Definition Copy
    Request example: Copy
    Response example:

    Register shipments information

    POST

    注文に配送情報を登録して注文を出荷待ち状態にしたり、配送中処理をすることができます。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    tracking_no
    Required

    Max Length : [30]

    送り状番号

    shipping_company_code
    Required

    配送会社コード

    shipping_company_code

    order_item_code

    品目別注文コード

    status
    Required

    注文ステータス

    standby : 配送待ち
    shipping : 配送中

    shipping_code

    配送番号

    Definition Copy
    Request example: Copy
    Response example:

    Update orders shipment information

    PUT

    注文の配送情報(配送ステータスなど)を変更することができます。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    shipping_code
    Required

    配送番号

    status

    注文ステータス

    standby : 配送待ち
    shipping : 配送中
    shipped : 配送完了

    status_additional_info

    Max Length : [30]

    注文ステータスの追加情報

    tracking_no

    Max Length : [30]

    送り状番号

    shipping_company_code

    配送会社コード

    Definition Copy
    Request example: Copy
    Response example:

    Delete an orders shipment

    DELETE

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    shipping_code
    Required

    配送番号

    Definition Copy
    Request example: Copy
    Response example:

    Orders shippingfeecancellation

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/shippingfeecancellation
POST /api/v2/admin/orders/{order_id}/shippingfeecancellation

    Orders shippingfeecancellation properties

    Attribute Description
    shop_no

    ショップ番号
    order_id

    注文番号
    default_shipping_fee

    基本送料
    supplier_shipping_fee

    ショップ基本送料
    individual_shipping_fee

    個別送料
    international_shipping_fee

    해외배송비
    international_shipping_insurance_fee

    海外配送保険料
    additional_shipping_fee

    追加送料
    additional_handling_fee

    海外配送付加金額
    regional_surcharge_amount

    地域別送料
    claim_code

    キャンセル番号
    claim_reason_type

    区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他
    claim_reason

    理由
    refund_method

    返金方式
    shipping_discount_amount

    送料割引のキャンセル金額
    coupon_discount_amount

    クーポン割引の
    キャンセル金額
    refund_amount

    返金額
    point_used

    使用済みポイントの返還額
    credit_used

    使用済み預り金の返還額
    mixed_refund_amount

    複合返金金額
    mixed_refund_methods

    複合 返金 方式
    status

    注文ステータス

    LIBSPECDATACANCELING.PROCESSING

    List all orders shippingfeecancellation

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    Definition Copy
    Request example: Copy
    Response example:

    Create an orders shippingfeecancellation

    POST

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    reason

    Max Length : [2000]

    キャンセル理由

    claim_reason_type

    キャンセル理由の区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他

    recover_coupon

    クーポン復元

    T : 復元する
    F : 復元しない

    DEFAULT F

    refund_method_code

    返金方式

    T : 現金
    F : クレジットカード
    M : ポイント
    G : 口座振込
    C : キャリア決済
    D : 預り金
    Z : 後払い
    O : 前払金
    I : コンビニ
    V : その他

    combined_refund_method

    複合 返金 方式

    T : 現金
    M : ポイント
    D : 預り金

    refund_bank_code

    返金先の銀行コード

    refund_bank_name

    Max Length : [250]

    返金先の銀行名

    refund_bank_account_no

    Max Length : [50]

    返金の口座番号

    refund_bank_account_holder

    Max Length : [15]

    返金先の口座名義

    payment_gateway_cancel

    決済代行会社の注文キャンセルを申込むかどうか

    T : キャンセルする
    F : キャンセルしない

    DEFAULT F

    Definition Copy
    Request example: Copy
    Response example:

    Orders shortagecancellation

    Endpoints 
    POST /api/v2/admin/orders/{order_id}/shortagecancellation

    Orders shortagecancellation properties

    Attribute Description
    shop_no

    Min : [1]

    ショップ番号
    order_id

    注文番号
    status

    注文ステータス

    canceled:キャンセル完了
    claim_code

    キャンセル番号
    items

    品目別注文コード

    Create an orders shortagecancellation

    POST

    本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 1

    要求スペック

    Parameter Description
    shop_no

    Min : [1]

    ショップ番号

    order_id
    Required

    注文番号

    payment_gateway_cancel

    決済代行会社の注文キャンセルを申込むかどうか

    T : キャンセルする
    F : キャンセルしない

    DEFAULT F

    keep_auto_calculation

    LIBSPECDATAWHETHER.PRESERVE.FLAG

    LIBSPECDATAPRESERVED.REMOVED

    DEFAULT F

    collect_gift

    ノベルティを自動回収するかどうかの有無

    T：使用する
    F：使用しない

    DEFAULT F

    status
    Required

    注文ステータス

    canceled:キャンセル完了

    recover_inventory

    在庫の回復

    T : 復元する
    F : 復元しない

    DEFAULT F

    recover_coupon

    クーポン復元

    T : 復元する
    F : 復元しない

    DEFAULT F

    add_memo_too

    運営者メモに追加する

    T：使用する
    F：使用しない

    DEFAULT F

    reason

    Max Length : [2000]

    キャンセル理由

    claim_reason_type

    キャンセル理由の区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他

    naverpay_cancel_reason_type

    Naver Payで注文した件のキャンセル理由の区分

    Cafe24管理画面(ベトナム, フィリピン) では使用できません。

    51 : 心変わり
    52 : カラーまたはサイズ変更
    53 : 誤注文
    54 : サービス・商品への不満
    55 : 配送遅延
    56 : 在庫切れ
    60 : 商品情報との不一致

    refund_method_code

    返金方式

    T : 現金
    F : クレジットカード
    M : ポイント
    G : 口座振込
    C : キャリア決済
    D : 預り金
    Z : 後払い
    O : 前払金
    I : コンビニ
    V : その他

    combined_refund_method

    複合 返金 方式

    T : 現金
    M : ポイント
    D : 預り金

    refund_bank_code

    返金先の銀行コード

    refund_bank_name

    Max Length : [250]

    返金先の銀行名

    refund_bank_account_no

    Max Length : [50]

    返金の口座番号

    refund_bank_account_holder

    Max Length : [15]

    返金先の口座名義

    items

    品目別注文コード

    order_item_code
    品目別注文コード
    Required

    quantity
    数量
    Required
    Definition Copy
    Request example: Copy
    Response example:

    Payments

    Endpoints 
    PUT /api/v2/admin/payments

    Payments properties

    Attribute Description
    shop_no

    ショップ番号
    order_id

    注文番号
    status

    注文ステータス

    paid：入金確認
    unpaid：入金前
    canceled：決済キャンセル

    Update payments

    PUT

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 10

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    status
    Required

    注文ステータス

    paid：入金確認
    unpaid：入金前
    canceled：決済キャンセル

    recover_inventory

    在庫の回復

    T : 復元する
    F : 復元しない

    Definition Copy
    Request example: Copy
    Response example:

    Refunds

    Endpoints 
    GET /api/v2/admin/refunds
GET /api/v2/admin/refunds/{refund_code}

    Refunds properties

    Attribute Description
    shop_no

    ショップ番号
    member_email

    会員メールアドレス
    buyer_email

    注文者のメールアドレス
    order_date

    timezone

    注文日
    accepted_refund_date

    timezone

    返金受付日
    refund_date

    timezone

    返金完了日
    order_id

    注文番号
    refund_code

    返金番号
    order_item_code

    品目別注文コード一覧
    quantity

    数量
    actual_refund_amount

    実際の返金額
    used_points

    使用済みポイントの返還額
    used_credits

    使用済み預り金の返還額
    used_transferable_points

    使用済みの総合ポイント返金額
    currency

    通貨単位
    payment_methods

    決済方法

    cash : 銀行振込
    card : クレジットカード
    cell : キャリア決済
    tcash : 口座振込
    icash : バーチャル口座
    prepaid : 前払い
    credit : 預り金
    point : ポイント
    pointfy : 総合ポイント
    cvs : コンビニ
    cod : 後払い
    coupon : クーポン
    market_discount : モール型ECサイト割引
    etc : その他
    refund_payment_methods

    返金方法

    cash : 銀行振込
    card : クレジットカード
    cell : キャリア決済
    tcash : 口座振込
    prepaid : 前払い
    credit : 預り金
    point : ポイント
    pointfy : 総合ポイント
    cvs : コンビニ
    cod : 後払い
    etc : その他
    payment_gateway_cancel_status

    決済代行会社でのキャンセル状態

    F：キャンセル前
    M：一部キャンセル完了
    T：すべてキャンセル完了
    payment_gateway_cancel_date

    timezone

    決済代行会社でのキャンセル日付
    status

    返金ステータス

    T：返金前
    F：返金完了
    refund_point

    ポイント返還額

    詳細検索時のみ確認可能である。
    refund_credit

    預り金の返還額

    詳細検索時のみ確認可能である。
    refund_naver_point

    Naverポイント返還額

    詳細検索時のみ確認可能である。
    refund_naver_cash

    Naverキャッシュ返還額

    詳細検索時のみ確認可能である。
    refund_amount

    返金額

    詳細検索時のみ確認可能である。
    product_price

    商品販売価格

    詳細検索時のみ確認可能である。
    shipping_fee

    送料

    詳細検索時のみ確認可能である。
    shipping_fee_discount_amount

    送料割引

    詳細検索時のみ確認可能である。
    cod_fees

    後払い手数料

    詳細検索時のみ確認可能である。
    foreign_shipping_additional_fee

    海外配送付加金額

    詳細検索時のみ確認可能である。
    product_discount_amount

    商品別の割引金額

    詳細検索時のみ確認可能である。
    member_group_discount_amount

    会員ランク割引金額

    詳細検索時のみ確認可能である。
    app_item_discount_amount

    アプリによる商品割引金額

    詳細検索時のみ確認可能である。
    app_discount_amount

    アプリによる注文割引金額

    詳細検索時のみ確認可能である。
    coupon_discount_amount

    クーポン割引金額

    詳細検索時のみ確認可能である。
    product_bundle_discount_amount

    セット商品割引金額

    詳細検索時のみ確認可能である。
    points_spent_amount

    ポイント使用金額

    詳細検索時のみ確認可能である。
    credits_spent_amount

    預り金の使用金額

    詳細検索時のみ確認可能である。
    transferable_points_spent_amount

    総合ポイント使用金額

    詳細検索時のみ確認可能である。
    naver_point

    Naverポイント

    詳細検索時のみ確認可能である。
    naver_cash

    Naverキャッシュ

    詳細検索時のみ確認可能である。
    additional_product_amount

    商品追加決済金額

    詳細検索時のみ確認可能である。
    manually_input_amount

    運営者入力金額

    詳細検索時のみ確認可能である。
    changed_refund_amount

    変更された返金額

    詳細検索時のみ確認可能である。
    refund_bank_name

    返金先の銀行名

    詳細検索時のみ確認可能である。
    refund_bank_account_no

    返金の口座番号

    詳細検索時のみ確認可能である。
    refund_bank_account_holder

    返金先の口座名義

    詳細検索時のみ確認可能である。
    refund_manager

    返金担当者

    詳細検索時のみ確認可能である。
    refund_reason

    返金理由

    詳細検索時のみ確認可能である。
    refund_methods

    返金方法

    詳細検索時のみ確認可能である。
    send_sms

    返金処理後SMS送信の設定

    詳細検索時のみ確認可能である。

    T : 送信する
    F : 送信しない
    send_mail

    返金処理後メール送信の設定

    詳細検索時のみ確認可能である。

    T : 送信する
    F : 送信しない
    items

    品目別注文エンティティ


    Embedパラメーターを使って照会することができる。

    詳細検索時のみ確認可能である。

    List all refunds

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    start_date
    Required

    Date
    timezone

    検索開始日

    end_date
    Required

    Date
    timezone

    検索終了日

    date_type

    検索日付のタイプ

    accepted_refund_date : 返金受付日
    refund_date : 返金完了日

    DEFAULT refund_date

    member_email

    会員メールアドレス

    buyer_email

    注文者のメールアドレス

    limit

    Min : [1]~Max : [500]

    検索結果の最大件数

    DEFAULT 10

    offset

    Max : [8000]

    検索結果の開始位置

    Definition Copy
    Request example: Copy
    Response example:

    Get a refund

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    refund_code
    Required

    返金番号

    items
    embed

    品目別注文エンティティ


    Embedパラメーターを使って照会することができる。

    Definition Copy
    Request example: Copy
    Response example:

    Return

    「Return」は、配送後に顧客が注文をキャンセルことを意味します。返品リソースは返品情報を照会したり、または返品を処理できます。

    返品リソースは返品の受付以降から完了までのステータスを照会できます。

    Endpoints 
    GET /api/v2/admin/return/{claim_code}
POST /api/v2/admin/return

    Return properties

    Attribute Description
    shop_no

    ショップ番号
    order_id

    注文番号
    claim_code

    キャンセル番号
    claim_reason_type

    区分

    販売者の返品受付理由の区分
    購入者の返品申込み理由は、[items(品目・注文) > claim_reason_type]で照会できます。

    詳細検索時のみ確認可能である。

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他
    claim_reason

    理由

    販売者の返品受付理由の詳細
    購入者の返品申込み理由の詳細は、[items(品目・注文) > claim_reason]で照会できます。

    詳細検索時のみ確認可能である。
    claim_due_date

    返品処理予定日

    詳細検索時のみ確認可能である。
    return_address

    返品先の住所

    詳細検索時のみ確認可能である。
    pickup

    受取人の住所

    詳細検索時のみ確認可能である。
    return_invoice_no

    返品用送り状の送り状番号

    詳細検索時のみ確認可能である。
    return_shipping_company_name

    返品に使用する配送会社名

    詳細検索時のみ確認可能である。
    pickup_request_state

    回収申込みのステータス

    詳細検索時のみ確認可能である。

    E：回収申込み前
    W：回収受付前
    S：回収受付待ち(送り状発行前)
    F：回収受付失敗
    T：回収受付完了(送り状発行完了)
    N：未集荷
    refund_method

    返金方式

    詳細検索時のみ確認可能である。
    refund_reason

    備考

    詳細検索時のみ確認可能である。
    order_price_amount

    商品購入金額

    詳細検索時のみ確認可能である。
    refund_amount

    返金額

    詳細検索時のみ確認可能である。
    shipping_fee

    送料

    詳細検索時のみ確認可能である。
    return_ship_type

    返品送料の適用区分

    詳細検索時のみ確認可能である。
    return_shipping_fee

    返品送料

    詳細検索時のみ確認可能である。
    return_shipping_fee_detail

    返品送料詳細

    詳細検索時のみ確認可能である。
    return_regional_shipping_fee

    地域別返品送料

    詳細検索時のみ確認可能である。
    return_regional_surcharge_detail

    地域別返品送料の詳細

    詳細検索時のみ確認可能である。
    defer_commission

    後払い手数料

    詳細検索時のみ確認可能である。
    partner_discount_amount

    提携割引のキャンセル金額

    詳細検索時のみ確認可能である。
    add_discount_amount

    商品別追加割引の
    キャンセル金額

    詳細検索時のみ確認可能である。
    member_grade_discount_amount

    会員ランク割引の
    キャンセル金額

    詳細検索時のみ確認可能である。
    shipping_discount_amount

    送料割引のキャンセル金額

    詳細検索時のみ確認可能である。
    coupon_discount_amount

    クーポン割引の
    キャンセル金額

    詳細検索時のみ確認可能である。
    point_used

    使用済みポイントの返還額

    詳細検索時のみ確認可能である。
    credit_used

    使用済み預り金の返還額

    詳細検索時のみ確認可能である。
    items

    品目別注文コード
    status

    注文ステータス

    canceled:キャンセル完了

    Get a return

    GET

    基本スペック

    Property Description
    SCOPE 注文の閲覧権限 (mall.read_order)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    claim_code
    Required

    返品番号

    Definition Copy
    Request example: Copy
    Response example:

    Create return

    POST

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 100

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    status
    Required

    注文ステータス

    returned : 返品完了

    recover_inventory

    在庫の回復

    T : 復元する
    F : 復元しない

    DEFAULT F

    recover_coupon

    クーポン復元

    T : 復元する
    F : 復元しない

    DEFAULT F

    add_memo_too

    運営者メモに追加する

    T：使用する
    F：使用しない

    DEFAULT F

    reason

    Max Length : [2000]

    返品理由

    claim_reason_type

    返品理由区分

    A : お客様都合
    B : 配送遅延
    J : 配送ミス
    C : 配送不可地域
    L : 輸出/通関不可能
    D : 梱包不良
    E : 商品への不満
    F : 商品情報と異なる
    K : 不良品
    G : サービスへの不満
    H : 在庫切れ
    I : その他

    naverpay_return_reason_type

    LIBSPECDATAPAY.ORDER.RETURN

    Cafe24管理画面(ベトナム, フィリピン, 日本) では使用できません。

    51：心変わり
    52：カラーまたはサイズ変更
    53：誤注文
    54：サービス・商品への不満
    55：配送遅延
    56：在庫切れ
    57：配送漏れ
    58：未配送
    59：商品破損
    60：商品情報との不一致
    61：配送ミス
    62：カラーなどのオプションが間違った商品が届く誤配送

    refund_method_code

    返金方式

    T : 現金
    F : クレジットカード
    M : ポイント
    G : 口座振込
    C : キャリア決済
    D : 預り金
    Z : 後払い
    O : 前払金
    I : コンビニ
    V : その他

    combined_refund_method

    複合 返金 方式

    T : 現金
    M : ポイント
    D : 預り金

    refund_bank_code

    返金先の銀行コード

    refund_bank_name

    Max Length : [250]

    返金先の銀行名

    refund_bank_account_no

    Max Length : [50]

    返金の口座番号

    refund_bank_account_holder

    Max Length : [15]

    返金先の口座名義

    items

    品目別注文コード

    order_item_code
    品目別注文コード
    Required

    quantity
    数量
    Required
    Definition Copy
    Request example: Copy
    Response example:

    Shipments

    Endpoints 
    POST /api/v2/admin/shipments
PUT /api/v2/admin/shipments

    Shipments properties

    Attribute Description
    shop_no

    ショップ番号
    order_id

    注文番号
    tracking_no

    送り状番号
    shipping_code

    配送番号
    shipping_company_code

    配送会社コード

    shipping_company_code
    status

    注文ステータス

    standby : 配送待ち
    shipping : 配送中
    shipped : 配送完了
    order_item_code

    品目別注文コード
    status_additional_info

    注文ステータスの追加情報

    Create shipments

    POST

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 100

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    order_id
    Required

    注文番号

    tracking_no
    Required

    Max Length : [30]

    送り状番号

    shipping_company_code
    Required

    配送会社コード

    shipping_company_code

    status
    Required

    注文ステータス

    standby : 配送待ち
    shipping : 配送中

    order_item_code

    品目別注文コード

    shipping_code

    配送番号

    Definition Copy
    Request example: Copy
    Response example:

    Update shipments

    PUT

    注文の配送情報(配送ステータスなど)を変更することができます。

    基本スペック

    Property Description
    SCOPE 注文の投稿権限 (mall.write_order)
    呼び出し件数制限 40
    1回当たり申込件数の制限 100

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    status

    注文ステータス

    standby : 配送待ち
    shipping : 配送中
    shipped : 配送完了

    status_additional_info

    Max Length : [30]

    注文ステータスの追加情報

    order_id
    Required

    注文番号

    shipping_code
    Required

    配送番号

    tracking_no

    Max Length : [30]

    送り状番号

    shipping_company_code

    配送会社コード

    Definition Copy
    Request example: Copy
    Response example:

    Community

    Boards

    Endpoints 
    GET /api/v2/admin/boards

    Boards properties

    Attribute Description
    shop_no

    ショップ番号
    board_no

    掲示板番号
    board_type

    掲示板のカテゴリ

    1：運営
    2：一般
    3：資料室
    4：その他
    5：商品
    6：アルバム
    7：My質問
    11：ひとこと投稿
    board_name

    掲示板タイトル
    use_additional_board

    掲示板の追加有無

    T：追加掲示板
    F：基本掲示板
    use_board

    掲示板の使用有無

    T:使用する
    F:使用しない
    use_display

    表示有無

    T:表示する
    F:表示しない
    display_order

    並べ替え順序

    List all boards

    GET

    基本スペック

    Property Description
    SCOPE 掲示板の閲覧権限 (mall.read_community)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    Definition Copy
    Request example: Copy
    Response example:

    Boards articles

    「Boards articles」は掲示板の投稿についての情報を意味します。

    Endpoints 
    GET /api/v2/admin/boards/{board_no}/articles
POST /api/v2/admin/boards/{board_no}/articles
PUT /api/v2/admin/boards/{board_no}/articles/{article_no}
DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}

    Boards articles properties

    Attribute Description
    shop_no

    ショップ番号
    article_no

    投稿番号
    parent_article_no

    親投稿の番号
    board_no
    Required

    掲示板番号
    product_no

    商品番号
    category_no

    カテゴリ番号
    board_category_no

    掲示板カテゴリ番号
    reply_sequence

    回答投稿の順序
    reply_depth

    回答順序
    created_date

    Date
    timezone

    生成日
    writer

    作成者名
    writer_email

    Email

    作成者Eメール
    member_id

    会員ID
    title

    タイトル
    content

    内容
    client_ip

    IP

    作成者IP
    nick_name

    ニックネーム
    rating

    Min : [1]~Max : [5]

    評価
    sales_channel

    Max Length : [20]

    媒体社
    reply_mail

    My質問への回答メールの有無

    Y：使用する
    N:使用しない
    display

    掲示設定

    T : 掲示する
    F : 掲示しない
    secret

    非公開の有無

    T:使用する
    F:使用しない
    notice

    告知の有無

    T:使用する
    F:使用しない
    fixed

    固定投稿の有無

    T:使用する
    F:使用しない
    deleted

    削除区分

    T : 削除
    F : 未削除
    input_channel

    投稿作成のルート

    P:PC
    M：モバイル
    order_id

    注文番号
    attach_file_urls

    添付ファイルの詳細
    hit

    観覧数
    reply

    My質問への回答の有無

    T:使用する
    F:使用しない
    reply_user_id

    処理中または回答完了した運営者ID
    reply_status

    回答処理状態

    N:回答前
    P:処理中
    C:対応完了
    naverpay_review_id

    Naver PayのレビューID
    display_time

    表示時間使用の有無
    display_time_start_hour

    表示時間の開始時刻
    display_time_end_hour

    表示時間の終了時刻
    attached_file_detail

    添付ファイルの詳細
    attached_file_urls

    添付ファイルの詳細

    List all boards articles

    GET

    基本スペック

    Property Description
    SCOPE 掲示板の閲覧権限 (mall.read_community)
    呼び出し件数制限 40

    要求スペック

    Parameter Description
    shop_no

    ショップ番号

    DEFAULT 1

    board_no
    Required

    掲示板番号

    board_category_no

    掲示板カテゴリ番号

    start_date

    Date
    timezone

    作成日の開始日

    end_date

    Date
    timezone

    作成日の終了日

    input_channel

    ショップ区分

    P : PC
    M : モバイル

    search

    検索エリア

    subject : タイトル
    content : 内容
    writer_name : 作成者
    product : 商品名
    member_id : 会員ID

    keyword

    検索キーワード

    reply_status

    回答状態

    N : 回答前
    P : 処理中
    C : 回答完了

    comment

    コメントの有無

    T : 有り
    F : 無し

    attached_file