ReCORE.co-api

EC受注

受注検索

概要

• 受注情報の検索を行う

基本情報

• リクエストパス: GET /ec/orders
• JWTスコープ: ec:order:index
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

query

key	説明	制約など
ids	受注ID	整数のみ、カンマ区切りで複数指定可能
item_ids	在庫ID	整数のみ、カンマ区切りで複数指定可能
statuses	受注ステータス	カンマ区切りで複数指定可能
sub_statuses	サブステータス	カンマ区切りで複数指定可能
ec_account_id	ECアカウントID	-
created_at_from	作成日から	2024-04-12 12:08:38 形式
created_at_to	作成日まで	同上
updated_at_from	更新日から	同上
updated_at_to	更新日まで	同上
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250
cursor	ページカーソル	-

例

• Request

GET /ec/orders?ids=179

• Response

[
  {
    "id": 179,
    "ec_account": {
      "id": 2,
      "mall_id": "AMAZON_JP"
    },
    "mall_order_id": "503-0946393-1072622",
    "mall_url": "https://sellercentral.amazon.co.jp/orders-v3/order/503-0946393-1072622",
    "status": "SHIPPED",
    "sub_status": null,
    "ordered_at": 1537695918,
    "shipped_at": 1537697384,
    "payment_total": 1380,
    "payment_method": null,
    "buyer_name": "菊地浩貴",
    "buyer_name_kana": null,
    "buyer_email": "0xp35rs6y0tmk58@marketplace.amazon.co.jp",
    "shipping_postal_code": "564-0051",
    "shipping_country_code": "JP",
    "shipping_state_or_region": "大阪府",
    "shipping_city": null,
    "shipping_address1": "吹田市豊津町",
    "shipping_address2": "9-22-7F",
    "shipping_address3": null,
    "shipping_phone": null,
    "shipping_name": "菊地浩貴",
    "earliest_delivery_at": 1538060400,
    "latest_delivery_at": 1538319599,
    "note": null,
    "comment": null,
    "created_at": 1708054490,
    "updated_at": 1708054490,
    "goods": [
      {
        "id": 185,
        "serial": 1,
        "ec_order_id": 179,
        "mall_item_id": "54400968056678",
        "mall_item_code": "1LZ-N19-194",
        "unit_price": 520,
        "unit_adjustment": 0,
        "order_adjustment": 0,
        "tax": 0,
        "included_tax": 0,
        "tax_rate": 0,
        "tax_rate_type": "NO_TAX",
        "shipping_price": 340,
        "shipping_tax": 0,
        "shipping_included_tax": 25,
        "shipping_tax_rate": 8,
        "shipping_tax_rate_type": "GENERAL",
        "payment_price": 0,
        "payment_tax": 0,
        "payment_included_tax": 0,
        "payment_tax_rate": 8,
        "payment_tax_rate_type": "GENERAL",
        "option_price": 0,
        "option_tax": 0,
        "option_included_tax": 0,
        "option_tax_rate": 8,
        "option_tax_rate_type": "GENERAL",
        "quantity": 2,
        "shipped_quantity": 2,
        "earned_point": 0,
        "title": "PCモニタ",
        "comment": null,
        "allocations": [
          {
            "id": 7,
            "item_id": 266,
            "location_id": 1,
            "quantity": 2,
            "reserved_quantity": 2,
            "price_ratio": 1,
            "quantity_ratio": 1
          }
        ]
      }
    ],
    "fulfillments": [
      {
        "id": 5,
        "ec_order_id": 179,
        "shipping_carrier": {
          "id": 2,
          "name": "ヤマト運輸",
          "type": "YAMATO"
        },
        "tracking_number": "12345",
        "note": "2",
        "created_at": 1715932595,
        "goods": [
          {
            "ec_order_goods_id": 185,
            "quantity": 2
          }
        ]
      }
    ]
  }
]

key	type	説明
*	array<object>	受注
*.id	int	受注ID
*.ec_account	object	ECアカウント
*.ec_account.id	int	ECアカウントID
*.ec_account.mall_id	string	モールID
*.mall_order_id	string	モール受注ID
*.mall_url	string | null	モール受注詳細URL
*.status	string	受注ステータス
*.sub_status	string | null	サブステータス
*.ordered_at	int | null	モール受注日
*.shipped_at	int | null	出荷日
*.payment_total	int	お客様支払額
*.payment_method	string | null	支払い方法
*.buyer_name	string | null	購入者氏名
*.buyer_name_kana	string | null	購入者かな
*.buyer_email	string | null	購入者メールアドレス
*.shipping_postal_code	string | null	配送先郵便番号
*.shipping_country_code	string | null	配送先国コード (ISO-3166)
*.shipping_state_or_region	string | null	配送先
*.shipping_city	string | null	配送先
*.shipping_address1	string | null	配送先
*.shipping_address2	string | null	配送先
*.shipping_address3	string | null	配送先
*.shipping_phone	string | null	配送先電話番号
*.shipping_name	string | null	配送先宛名
*.earliest_delivery_at	int | null	配送日時指定から (日付未指定の場合は1970-01-01)
*.latest_delivery_at	int | null	配送日時指定まで (同上)
*.note	string | null	内部メモ
*.comment	string | null	受注時備考
*.created_at	int | null	受注作成日
*.updated_at	int | null	受注更新日
*.goods	array<object>	受注明細
*.goods.*.id	int	受注明細ID
*.goods.*.serial	int	受注明細通し番号
*.goods.*.ec_order_id	int	受注ID
*.goods.*.mall_item_id	string	モール明細ID
*.goods.*.mall_item_code	string | null	モールSKU
*.goods.*.unit_price	int	単価
*.goods.*.unit_adjustment	int	単価調整
*.goods.*.order_adjustment	int	小計調整
*.goods.*.tax	int	外税
*.goods.*.included_tax	int	内税
*.goods.*.tax_rate	int	税率
*.goods.*.tax_rate_type	string	税区分
*.goods.*.shipping_price	int	送料
*.goods.*.shipping_tax	int	送料外税
*.goods.*.shipping_included_tax	int	送料内税
*.goods.*.shipping_tax_rate	int	送料税率
*.goods.*.shipping_tax_rate_type	string	送料税区分
*.goods.*.payment_price	int	支払手数料
*.goods.*.payment_tax	int	支払手数料外税
*.goods.*.payment_included_tax	int	支払手数料内税
*.goods.*.payment_tax_rate	int	支払手数料税率
*.goods.*.payment_tax_rate_type	string	支払手数料税区分
*.goods.*.option_price	int	サービス料
*.goods.*.option_tax	int	サービス料外税
*.goods.*.option_included_tax	int	サービス料内税
*.goods.*.option_tax_rate	int	サービス料税率
*.goods.*.option_tax_rate_type	string	サービス料税区分
*.goods.*.quantity	int	受注数量
*.goods.*.shipped_quantity	int	出荷済み数量
*.goods.*.earned_point	int	獲得ポイント
*.goods.*.title	string | null	モール商品名
*.goods.*.comment	string | null	明細毎の受注時備考
*.goods.*.allocations	array<object>	在庫割当
*.goods.*.allocations.*.id	int	在庫割当ID
*.goods.*.allocations.*.item_id	int	在庫ID
*.goods.*.allocations.*.location_id	int	ロケーションID
*.goods.*.allocations.*.quantity	int	割当数量
*.goods.*.allocations.*.reserved_quantity	int	確保済み割当数量
*.goods.*.allocations.*.price_ratio	float	受注額に対する価格比
*.goods.*.allocations.*.quantity_ratio	int	受注数量に対する割当比
*.fulfillments	array<object>	出荷
*.fulfillments.*.id	int	出荷ID
*.fulfillments.*.ec_order_id	int	受注ID
*.fulfillments.*.shipping_carrier	object | null	配送会社
*.fulfillments.*.shipping_carrier.id	int	配送会社ID
*.fulfillments.*.shipping_carrier.name	string	配送会社名
*.fulfillments.*.shipping_carrier.type	string	配送会社タイプ
*.fulfillments.*.tracking_number	string | null	追跡番号
*.fulfillments.*.note	string | null	内部メモ
*.fulfillments.*.created_at	int | null	受注作成日
*.fulfillments.*.goods	array<object>	出荷商品
*.fulfillments.*.goods.*.ec_order_goods_id	int	受注明細ID
*.fulfillments.*.goods.*.quantity	int	出荷数量

• ステータス
  • PENDING 代金未回収状態、発送不可
  • UNSHIPPED 代金回収済み、発送可
  • SHIPPED 出荷済み
  • CANCELED 出荷前キャンセル済み
  • IN_PROGRESS 処理中
  • OTHER 予期しない状態
• 税区分
  • GENERAL 一般
  • RELIEF 軽減税率
  • NO_TAX 非課税
• 金額計算について
  • 明細別税込金額 (unit_price + unit_adjustment) * quantity + order_adjustment + tax + shipping_price + shipping_tax + payment_price + payment_tax + option_price + option_tax
  • 明細別税抜金額 明細別税込金額 - included_tax - shipping_included_tax - payment_included_tax - option_included_tax
  • 受注合計 SUM(明細別税込金額)

受注取得

概要

• 受注情報を1件取得する

基本情報

• リクエストパス: GET /ec/orders/{ec_order_id}
• JWTスコープ: ec:order:show
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

例

• Request

GET /ec/orders/179

• Response

受注検索のresponse[0]と同様

受注更新

概要

• 受注情報を更新する

基本情報

• リクエストパス: PUT /ec/orders/{ec_order_id}
• JWTスコープ: ec:order:update
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

body

key	type	説明	制約など
sub_status	?string | null	サブステータス	-
note	?string | null	内部メモ	-

例

• Request

PUT /ec/orders/179

{
  "note": "abc"
}

• Response

受注取得と同様

入金確認

概要

• 受注ステータスをPENDINGからUNSHIPPEDへ変更する

基本情報

• リクエストパス: PUT /ec/orders/confirm
• JWTスコープ: ec:order:confirm:update
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

body

key	type	説明	制約など
*	array<object>	-	-
*.ec_order_id	int	受注ID	-

例

• Request

PUT /ec/orders/confirm

[
  {
    "ec_order_id": 18
  },
  {
    "ec_order_id": 19
  }
]

• Response

なし

受注キャンセル

概要

• 受注ステータスをPENDING UNSHIPPEDからCANCELEDへ変更する

基本情報

• リクエストパス: PUT /ec/orders/cancel
• JWTスコープ: ec:order:cancel:update
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

body

key	type	説明	制約など
*	array<object>	-	-
*.ec_order_id	int	受注ID	-
*.reason	string	キャンセル理由	-

• キャンセル理由
  • 購入者都合のキャンセル 店舗都合のキャンセル 在庫なし 未入金 配送不可 その他 から選択してください。
  • 任意の文字列でも問題ありませんが、モール側に反映される値は「その他」や「理由なし」となります。

例

• Request

PUT /ec/orders/cancel

[
  {
    "ec_order_id": 18,
    "reason": "購入者都合のキャンセル"
  },
  {
    "ec_order_id": 19,
    "reason": "在庫なし"
  }
]

• Response

なし

出荷

概要

• 受注ステータスをUNSHIPPEDからSHIPPEDへ変更する
• 全量出荷されていない場合はUNSHIPPEDへ戻ります

基本情報

• リクエストパス: POST /ec/orders/fulfillments
• JWTスコープ: ec:order:fulfillment:store
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

body

key	type	説明	制約など
*	array<object>	-	-
*.ec_order_id	int	受注ID	-
*.shipping_carrier_id	?int | null	配送会社ID	-
*.tracking_number	?string | null	追跡番号	-
*.note	?string | null	内部メモ	-
*.goods.*.ec_order_goods_id	int	受注明細ID	-
*.goods.*.quantity	int	出荷数量	1以上

• 配送会社ID
  • ReCOREアカウントによって異なります、お問合せください

例

• Request

POST /ec/orders/fulfillments

[
  {
    "ec_order_id": 18,
    "shipping_carrier_id": 2,
    "tracking_number": "1234-1234-1234",
    "note": null,
    "goods": [
      {
        "ec_order_goods_id": 123,
        "quantity": 1
      },
      {
        "ec_order_goods_id": 124,
        "quantity": 2
      }
    ]
  },
  {
    "ec_order_id": 19,
    "goods": [
      {
        "ec_order_goods_id": 125,
        "quantity": 1
      }
    ]
  }
]

• Response

なし

返品検索

概要

• 返品情報の検索を行う

基本情報

• リクエストパス: GET /ec/orders/return_orders
• JWTスコープ: ec:order:return_order:index
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

query

key	説明	制約など
ids	返品ID	整数のみ、カンマ区切りで複数指定可能
ec_order_ids	受注ID	整数のみ、カンマ区切りで複数指定可能
statuses	受注ステータス	カンマ区切りで複数指定可能
created_at_from	作成日から	2024-04-12 12:08:38 形式
created_at_to	作成日まで	同上
updated_at_from	更新日から	同上
updated_at_to	更新日まで	同上
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250
cursor	ページカーソル	-

例

• Request

GET /ec/orders/return_orders?ids=9

• Response

[
  {
    "id": 9,
    "ec_order_id": 181,
    "staff": {
      "id": 1,
      "name": "スタッフ 太郎"
    },
    "status": "DONE",
    "note": null,
    "done_at": 1713451170,
    "created_at": 1713450912,
    "goods": [
      {
        "id": 11,
        "ec_order_goods_id": 188,
        "unit_price": 35200,
        "unit_adjustment": 0,
        "order_adjustment": 0,
        "tax": 0,
        "included_tax": 0,
        "tax_rate": 10,
        "tax_rate_type": "GENERAL",
        "shipping_price": 0,
        "shipping_tax": 0,
        "shipping_included_tax": 0,
        "shipping_tax_rate": 10,
        "shipping_tax_rate_type": "GENERAL",
        "payment_price": 0,
        "payment_tax": 0,
        "payment_included_tax": 0,
        "payment_tax_rate": 10,
        "payment_tax_rate_type": "GENERAL",
        "option_price": 0,
        "option_tax": 0,
        "option_included_tax": 0,
        "option_tax_rate": 10,
        "option_tax_rate_type": "GENERAL",
        "quantity": 1,
        "earned_point": 0,
        "return_type": "AS_NEW",
        "allocations": [
          {
            "id": 10,
            "quantity": 1,
            "returned_quantity": 1,
            "returned_item_id": 291
          }
        ]
      }
    ]
  }
]

key	type	説明
*	array<object>	返品
*.id	int	返品ID
*.ec_order_id	int	受注ID
*.staff	object | null	スタッフ
*.staff.id	int	スタッフID
*.staff.name	string	スタッフ名
*.status	string	返品ステータス
*.note	string | null	内部メモ
*.done_at	int | null	ケース完了日
*.created_at	int | null	ケース作成日
*.goods	array<object>	返品明細
*.goods.*.id	int	返品明細ID
*.goods.*.ec_order_goods_id	int	受注明細ID
*.goods.*.unit_price	int	単価
*.goods.*.unit_adjustment	int	単価調整
*.goods.*.order_adjustment	int	小計調整
*.goods.*.tax	int	外税
*.goods.*.included_tax	int	内税
*.goods.*.tax_rate	int	税率
*.goods.*.tax_rate_type	string	税区分
*.goods.*.shipping_price	int	送料
*.goods.*.shipping_tax	int	送料外税
*.goods.*.shipping_included_tax	int	送料内税
*.goods.*.shipping_tax_rate	int	送料税率
*.goods.*.shipping_tax_rate_type	string	送料税区分
*.goods.*.payment_price	int	支払手数料
*.goods.*.payment_tax	int	支払手数料外税
*.goods.*.payment_included_tax	int	支払手数料内税
*.goods.*.payment_tax_rate	int	支払手数料税率
*.goods.*.payment_tax_rate_type	string	支払手数料税区分
*.goods.*.option_price	int	サービス料
*.goods.*.option_tax	int	サービス料外税
*.goods.*.option_included_tax	int	サービス料内税
*.goods.*.option_tax_rate	int	サービス料税率
*.goods.*.option_tax_rate_type	string	サービス料税区分
*.goods.*.quantity	int	返品数量
*.goods.*.earned_point	int	返還ポイント
*.goods.*.return_type	string	在庫補充モード
*.goods.*.allocations	array<object>	在庫補充割当
*.goods.*.allocations.*.id	int	在庫補充割当ID
*.goods.*.allocations.*.quantity	int	補充数量
*.goods.*.allocations.*.returned_quantity	int	補充済み割当数量
*.goods.*.allocations.*.returned_item_id	int | null	補充在庫ID

• ステータス
  • IN_PROGRESS 編集中
  • DONE 返品確定
• 在庫補充モード
  • NORMAL 販売在庫と同じ在庫へ戻す
  • AS_NEW 新しい在庫を作成して戻す
  • NO_ADD 在庫を戻さない

返品取得

概要

• 返品情報を1件取得する

基本情報

• リクエストパス: GET /ec/orders/return_orders/{ec_return_order_id}
• JWTスコープ: ec:order:return_order:show
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

例

• Request

GET /ec/orders/return_orders/9

• Response

返品検索のresponse[0]と同様

返品作成

概要

• 新しい返品ケースを作成する

基本情報

• リクエストパス: POST /ec/orders/{ec_order_id}/return_orders
• JWTスコープ: ec:order:return_order:store
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

body

key	type	説明	制約など
staff_id	?int | null	スタッフID	-
note	?string | null	内部メモ	-
goods	array<object>	受注明細	-
goods.*.ec_order_goods_id	int	受注明細ID	-
goods.*.quantity	int	返品数量	-
goods.*.return_type	string	在庫補充モード	-

例

• Request

POST /ec/orders/181/return_orders

{
  "staff_id": null,
  "note": null,
  "goods": [
    {
      "ec_order_goods_id": 188,
      "quantity": 1,
      "return_type": "NO_ADD"
    }
  ]
}

• Response

返品検索のresponse[0]と同様

返品編集

概要

• 既存の返品ケースを編集する

基本情報

• リクエストパス: PUT /ec/orders/return_orders/{ec_return_order_id}
• JWTスコープ: ec:order:return_order:update
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

body

返品作成との差分のみ記載

key	type	説明	制約など
goods.*.action	string	アクション	CREATE UPDATE DELETE
goods.*.id	?int (*2)	返品明細ID	-
goods.*.ec_order_goods_id	?int (*1)	受注明細ID	-
goods.*.quantity	?int (*1)	返品数量	-
goods.*.return_type	?string (*1)	在庫補充モード	-

• *1) action: CREATEの場合必須
• *2) action: UPDATE DELETEの場合必須

例

• Request

PUT /ec/orders/return_orders/9

{
  "staff_id": 1,
  "note": null,
  "goods": [
    {
      "action": "UPDATE",
      "id": 10,
      "quantity": 2
    }
  ]
}

• Response

返品検索のresponse[0]と同様

返品削除

概要

• 既存の返品ケースを削除する

基本情報

• リクエストパス: DELETE /ec/orders/return_orders/{ec_return_order_id}
• JWTスコープ: ec:order:return_order:destroy
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

例

• Request

DELETE /ec/orders/return_orders/9

• Response

なし

返品確定

概要

• 既存の返品ケースを確定させる

基本情報

• リクエストパス: PUT /ec/orders/return_orders/{ec_return_order_id}/checkout
• JWTスコープ: ec:order:return_order:checkout:update
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

例

• Request

PUT /ec/orders/return_orders/9/checkout

• Response

返品検索のresponse[0]と同様