Custom Integration
Recustomer API for Return and Cancel v2
Introduction
Custom Integration は、Recustomer を利用するために必要な各種データを、マーチャントのシステムと Recustomer の間で連携するための API です。
通信の向きによって、次の 3 種類に分かれます。
| 種類 | 向き | エンドポイントを用意する側 | 認証 |
|---|---|---|---|
| Recustomer API | マーチャント → Recustomer | Recustomer | 管理画面で発行した API トークンを、マーチャントが送る |
| マーチャントが用意する API | Recustomer → マーチャント | マーチャント | マーチャントが用意したトークンを、Recustomer が送る |
| Webhook | Recustomer → マーチャント（通知） | マーチャント | Recustomer が通知に署名する（X-Recustomer-Signature-256） |
それぞれの説明と認証の方法は、各区切りの「概要」のページにあります。
機能ごとに使う API
どの機能も、注文情報が Recustomer に入っていることが前提です。Import Order で注文情報を送ってください。
マーチャントが用意する API と Webhook は、使う機能のぶんだけ用意します。Recustomer は、管理画面で設定したものだけを呼び出します。
| 機能 | マーチャントが用意する API | Webhook |
|---|---|---|
| 返品 | なし | Return Order Webhook |
| 交換 | Get Product Variants：交換先の商品のバリエーションと在庫を取得する。用意しない場合、交換は同じバリエーションへの交換だけになる Create Exchange Order：交換商品の受注伝票を作成する。交換伝票を Recustomer から作成する場合に用意する |
Return Order Webhook |
| キャンセル | Cancel Order：Recustomer がキャンセルを承認した注文の出荷を止める | なし |
| 配送追跡 | なし | Shipping Status Webhook |
データフォーマット
- country_code (国コード) : https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
エンドポイント一覧
| メソッド | パス | 概要 |
|---|---|---|
| Recustomer APIマーチャント → Recustomer | ||
| POST | /api/v1/orders/import | Import Order |
| マーチャントが用意する APIRecustomer → マーチャント | ||
| GET | /products/{product_id} | Get Product Variants |
| POST | /orders | Create Exchange Order |
| POST | /orders/cancel | Cancel Order |
| WebhookRecustomer → マーチャント（通知） | ||
| POST | /{your_shipping_endpoint} | Shipping Status Webhook |
| POST | /{your_return_order_endpoint} | Return Order Webhook |
© Recustomer, Inc.