Custom Integration
Recustomer API for Return and Cancel v2
Introduction
Custom Integration is an API for exchanging the data Recustomer needs to work between the merchant's system and Recustomer.
It has three kinds of endpoints, depending on the direction of the call.
| Kind | Direction | Who provides the endpoint | Authentication |
|---|---|---|---|
| Recustomer API | Merchant → Recustomer | Recustomer | The merchant sends the API token issued in the admin console |
| Merchant-hosted API | Recustomer → Merchant | Merchant | Recustomer sends the token that the merchant provided |
| Webhooks | Recustomer → Merchant (notification) | Merchant | Recustomer signs the notification (X-Recustomer-Signature-256) |
See the "Overview" page of each kind for its details and how to authenticate.
APIs used by each feature
Every feature requires the order information to be in Recustomer. Send it with Import Order.
Provide the merchant-hosted API and webhooks only for the features you use. Recustomer calls only what is configured in the admin screen.
| Feature | Merchant-hosted API | Webhooks |
|---|---|---|
| Returns | None | Return Order Webhook |
| Exchanges | Get Product Variants: retrieves the variants and stock of the product to exchange for. Without it, exchanges are limited to the same variant Create Exchange Order: creates the order slip for the exchange item. Provide it if Recustomer should create exchange slips |
Return Order Webhook |
| Cancellation | Cancel Order: stops shipping an order whose cancellation Recustomer approved | None |
| Tracking | None | Shipping Status Webhook |
Data formats
- country_code (country code): https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
Endpoints
| Method | Path | Summary |
|---|---|---|
| Recustomer APIMerchant → Recustomer | ||
| POST | /api/v1/orders/import | Import Order |
| Merchant-hosted APIRecustomer → Merchant | ||
| GET | /products/{product_id} | Get Product Variants |
| POST | /orders | Create Exchange Order |
| POST | /orders/cancel | Cancel Order |
| WebhooksRecustomer → Merchant (notification) | ||
| POST | /{your_shipping_endpoint} | Shipping Status Webhook |
| POST | /{your_return_order_endpoint} | Return Order Webhook |
© Recustomer, Inc.