Warehouse API
Cancel/Refund Order in Cart
This will attempt to cancel/refund orders with the originating order source/cart by specifying Shipment and Line items to cancel/refund. The cart's response will be returned. Not all carts support this functionality.
You may also find the Cancel/Refund Order Logs API endpoint useful to lookup previous cancellation requests. <br/><br/> Note: This call may take longer than others because CartRover will reach out to the shopping cart in real time and wait for a response. <br/> <br/> Note: API calls are limited to 10 orders per API Call.
Request
Array Request Fields
| Field Name | Data Type | Length | Required? | Description |
|---|---|---|---|---|
| cust_ref | String | 16 | Y | Unique Order Number |
| cancel_order | Boolean | Y | Set TRUE to cancel order | |
| refund_note | String | Reasons to refund order | ||
| cancel_note | String | Reasons to cancel order | ||
| merchant_pk | Int | Y | CartRover merchant ID. See List Merchants | |
| shipment | Array | Y | Array that contains shipment refund information | |
| items | Array | Array that contains detailed order items refund/cancellation |
Shipment Array Fields
| Field Name | Data Type | Length | Required? | Description |
|---|---|---|---|---|
| full_shipping_refund | Boolean | Y | Set TRUE to refund all shipping/handling fees | |
| refund_amount | Float | Required if full_shipping_refund is set to FALSE | Specify shipment refund amount. Refund_amount cannot exceed total shipping/handling fees. |
Items Array Fields
| Field Name | Data Type | Length | Required? | Description |
|---|---|---|---|---|
| sku | String | Y | Unique sku that represents a product in an order | |
| cancel_quantity | Int | Y | Qty of the product to be refunded/cancelled |
Response
Array Response Fields
| Field Name | Data Type | Length | Description |
|---|---|---|---|
| Orders | Array | detailed API response of each order |
Orders Array Fields
| Field Name | Data Type | Length | Description |
|---|---|---|---|
| cust_ref | String | Unique Order Number | |
| order_cancel_success | Boolean | Order cancellation/refund status. TRUE represent success. | |
| server_response | String | Detailed API response message. Normally contains error messages if Carts API request failed. |
post/v1/wms/orders/cart_cancel
Request
- Base URLhttp://{{base_url}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
Content-Typestring
Request body */*
string required
Example request
"\"[\\n {\\n \\\"cust_ref\\\" : \\\"TEST01\\\",\\n \\\"merchant_pk\\\" : 2319,\\n \\\"cancel_order\\\" : true,\\n \\\"shipment\\\" : {\\n \\\"full_shipping_refund\\\": true\\n }\\n },\\n {\\n \\\"cust_ref\\\" : \\\"TEST99\\\",\\n \\\"merchant_pk\\\" : 2319,\\n \\\"cancel_order\\\" : true,\\n \\\"shipment\\\" : {\\n \\\"full_shipping_refund\\\": true\\n }\\n }\\n]\""Response
OK
object required
Changes
No recorded changes to this operation across all 1 revision of this API.