Cancel Return Order

POST

https://sandbox-api.shipbob.com/2.0/return/:id/cancel

POST

/2.0/return/:id/cancel

$ curl -X POST https://sandbox-api.shipbob.com/2.0/return/1/cancel \
>      -H "shipbob_channel_id: 1" \
>      -H "Authorization: Bearer <token>"

1 {
2   "channel": {
3     "id": 0,
4     "name": "ShipBobs-Shopify-Store"
5   },
6   "completed_date": "2019-08-24T14:15:22+00:00",
7   "customer_name": "string",
8   "fulfillment_center": {
9     "id": 0,
10     "name": "Cicero (IL)"
11   },
12   "id": 0,
13   "insert_date": "2019-08-24T14:15:22+00:00",
14   "inventory": [
15     {
16       "action_requested": {
17         "action": 0,
18         "action_type": "InventoryDefault",
19         "instructions": "string"
20       },
21       "action_taken": [
22         {
23           "action": 0,
24           "action_reason": "string",
25           "lot_information": [
26             {
27               "expiration_date": "2019-08-24T14:15:22+00:00",
28               "lot_number": "string",
29               "quantity_processed": 0
30             }
31           ],
32           "quantity_processed": 1
33         }
34       ],
35       "id": 0,
36       "name": "string",
37       "quantity": 0
38     }
39   ],
40   "invoice_amount": 0.1,
41   "original_shipment_id": 0,
42   "reference_id": "string",
43   "return_type": "Regular",
44   "status": "AwaitingArrival",
45   "store_order_id": "string",
46   "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC",
47   "transactions": [
48     {
49       "amount": 2.5,
50       "transaction_type": "ReturnLabelInvoice"
51     }
52   ]
53 }

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Path parameters

idintegerRequired

Id of the return order

Response

Success

channelobject

completed_datedatetime or null

customer_namestring or null

fulfillment_centerobject

idinteger

insert_datedatetime

inventorylist of objects or null

invoice_amountdouble or null

original_shipment_idinteger or null

reference_idstring or null

return_typeenum

Regular ReturnToSender

statusenum

AwaitingArrival Arrived Processing Completed Cancelled

store_order_idstring or null

tagslist of objects or null

tracking_numberstring or null

transactionslist of objects or null

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Response

Errors