Cancellations API integration (Recommended)
When your eCommerce order management system receives a cancellation event, your system should call the Usizy API to confirm the cancellation event as an HTTP POST, to the following URL: https://usizy.com/api/v2/event/cancel
Essential variables
The following variables should be included into your call:
api_key
Clients should authenticate by passing the api key in the “Authorization” HTTP header, prepended with the string “Api-Key”.
For example:
Authorization: Api-Key 401f7ac837da42b97f
Please contact Usizy to confirm the specific api_key that should be included within this variable.
The same API key will work for the confirmation, cancellation, or returns integration.
order_id
The order identifier must be the same as the one provided during the purchase confirmation.
product_ids
Each product identifier must be the same as its corresponding one provided during the purchase confirmation. This variable may contain a single value or multiple ones, depending on the circumstances of the initial order.
variation_ids
Each variation id must be unique for its corresponding specific item. It is recommended to use the SKU. If more than one product is cancelled within a single order, you must include a list of variations, for each product cancelled within that specific order.
date
Date or date time of cancellation event, format ISO 8601 (“2017-09-12” or “2017-09-12T15:48:02Z”).
Recommended variables
ecomm_size
Size originally ordered during purchase. This field is useful when multiple cancellations are requested for the same product within a single order. The number of sizes included must match the number of products cancelled. If more than one product is cancelled, the values must be comma-separated.
OpenAPI documentation
We have an OpenAPI spec with documentation developer oriented check this link.
Cancellations integration API example
A typical API calls can be viewed here: Cancellations integration API example