Process Return
PUT
{{api_url}}/shop/amazontoday/order/return?amazon_today_order_id=111-1111111-1111113&sku=ABC&quantity=1&return_condition=1This call processes a return for an Amazon Today order. One of the following three query params are required to match the return:
- amazon_today_order_id
- amazon_today_shipment_id
- infiplex_order_id
If no matching order is found, nothing will be returned.
The SKU and quantity sent must match the return from Amazon or the return will not be processed
Return Condition (return_condition) is optional (default is 1: Sellable). Valid values and their meaning:
- 1: Sellable
- 2: Defective
- 3: CustomerDamaged
- 4: CarrierDamaged
Authorization
Bearer token, sent in the Authorization header. Inherited from the collection.
Query Parameters
| Key | Value | Description |
|---|---|---|
amazon_today_shipment_id optional | Process return by Amazon Today Shipment ID | |
infiplex_order_id optional | Process return by InfiPlex Order ID | |
amazon_today_order_id | 111-1111111-1111113 | Process return by Amazon Today Order ID |
sku | ABC | The SKU for the return |
quantity | 1 | The quantity to be returned |
return_condition | 1 | The condition of the return. This is a numeric value and not a string. If nothing is sent, a value of "1" is used. Valid Values: 1: Sellable 2: Defective 3: CustomerDamaged 4: CarrierDamaged |
Example Request
curl --location --request PUT '{{api_url}}/shop/amazontoday/order/return?amazon_today_order_id=111-1111111-1111113&sku=ABC&quantity=1&return_condition=1' \
--header 'Authorization: Bearer {{auth_token}}'Example Responses
Process Return
Request
curl --location --request PUT 'https://example.com/api/admin/shop/amazontoday/order/return?amazon_today_order_id=111-1111111-1111113&sku=ABC&quantity=1&return_condition=1' \
--header 'Authorization: Bearer YOUR_API_KEY'Response
{
"info": "Return successful"
}