GET /1/orders/detail/:unique_key

注文情報を取得

※ 販売パートナーAppによってパートナーショップの注文が作成されている場合、その注文情報も取得可能です。

scope

read_orders

リクエストパラメーター

なし

レスポンスの例

{
  "order":{
    "unique_key":"154D88A39E454289",
    "ordered":1396419762,
    "cancelled":null,
    "dispatched":1396509935,
    "payment":"creditcard",
    "shipping_method": "ヤマト運輸", // shipping_lines を持っている場合はnull
    "shipping_fee":500,
    "cod_fee":300,
    "total":8800,
    "first_name":"太郎",
    "last_name":"山田",
    "country":"Japan", // 自分の商品がパートナーショップで販売された場合はnull
    "country_code":"JP", // 自分の商品がパートナーショップで販売された場合はnull
    "zip_code":"106-0032", // 自分の商品がパートナーショップで販売された場合はnull
    "prefecture":"東京都", // 自分の商品がパートナーショップで販売された場合はnull
    "address":"港区六本木", // 自分の商品がパートナーショップで販売された場合はnull
    "address2":"4-11-4 六本木ビル 301", // 自分の商品がパートナーショップで販売された場合はnull
    "mail_address":"mail@example.com", // 自分の商品がパートナーショップで販売された場合はnull
    "tel":"03-1234-5678", // 自分の商品がパートナーショップで販売された場合はnull
    "remark":"午前中の配送を希望します。",
    "add_comment":"[配送業者]佐川急便 [送り状番号]1234-5678-90",
    "delivery_company_id":3,
    "tracking_number":"1234-1234-1234",
    "delivery_date":"2018-03-19",
    "delivery_time_zone":"0812",
    "terminated":false,
    "dispatch_status":"dispatched",
    "modified":1396509935,
    "order_receiver":{
      "first_name":"花子",
      "last_name":"山田",
      "zip_code":"150-0043",
      "prefecture":"東京都",
      "address":"渋谷区道玄坂",
      "address2":"2-10-12 新大宗ビル3号館 531号",
      "tel":"03-1234-5678",
      "country":"Japan",
      "country_code":"JP"
    },
    "order_discount":{
      "discount":1000,
      "note":"初売りクーポン",
      "is_allocate_user_balance_log":0
    },
    "order_amount_adjustment":{
      "adjusted_amount":-100
    },
    "order_header_coin":{
      "discount":1000,
      "note":"コイン「HOGEコイン」の利用"
    },
    "order_charge":{
      "collected_fee":100 // 「販売パートナー App」を利用して作られた注文の場合はnull
    },
    "order_group_order_charge": {
      "collected_fee": null // 「販売パートナー App」を使ったパートナーショップの商品をふくむ注文群で、最後に発送された注文にnullでない値が入ります。
    },
    "fee_type":"base",
    "additional_charges":[
      {
        "name":"オプション機能名1",
        "collected_fee":100
      },
      {
        "name":"オプション機能名2",
        "collected_fee":200
      }
    ],
    "c_c_payment_transaction":{
      "collected_fee":200,
      "status":"captured"
    },
    "order_group_c_c_payment_transaction": {
      "collected_fee": null, // 「販売パートナー App」を使ったパートナーショップの商品をふくむ注文群で、最後に発送された注文にnullでない値が入ります。
      "status": null
    },
    "cvs_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "bt_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "atobarai_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "carrier_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "paypal_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "amazon_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "coin_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "bnpl_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "sales_partner_order_brand_charges": { // 「販売パートナー App」に掲載していた自分の商品がパートナーショップで販売された注文の場合にのみ、このキーが出現します。
      "reward_fee": 100
    },
    "user_balance_logs":[
      {
        "text":"154D88A39E454289の売上が確定しました",
        "price":7048,
        "created":1396509935
      },
      {
        "text":"154D88A39E454289のヤマト配送料",
        "price":-500,
        "created":1396509935
      },
      {
        "text":"154D88A39E454289のヤマト配送料の差額",
        "price":-200,
        "created":1396519935
      },
      {
        "text":"154D88A39E454289のの日本郵便配送料",
        "price":-500,
        "created":1396509935
      },
      {
        "text":"154D88A39E454289の日本郵便配送料の差額",
        "price":-200,
        "created":1396519935
      }
    ],
    "order_items":[
      {
        "order_item_id":123,
        "item_id":1000,
        "variation_id":101,
        "title":"Tシャツ",
        "item_identifier":"abcd-1234",
        "variation":"サイズM",
        "variation_identifier":"abcd-1234-w",
        "barcode":"abcd-1234-w",
        "options":[],
        "price":2000,
        "amount":2,
        "total":7000,
        "item_total":4000,
        "option_total":3000,
        "item_tax_type":1,
        "consumption_tax_rate":10,
        "status":"ordered",
        "shipping_method":null, // shipping_lines を持っている場合は null
        "shipping_fee":0, // shipping_lines を持っている場合は 0
        "modified":1398231452
      },
      {
        "order_item_id":124,
        "item_id":1001,
        "variation_id":201,
        "title":"ロングTシャツ",
        "item_identifier":"abcd-1234",
        "variation":"サイズL",
        "variation_identifier":"abcd-1234-w",
        "barcode":"abcd-1234-w",
        "options":[
          {
            "option_id":1,
            "option_variation_id":2,
            "option_name":"文字入れ式オプション",
            "option_type":"form",
            "price":1000,
            "item_tax_type":1,
            "consumption_tax_rate":10,
            "option_value":"ベイス太郎"
          },
          {
            "option_id":2,
            "option_variation_id":5,
            "option_name":"選択式オプション",
            "option_type":"select",
            "price":2000,
            "item_tax_type":1,
            "consumption_tax_rate":10,
            "option_value":"メッシュ加工"
          }
        ],
        "price":3000,
        "amount":1,
        "total":3000,
        "item_tax_type":1,
        "consumption_tax_rate":10,
        "status":"ordered",
        "shipping_method":null,
        "shipping_fee":0,
        "shipping_start": "2019-06-21",
        "shipping_end": "2019-06-26",
        "modified":1396419762
      }
    ],
    "subscription": {
      "unique_key": "SABCDEF123456780",
      "repeat_number": 1,
      "repeat_times": 12
    },
    "shipping_lines":[
      {
          "order_item_ids": [100, 200],
          "shipping_method": "配送方法名(サイズ名)",
          "shipping_fee": 100,
      }
    ],
    "membership_rewards":[
      {
        "name": "特典名A",
        "status": "dispatched",
      },
      {
        "name": "特典名B",
        "status": "cancelled"
      }
    ]
  }
}

解説

unique_key - 注文情報を識別するユニークなキー
ordered - 注文日時
cancelled - キャンセル日時
dispatched - 発送日時
payment - 決済方法。creditcard:クレジットカード決済、cod:代金引換、cvs:コンビニ決済、base_bt:銀行振込(BASE口座)、atobarai:後払い決済、carrier_01:キャリア決済ドコモ、carrier_02:キャリア決済au、carrier_03:キャリア決済ソフトバンク、paypal:PayPal決済、coin:コイン決済、amazon_pay:Amazon Pay、bnpl:Pay ID あと払い、bnpl_installment:Pay ID 3回あと払い
shipping_method - 配送方法 (注文に対して指定している場合と、商品ごとに指定している場合がある) ※ shipping_lines を持っている場合はnull
shipping_fee - 送料 (注文ごと、商品ごと、配送ラインごとに指定している場合がある)
cod_fee 代引き手数料
total - 合計金額 ( (注文キャンセルがされていない(購入商品単価 + 商品オプション単価の合計) * 数量) - 割引金額 - コイン割引金額 + 代引き手数料 + 調整金額) ※ 消費税、手数料含む
country_code - ISO 3166-1 alpha-2 に対応した国名コード。一部のコードが割り当てられていない国・地域については空文字列。
mail_address - 購入者のメールアドレス
remark - 備考欄
add_comment - 発送メールに添付する一言メッセージ
delivery_date - 配送日(yyyy-mm-dd)
delivery_time_zone - 配送時間帯。4ケタの数字(午前中 -> 0812、12時~14時 -> 1214)
terminated - [非推奨] dispatch_statusを使ってください。すべてが対応済かキャンセルになっていればtrue
dispatch_status - 注文ステータス。unshippable:対応開始前、ordered:未対応、cancelled:キャンセル、dispatched:対応済、unpaid:入金待ち、shipping:配送中
modified - 更新日時
order_receiver - お届け先情報
order_discount - 割引情報
- discount - 割引金額
- note - 割引名
- is_allocate_user_balance_log - BASE負担割引フラグ。0:ショップ負担割引、1:BASE負担割引
order_amount_adjustment - 金額調整情報
- adjusted_amount - 調整金額
order_header_coin - コイン割引情報
- discount - 割引金額
- note - 割引名
order_charge - サービス利用料情報
- collected_fee - サービス利用料(2017年9月20日から徴収開始)
order_group_order_charge -「販売パートナー App」を利用して作られた注文のサービス利用料情報
- collected_fee - サービス利用料
fee_type - 手数料の種類。base: Webショップで購入されたさいの手数料、payid_app:Pay IDアプリで購入されたさいの手数料
additional_charges - オプション機能利用料情報
- name - オプション機能名
- collected_fee - オプション機能利用料
c_c_payment_transaction - クレジットカード決済情報
- collected_fee - クレジット決済手数料
- status - クレジットカード決済ステータス。creditable:与信確保、captured:売上確定、cancelled:キャンセル
order_group_c_c_payment_transaction - 「販売パートナー App」を利用して作られた注文のクレジットカード決済情報
- collected_fee - クレジット決済手数料
- status - クレジットカード決済ステータス。creditable:与信確保、captured:売上確定、cancelled:キャンセル
cvs_payment_transaction - コンビニ決済情報
- collected_fee - コンビニ決済手数料
- status - コンビニ決済ステータス。unpaid:入金待ち、paid:入金済み、cancelled:キャンセル
bt_payment_transaction - 銀行振込(BASE口座)決済情報
- collected_fee - 銀行振込(BASE口座)決済手数料
- status - 銀行振込(BASE口座)決済ステータス。unpaid:入金待ち、paid:入金済み、cancelled:キャンセル、shortage:不足入金
atobarai_payment_transaction - 後払い決済情報
- collected_fee - 後払い決済手数料
- status - 後払い決済ステータス。ordered:未発送、shipping:配送中、arrived:着荷、cancelled:キャンセル
carrier_payment_transaction - キャリア決済情報
- collected_fee - キャリア決済手数料
- status - キャリア決済ステータス。authorized:与信確保、captured:売上確定、cancelled:キャンセル
paypal_payment_transaction - PayPal決済情報
- collected_fee - PayPal決済手数料
- status - PayPal決済ステータス。creditable:与信確保、captured:売上確定、cancelled:キャンセル
amazon_payment_transaction - Amazon Pay情報
- collected_fee - Amazon Pay手数料
- status - Amazon Payステータス。creditable:与信確保、captured:売上確定、cancelled:キャンセル
bnpl_payment_transaction - Pay ID（あと払い）決済情報
- collected_fee - Pay ID（あと払い）手数料
- status - Pay ID（あと払い）ステータス。creditable:与信確保、captured:売上確定、cancelled:キャンセル
sales_partner_order_brand_charges - 「販売パートナー App」を利用して作られた注文にかかる報酬
- reward_fee - 販売パートナー注文の報酬額
user_balance_logs - お金履歴情報
- text - 見出しテキスト
- price - 金額
- created - 作成日時
order_items - 購入商品情報
- order_item_id - 購入商品ID
- item_id - 商品ID
- variation_id - バリエーションID
- title - 商品名
- item_identifier - 商品コード
- variation - バリエーションの種類
- variation_identifier - バリエーションの種類コード
- barcode - バリエーションのJAN/GTIN
- options - 購入商品オプション
  - option_id - 商品オプションID
  - option_variation_id - 商品オプション項目ID
  - option_name - 商品オプション名
  - option_type - 商品オプションのタイプ select:選択式, form:フォーム入力式
  - price - 商品オプション単価
  - item_tax_type - 商品の税率設定。1:標準税率、2:軽減税率
  - consumption_tax_rate - 消費税率
  - option_value - 商品オプション値
- price - 単価
- amount - 数量
- total - 注文商品単位の合計金額 (購入商品単価 + (商品オプション単価の合計 * 数量))
- item_total - 商品合計金額 (購入商品単価 * 数量)
- option_total - 商品オプションの合計金額 (商品オプション単価の合計 * 数量)
- item_tax_type - 商品の税率設定。1:標準税率、2:軽減税率
- consumption_tax_rate - 消費税率
- status - ステータス。ordered:未対応、cancelled:キャンセル、dispatched:対応済
- shipping_method - 配送方法 ※ shipping_lines を持っている場合はnull
- shipping_fee - 送料 ※ shipping_lines を持っている場合は 0
- shipping_start - 発送開始予定日（予約注文でない場合はnull）
- shipping_end - 発送終了予定日（予約注文でないか、予約注文であっても設定されていない場合はnull）
- modified - 更新日時
subscription - 定期便注文情報
- unique_key - 定期便ID（定期便注文でないときはnull）
- repeat_number - 注文回数。今回の注文が定期便で何回目の注文であるか。（定期便注文でないときはnull）
- repeat_times - 継続回数。この定期便が全部で何回継続されるか。回数無制限のときは0。（定期便注文でないときはnull）
shipping_lines - 配送ライン情報
- order_item_ids - 配送ライン毎の購入商品ID配列
- shipping_method - 配送方法名({サイズ名})。※ショップの送料の場合はnull
- shipping_fee - 配送ライン別送料
membership_rewards - 特典申請情報
- name - 特典名
- status - ステータス。ordered:未対応、cancelled:キャンセル、dispatched:対応済

エラーレスポンスの例

{
  "error":"access_denied",
  "error_description":"httpsでアクセスしてください。"
}

{
  "error":"invalid_request",
  "error_description":"アクセストークンが無効です。"
}

{
  "error":"invalid_scope",
  "error_description":"スコープが無効です。"
}

{
  "error":"no_unique_key",
  "error_description":"unique_keyは必須です。"
}

{
  "error":"no_order",
  "error_description":"注文情報が見つかりませんでした。"
}

Developers

OAuth

Users

Item

Category

Item Category

Orders

Savings

Delivery Company

Search

orders/detail

GET /1/orders/detail/:unique_key

scope

リクエストパラメーター

レスポンスの例

解説

エラーレスポンスの例