おちゃのこAPIとは
もっと使いやすく、もっと便利に。
外部システムからおちゃのこネットのデータに
アクセスしやすくなり、
受注情報や商品情報の確認、在庫や価格の変更などを
一元管理することができます。
※おちゃのこオフィスの契約が必要となります。
外部システムからおちゃのこネットのデータに
アクセスしやすくなり、
受注情報や商品情報の確認、在庫や価格の変更などを
一元管理することができます。
※おちゃのこオフィスの契約が必要となります。
おちゃのこAPIを使ってできること
必要なもの
おちゃのこAPIのご利用には以下のものが必要です。
- おちゃのこオフィスの契約
- RESTfulなHTTPリクエストが可能なクライアント
- JSONのパース
ご利用方法
認証
- おちゃのこネット管理画面で「基本設定」→「API設定」を開く。
- APIトークン追加をクリックし、任意で名前を入力して設定処理を完了する。
- APIトークンごとに、権限(受注情報取得・商品情報取得・商品情報更新(在庫変更・価格変更))を設定できます。
- 出力されたトークンをコピーする。
- リクエストヘッダにAuthorization: Bearer 取得したトークンを追加する。
- 以後上記のヘッダとともにAPIアクセスをおこなう。
使用例
- PHPでの使用例
$request_options = array( 'http' => array( 'method' => 'GET', 'header'=> "Authorization: Bearer abcd00000000000000000000000000000000000" ) ); $context = stream_context_create($request_options); $url = 'https://api.ocnk.net/v1/orders'; $response_body = file_get_contents($url, false, $context);
受注情報
- 一覧表示
- エンドポイント
/v1/orders - リクエスト方式
GET - リクエストパラメータ
※1 期間を指定する場合は両方必須パラメータ名 利用目的 有効な値(型) 必須 max_id 次ページ開始位置 整数 limit 表示件数(最大:1000) 整数 date 対象年月日 YYYY-MM-DD since 期間を指定する場合の開始日 YYYY-MM-DD ※1 until 期間を指定する場合の終了日 YYYY-MM-DD ※1 update_since 更新日で期間を指定する場合の開始日時 YYYY-MM-DD HH:MM:SS update_until 更新日で期間を指定する場合の終了日時 YYYY-MM-DD HH:MM:SS fields 必要なキーの選択 カンマ区切りの文字列 ※2
※2 data直下の項目のみ選択可能です。 - リクエスト例 https://api.ocnk.net/v1/orders?max_id=20&since=2019-11-01&until=2019-11-30
- レスポンス例
{ "pagination": { "total_count": "2", // 合計件数 "next_max_id": 62, // 次のページを表示するためのmax_id "limit": 20 // 表示件数上限 }, "data": [ { "id": 62, // 受注番号 "created_at": "2019-06-21T15:49:11+09:00", // 受注日時 "updated_at": "2019-06-22T10:30:12+09:00", // 受注更新日時 "total_price": 9420, // 合計金額 "price_detail": { // 合計金額内訳（軽減税率を使用していない場合{}のみ） "standard": 1000, // 通常価格合計 "reduce": 8420 // 軽減税率対象価格合計 }, "total_tax": 328, // 消費税合計 "tax_standard_rate": 10, // 消費税率 "tax_reduce_rate": 8, // 軽減税率(設定していない場合null) "total_tax_detail": { // 消費税合計内訳（軽減税率を使用していない場合{}のみ） "standard": 100, // 通常消費税 "reduce": 228 // 軽減税率対象消費税 }, "total_point_discount": -100, // ポイント値引き "point_discount_detail": { // ポイント利用内訳（軽減税率を使用していない場合{}のみ） "standard": -20, // 通常ポイント値引き "reduce": -80 // 軽減税率対象ポイント値引き }, "total_coupon_discount": -880, // クーポン値引き "coupon_discount_detail": { // クーポン利用内訳（軽減税率を使用していない場合{}のみ） "standard": -80, // 通常クーポン値引き "reduce": -800 // 軽減税率対象クーポン値引き }, "coupon_code": "ABCCOUPON", // クーポンコード名 "total_shipping_price": 1500, // 送料合計 "cash_on_delivery_fee": 300, // 代金引換手数料 "total_special_requests_price": 100, // オプション代合計 "total_shipping_option_price": 300, // 配送オプション金額合計 "total_product_price": 8800, // 販売価格合計 "product_price_detail": { // 販売価格内訳（軽減税率を使用していない場合{}のみ） "standard": 2800, // 通常販売価格合計 "reduce" : 6000 // 軽減税率対象販売価格合計 }, "currency": { "code": "JPY", // 適用通貨 "symbol": "円", // 通貨単位 "symbol_position": "right", // 通貨表示位置 "decimal_places": 0 // 小数点以下表示桁数 }, "cancelled": false, // キャンセル済み "payment_method": "銀行振込", // 支払い方法 "payment_details": [ // 支払い方法詳細 { "title": "支払い方法", "value": "銀行振込" } ], "confirmation_status": { // 受付状況 "order": false, // 受注 "shipping": false, // 発送 "payment": false, // 支払い "other": false // その他 }, "email_status": { // メール送信状況 "order": false, // 受注 "shipping": false, // 発送 "payment": false, // 支払い "other": false // その他 }, "customer": { // 顧客情報 "id": 21, "account": true, // アカウント登録 "corporate": false, // 法人会員か否か "company_name": null, // 法人名 "department": null, // 部署名 "name": "おちゃのこ太郎", // 氏名 "name_katakana": "", // 氏名カタカナ "email": "ochanoko@ocnk.net", // Eメールアドレス "country": null, // 国 "state": null, // 州 "postal_code": "660-0892", // 郵便番号 "prefecture": "兵庫県", // 都道府県 "address": "兵庫県神戸市中央区", // 住所 "phone": "0001112222", // 電話番号 "fax": null, // FAX }, "shipping": [ { "shipping_price": 1500, // 送料 "shipping_method": null, // 発送方法 "delivery_date": null, // お届け日指定 "delivery_time": null, // お届け時間指定 "tracking_company": "", // 宅配便伝票番号：運送会社 "tracking_numbers": [ // 宅配便伝票番号 ], "order_purpose": "プレゼント用", // 用途 "special_requests": リボン, // オプション "special_requests_comments": 青色, // オプション備考欄 "special_requests_price": 100, // オプション代 "product_subtotal_price": 8800, // 販売価格合計 "sender": { "type": "shop", //送り主種別(店舗(shop)、購入者(customer)、送り主の指定(other)) "corporate": false, // 法人か否か "company_name": "", // 法人名 "department": null, // 部署名 "name": "おちゃのこショップ", // 氏名 "name_katakana": "", // 氏名カタカナ "country": null, // 国名 "state": null, // 州 "postal_code": "658-1111", // 郵便番号 "prefecture": "兵庫県", // 都道府県 "address": "神戸市中央区", // 住所 "phone": "0001112222", // 電話番号 }, "recipient": { "type": "customer", // 受け取り者情報(ご注文者住所(customer)、指定の住所(other)、なし(楽天決済)(none)) "corporate": false, // 法人か否か "company_name": "", // 法人名 "department": null, // 部署名 "name": "おちゃのこ太郎", // 氏名 "name_katakana": "", // 氏名カタカナ "country": null, // 国名 "state": null, // 州 "postal_code": "660-0892", // 郵便番号 "prefecture": "兵庫県", // 都道府県 "address": "神戸市中央区", // 住所 "phone": "0001112222", // 電話番号 }, "products": [ { "product_id": 1, // 商品番号 "name": "サンプル商品", // 商品名 "model_number": "sa-001", // 型番 "quantity": 1, // 商品個数; "price": 8800, // 販売価格 "variations": [ { "title": "サイズ", // バリエーション名 "value": "LL" // バリエーション選択肢 } ], "customization": [ { "title": "名入れ", // オーダーメイド名 "value": "おちゃのこネット", // 内容 "price": 300, // 価格 } ], "tax_reduce": true // 軽減税率使用有無（使用している場合true、していない場合false） } ] } ], "transaction_fee": 200, // 決済手数料/請求書発行手数料 "checkout_comments": "ここは備考欄です。", // 備考欄 "checkout_questionnaire": [ // アンケート欄 { "title": "質問1", // 質問名 "value": "回答1" // 回答内容 } ] } ] }
- エンドポイント
- 選択表示
- エンドポイント
/v1/orders/{受注番号} - リクエスト方式
GET - リクエストパラメータ
※1 data直下の項目のみ選択可能です。パラメータ名 利用目的 有効な値(型) 必須 受注番号 受注選択 整数 ○ fields 必要なキーの選択 カンマ区切りの文字列 ※1 - リクエスト例 https://api.ocnk.net/v1/orders/62
- レスポンス例
{ "data": { "id": 62, // 受注番号 "created_at": "2019-06-21T15:49:11+09:00", // 受注日時 "updated_at": "2019-06-22T10:30:12+09:00", // 受注更新日時 "total_price": 9420, // 合計金額 "price_detail": { // 合計金額内訳（軽減税率を使用していない場合{}のみ） "standard": 1000, // 通常価格合計 "reduce": 8420 // 軽減税率対象価格合計 }, "total_tax": 328, // 消費税合計 "tax_standard_rate": 10, // 消費税率 "tax_reduce_rate": 8, // 軽減税率(設定していない場合null) "total_tax_detail": { // 消費税合計内訳（軽減税率を使用していない場合{}のみ） "standard": 100, // 通常消費税 "reduce": 228 // 軽減税率対象消費税 }, "total_point_discount": -120, // ポイント値引き "point_discount_detail": { // ポイント利用内訳（軽減税率を使用していない場合{}のみ） "standard": -20, // 通常ポイント値引き "reduce": -80 // 軽減税率対象ポイント値引き }, "total_coupon_discount": -880, // クーポン値引き "coupon_discount_detail": { // クーポン利用内訳（軽減税率を使用していない場合{}のみ） "standard": -80, // 通常クーポン値引き "reduce": -800 // 軽減税率対象クーポン値引き }, "coupon_code": "ABCCOUPON", // クーポンコード名 "total_shipping_price": 1500, // 送料合計 "cash_on_delivery_fee": 300, // 代金引換手数料 "total_special_requests_price": 100, // オプション代合計 "total_shipping_option_price": 300, // 配送オプション金額合計 "total_product_price": 8800, // 販売価格合計 "product_price_detail": { // 販売価格内訳（軽減税率を使用していない場合{}のみ） "standard": 2800, // 通常販売価格合計 "reduce" : 6000 // 軽減税率対象販売価格合計 }, "points_acquired": 0, // 付与ポイント "currency": { "code": "JPY", // 適用通貨 "symbol": "円", // 通貨単位 "symbol_position": "right", // 通貨表示位置 "decimal_places": 0 // 小数点以下表示桁数 }, "cancelled": false, // キャンセル済み "payment_method": "銀行振込", // 支払い方法 "payment_details": [ // 支払い方法詳細 { "title": "支払い方法", "value": "銀行振込" } ], "confirmation_status": { // 受付状況 "order": false, // 受注 "shipping": false, // 発送 "payment": false, // 支払い "other": false // その他 }, "email_status": { // メール送信状況 "order": false, // 受注 "shipping": false, // 発送 "payment": false, // 支払い "other": false // その他 }, "customer": { // 顧客情報 "id": 21, "account": true, // アカウント登録 "corporate": false, // 法人会員か否か "company_name": null, // 法人名 "department": null, // 部署名 "name": "おちゃのこ太郎", // 氏名 "name_katakana": "", // 氏名カタカナ "email": "ochanoko@ocnk.net", // Eメールアドレス "country": null, // 国 "state": null, // 州 "postal_code": "660-0892", // 郵便番号 "prefecture": "兵庫県", // 都道府県 "address": "兵庫県神戸市中央区", // 住所 "phone": "0001112222", // 電話番号 "fax": null, // FAX }, "shipping": [ { "shipping_price": 1500, // 送料 "shipping_method": null, // 発送方法 "delivery_date": null, // お届け日指定 "delivery_time": null, // お届け時間指定 "tracking_company": "", // 宅配便伝票番号：運送会社 "tracking_numbers": [ // 宅配便伝票番号 ], "order_purpose": "プレゼント用", // 用途 "special_requests": リボン, // オプション "special_requests_comments": 青色, // オプション備考欄 "special_requests_price": 100, // オプション代 "product_subtotal_price": 8800, // 販売価格合計 "sender": { "type": "shop", //送り主種別(店舗(shop)、購入者(customer)、送り主の指定(other)) "corporate": false, // 法人か否か "company_name": "", // 法人名 "department": null, // 部署名 "name": "おちゃのこショップ", // 氏名 "name_katakana": "", // 氏名カタカナ "country": null, // 国名 "state": null, // 州 "postal_code": "658-1111", // 郵便番号 "prefecture": "兵庫県", // 都道府県 "address": "神戸市中央区", // 住所 "phone": "0001112222", // 電話番号 }, "recipient": { "corporate": false, // 法人か否か "company_name": "", // 法人名 "department": null, // 部署名 "name": "おちゃのこ太郎", // 氏名 "name_katakana": "", // 氏名カタカナ "country": null, // 国名 "state": null, // 州 "postal_code": "660-0892", // 郵便番号 "prefecture": "兵庫県", // 都道府県 "address": "神戸市中央区", // 住所 "phone": "0001112222", // 電話番号 }, "products": [ { "product_id": 1, // 商品番号 "name": "サンプル商品", // 商品名 "model_number": "sa-001", // 型番 "quantity": 2, // 商品個数 "price": 8800, // 販売価格 "variations": [ { "title": "サイズ", // バリエーション名 "value": "LL" // バリエーション選択肢 } ], "customization": [ { "title": "名入れ", // オーダーメイド名 "value": "おちゃのこネット", // 内容 "price": 300, // 価格 } ], "tax_reduce": true // 軽減税率使用有無（使用している場合true、していない場合false） } ] } ], "transaction_fee": 200, // 決済手数料/請求書発行手数料 "checkout_comments": "ここは備考欄です。", // 備考欄 "checkout_questionnaire": [ // アンケート欄 { "title": "質問1", // 質問名 "value": "回答1" // 回答内容 } ] } }
- エンドポイント
商品情報
- 一覧表示
- エンドポイント
/v1/products - リクエスト方式
GET - リクエストパラメータ
※1 data直下の項目のみ選択可能です。パラメータ名 利用目的 有効な値(型) 必須 max_id 次ページ開始位置 整数 limit 表示件数(最大:1000) 整数 update_since 更新日で期間を指定する場合の開始日時 YYYY-MM-DD HH:MM:SS update_until 更新日で期間を指定する場合の終了日時 YYYY-MM-DD HH:MM:SS view_hidden 非表示にした商品の表示 true(表示)またはfalse(非表示)、初期値:true fields 必要なキーの選択 カンマ区切りの文字列 ※1 - リクエスト例 https://api.ocnk.net/v1/products?max_id=20&update_since=2020-04-01 12:00:00&update_until=2021-03-31 23:59:59
- レスポンス例
{ "pagination": { "total_count": 2, // 合計件数 "next_max_id": 3, // 次のページを表示するためのmax_id "limit": 20 // 表示件数上限 }, "data": [ { "id": 3, // 商品番号 "name": "サンプル商品", // 商品名 "model_number": sa-001, // 型番 "category": { "id": 5, // カテゴリID "name": "子カテゴリ", // カテゴリ名 "parent_id": 3, // 親カテゴリID "parent_name": "親カテゴリ" // 親カテゴリ }, "groups": [ { "id": 1, // グループID "name": "サンプルグループ" // グループ名 } ], "prerelease": true, // 準備中フラグ(準備中がtrue) "price": 2480, // 販売価格 "price_unspecified": false, // 売価を指定しない "list_price": 3333, // 希望小売価格 "stock": 0, // 在庫数 "stock_unlimited": false, // 在庫数無制限 "hidden": false, // 非表示の商品 "stock_variation": true, // バリエーション有無 "images": [ // 商品写真 { "url": "https://www.example.com/data/example/product/sample1.jpg", // 商品写真URL "main": true // メイン写真 }, { "url": "https://www.example.com/data/example/product/sample2.jpg", // 商品写真URL "main": false // メイン写真 } ], "description": { // 商品説明 "text": "これはサンプル商品です。", // 商品説明文 }, "variations": { "options": { "option1": { "label": "サイズ", //バリエーション名 "values": [ "L", // バリエーション選択肢 "M" // バリエーション選択肢 "S" // バリエーション選択肢 ] } }, "data": [ { "id": 1, // バリエーションID "model_number": "KB-L", // 型番 "option1": "L", // バリエーション1 "option2": "", // バリエーション2 "option3": "", // バリエーション3 "stock": null, // 在庫数 "stock_unlimited": true, // 在庫数無制限 "price": 2222, // 販売価格 "list_price": 2980 // メーカー希望小売価格 }, { "id": 2, "model_number": "KB-S", "option1": "S", "option2": "", "option3": "", "stock": 33, "stock_unlimited": false, "price": 3333, "list_price": 3980 } ] }, "tax_reduce": true // 軽減税率使用有無（使用している場合true、していない場合false） "updated_at": "2019-06-22T10:30:12+09:00" // 更新日時 }, ] }
- エンドポイント
- 選択表示
- エンドポイント
/v1/products/{商品番号} - リクエスト方式
GET - リクエストパラメータ
※1 data直下の項目のみ選択可能です。パラメータ名 利用目的 有効な値(型) 必須 商品番号 商品選択 整数 ○ fields 必要なキーの選択 カンマ区切りの文字列 ※1 - リクエスト例 https://api.ocnk.net/v1/products/3
- レスポンス例
{ "data": { "id": 3, // 商品番号 "name": "サンプル商品", // 商品名 "model_number": "sb-001", // 型番 "category": { "id": 5, // カテゴリID "name": "子カテゴリ", // カテゴリ名 "parent_id": 3, // 親カテゴリID "parent_name": "親カテゴリ" // 親カテゴリ }, "groups": [ { "id": 1, // グループID "name": "サンプルグループ" // グループ名 } ], "prerelease": false, // 準備中フラグ(準備中がtrue) "price": 2480, // 販売価格 "price_unspecified": false, // 販売価格未設定 "list_price": 3333, // 希望小売価格 "stock": 0, // 在庫数 "stock_unlimited": false, // 在庫数無制限 "stock_variation": true, // バリエーション有無 "images": [ // 商品写真 { "url": "https://www.example.com/data/example/product/sample1.jpg", // 商品写真URL "main": true // メイン写真 }, { "url": "https://www.example.com/data/example/product/sample2.jpg", // 商品写真URL "main": false // メイン写真 } ], "description": { // 商品説明 "text": "これはサンプル商品です。", // 商品説明文 }, "variations": { "options": { "option1": { "label": "サイズ", // バリエーション名 "values": [ "L", // バリエーション選択肢 "M" // バリエーション選択肢 "S" // バリエーション選択肢 ] } }, "data": [ { "id": 1, // バリエーションID "model_number": "KB-L", // 型番 "option1": "L", // バリエーション選択肢1 "option2": "", // バリエーション選択肢2 "option3": "", // バリエーション選択肢3 "stock": null, // 在庫数 "stock_unlimited": true, // 在庫数無制限 "price": 2222, // 販売価格 "list_price": 2980 // メーカー希望小売価格 }, { "id": 2, "model_number": "KB-S", "option1": "S", "option2": "", "option3": "", "stock": 33, "stock_unlimited": false, "price": 3333, "list_price": 3980 } ] }, "tax_reduce": true // 軽減税率（使用している場合true、していない場合false） "updated_at": "2019-06-22T10:30:12+09:00" // 更新日時 } }
- エンドポイント
- 在庫変更
- エンドポイント
/v1/products - リクエスト方式
PUT - リクエストパラメータ
※ 更新件数の上限は1000件です。パラメータ名 有効な値(型) 必須 商品番号 整数 ○ バリエーションID 整数 バリエーション使用時必須 在庫数 整数 ○ 在庫数無制限 boolean - リクエスト例(JSON)
{ "data": [ { "id": 3, // 商品番号 "variations": { // バリエーション（利用する場合のみ） "data": [ { "id": 1, // バリエーションID "stock": 22, // 在庫数 "stock_unlimited": false // 在庫数無制限 } ] } }, { "id": 3, // 商品番号 "stock": 33, // 在庫数 "stock_unlimited": false // 在庫数無制限 } ] }
- リクエスト例(JSON/在庫数無制限の場合)
{ "data": [ { "id": 3, // 商品番号 "variations": { // バリエーション（使用する場合のみ） "data": [ { "id": 1, // バリエーションID "stock_unlimited": true // 在庫数無制限 } ] } }, { "id": 3, // 商品番号 "stock_unlimited": true // 在庫数無制限 } ] }
- レスポンス
商品情報の一覧表示と同形式で変更分のみが配列で返ってきます。
- エンドポイント
- 価格変更
- エンドポイント
/v1/products - リクエスト方式
PUT - リクエストパラメータ
※ 更新件数の上限は1000件です。パラメータ名 有効な値(型) 必須 商品番号 整数 ○ バリエーションID 整数 バリエーション使用時必須 販売価格 少数(小数点第2桁まで) ○ - リクエスト例(JSON)
{ "data": [ { "id": 3, // 商品番号 "variations": { // バリエーション（使用する場合） "data": [ { "id": 1, // バリエーションID "price": 2222 // 販売価格 } ] } }, { "id": 3, // 商品番号 "price": 2980 // 販売価格 } ] }
- レスポンス
商品情報の一覧表示と同形式で変更分のみが配列で返ってきます。
- エンドポイント
エラーコード一覧
- APIエラーコード一覧はこちらになります。