Appearance
Cancel Order API
Endpoint
POST /order/{orderId}/cancel
Headers
| Key | Value |
|---|---|
| Authorization | Bearer change_to_your_access_token |
| X-S2-Organization | 95d73baf-76ba-4bea-86ac-1534c5e5d4aa |
Response Example
- Success
json
{
"id": "2fe75f59-9141-4aa7-a00d-90defe870888",
"organization": {
"id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
"name": "test organization",
"createdAt": "2024-03-05T22:17:23.520948Z",
"updatedAt": "2024-04-09T21:15:15.615765Z"
},
"account": {
"id": "1ac48942-405a-4841-a7d8-708f50888888",
"organization": {
"id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
"name": "test organization",
"createdAt": "2024-03-05T22:17:23.520948Z",
"updatedAt": "2024-04-09T21:15:15.615765Z"
},
"name": "test organization",
"type": "MARKETPLACE_GENERIC",
"autoAssignOrdersToWarehouse": null,
"createdAt": "2024-04-11T02:52:03.791286Z",
"updatedAt": "2024-04-11T02:52:03.791286Z"
},
"accountSubChannel": null,
"channelOrderId": "896-7715607-1523888",
"channelOrderIdAlt": null,
"channelOrderIdAlt2": "432745a6-f1be-4e6d-89c5-857617888888",
"channelShippingMethod": "Priority",
"shippingAddress": {
"name": "Devin Test",
"company": "test company",
"address1": "123 Main St",
"address2": "",
"city": "San Francisco",
"state": "CA",
"postalCode": "94888",
"countryId": "US",
"phone": "(818) 615-8888",
"email": "test@sellersoft.com"
},
"shippingOverrideAddress": null,
"billingAddress": {
"name": "Devin Test",
"company": "test company",
"address1": "123 Test St",
"address2": "",
"city": "San Francisco",
"state": "CA",
"postalCode": "94888",
"countryId": "US",
"phone": "(312) 617-8888 x8888",
"email": "test@sellersoft.com"
},
"meta": {},
"channelOrderDate": "2024-04-22T08:01:47.609Z",
"status": "CANCELLED",
"assignStatus": "PENDING",
"archived": false,
"currencyId": "EUR",
"items": [
{
"channelOrderItemId": "b4fbfa4c-f08e-4a25-80cc-efcdac19a888",
"product": {
"id": "f4053402-e79b-45c2-8621-377d28060888",
"organization": {
"id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
"name": "test organization",
"createdAt": "2024-03-05T22:17:23.520948Z",
"updatedAt": "2024-04-09T21:15:15.615765Z"
},
"sku": "TEST-BLACK",
"brand": {
"id": "5643b7ee-7df1-48c6-b690-1e29ffa8a888",
"name": "",
"nameNormalized": "",
"createdAt": "2024-03-05T22:17:28.679732Z"
},
"gtin": "8711600010",
"name": "SKU Black",
"remarks": "",
"imageMain": "",
"packageLengthMm": 1470.0,
"packageWidthMm": 310.0,
"packageHeightMm": 790.0,
"shippingWeightKg": 34.0,
"caseUnit": "EACH",
"casePack": 0,
"caseLengthMm": 0.0,
"caseWidthMm": 0.0,
"caseHeightMm": 0.0,
"caseWeightKg": 0.0,
"condition": "NEW",
"serialNumberRequired": false,
"expiryDateRequired": false,
"unknown": false,
"createdAt": "2024-03-05T22:20:44.087204Z",
"updatedAt": "2024-03-05T22:20:44.087204Z",
"otherIds": []
},
"quantity": 5,
"unitPrice": 89.27,
"meta": {}
},
{
"channelOrderItemId": "7b321899-f5de-405f-8be8-2bc6f3d8a888",
"product": {
"id": "bab7c35b-2ecb-4b40-be82-8dc1e0a86888",
"organization": {
"id": "3f424caf-0eba-4813-b3e7-7ca0393a8888",
"name": "test organization",
"createdAt": "2024-03-05T22:17:23.520948Z",
"updatedAt": "2024-04-09T21:15:15.615765Z"
},
"sku": "SKU-GREY",
"brand": {
"id": "5643b7ee-7df1-48c6-b690-1e29ffa8a888",
"name": "",
"nameNormalized": "",
"createdAt": "2024-03-05T22:17:28.679732Z"
},
"gtin": "",
"name": "SKU GREY",
"remarks": "",
"imageMain": "",
"packageLengthMm": 1500.0,
"packageWidthMm": 260.0,
"packageHeightMm": 810.0,
"shippingWeightKg": 35.0,
"caseUnit": "CARTON",
"casePack": 1,
"caseLengthMm": 0.0,
"caseWidthMm": 0.0,
"caseHeightMm": 0.0,
"caseWeightKg": 0.0,
"condition": "NEW",
"serialNumberRequired": false,
"expiryDateRequired": false,
"unknown": false,
"createdAt": "2024-03-05T22:20:44.132006Z",
"updatedAt": "2024-04-01T14:31:19.885955Z",
"otherIds": []
},
"quantity": 3,
"unitPrice": 17.71,
"meta": {}
},
{
"channelOrderItemId": "4d435f34-dad6-4e53-b2c6-12713b18e888",
"product": {
"id": "f4053402-e79b-45c2-8621-377d28060888",
"organization": {
"id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
"name": "test organization",
"createdAt": "2024-03-05T22:17:23.520948Z",
"updatedAt": "2024-04-09T21:15:15.615765Z"
},
"sku": "TEST-BLACK",
"brand": {
"id": "5643b7ee-7df1-48c6-b690-1e29ffa8a888",
"name": "",
"nameNormalized": "",
"createdAt": "2024-03-05T22:17:28.679732Z"
},
"gtin": "8788888888",
"name": "SKU Black",
"remarks": "",
"imageMain": "",
"packageLengthMm": 1470.0,
"packageWidthMm": 310.0,
"packageHeightMm": 790.0,
"shippingWeightKg": 34.0,
"caseUnit": "EACH",
"casePack": 0,
"caseLengthMm": 0.0,
"caseWidthMm": 0.0,
"caseHeightMm": 0.0,
"caseWeightKg": 0.0,
"condition": "NEW",
"serialNumberRequired": false,
"expiryDateRequired": false,
"unknown": false,
"createdAt": "2024-03-05T22:20:44.087204Z",
"updatedAt": "2024-03-05T22:20:44.087204Z",
"otherIds": []
},
"quantity": 8,
"unitPrice": 72.68,
"meta": {}
},
{
"channelOrderItemId": "c88ee801-6ee1-4169-af38-e8c4400f2888",
"product": {
"id": "bab7c35b-2ecb-4b40-be82-8dc1e0a86888",
"organization": {
"id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
"name": "test organization",
"createdAt": "2024-03-05T22:17:23.520948Z",
"updatedAt": "2024-04-09T21:15:15.615765Z"
},
"sku": "SKU-GREY",
"brand": {
"id": "5643b7ee-7df1-48c6-b690-1e29ffa8ab33",
"name": "",
"nameNormalized": "",
"createdAt": "2024-03-05T22:17:28.679732Z"
},
"gtin": "",
"name": "SKU GREY",
"remarks": "",
"imageMain": "",
"packageLengthMm": 1500.0,
"packageWidthMm": 260.0,
"packageHeightMm": 810.0,
"shippingWeightKg": 35.0,
"caseUnit": "CARTON",
"casePack": 1,
"caseLengthMm": 0.0,
"caseWidthMm": 0.0,
"caseHeightMm": 0.0,
"caseWeightKg": 0.0,
"condition": "NEW",
"serialNumberRequired": false,
"expiryDateRequired": false,
"unknown": false,
"createdAt": "2024-03-05T22:20:44.132006Z",
"updatedAt": "2024-04-01T14:31:19.885955Z",
"otherIds": []
},
"quantity": 3,
"unitPrice": 87.52,
"meta": {}
},
{
"channelOrderItemId": "14e1290f-001a-47ee-9994-c91312665888",
"product": {
"id": "440352eb-241a-4cac-834f-e0980ffca888",
"organization": {
"id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
"name": "test organization",
"createdAt": "2024-03-05T22:17:23.520948Z",
"updatedAt": "2024-04-09T21:15:15.615765Z"
},
"sku": "MX03-N-BLUE",
"brand": {
"id": "5643b7ee-7df1-48c6-b690-1e29ffa8a888",
"name": "",
"nameNormalized": "",
"createdAt": "2024-03-05T22:17:28.679732Z"
},
"gtin": "",
"name": "SKU Blue",
"remarks": "",
"imageMain": "",
"packageLengthMm": 1500.0,
"packageWidthMm": 260.0,
"packageHeightMm": 810.0,
"shippingWeightKg": 34.0,
"caseUnit": "CARTON",
"casePack": 1,
"caseLengthMm": 0.0,
"caseWidthMm": 0.0,
"caseHeightMm": 0.0,
"caseWeightKg": 0.0,
"condition": "NEW",
"serialNumberRequired": false,
"expiryDateRequired": false,
"unknown": false,
"createdAt": "2024-03-05T22:20:44.106742Z",
"updatedAt": "2024-04-01T14:31:19.875675Z",
"otherIds": []
},
"quantity": 7,
"unitPrice": 64.98,
"meta": {}
}
],
"attachments": [],
"fulfillments": [
{
"id": "4930dcbe-56f8-4807-991f-13cdbd3ac888",
"status": "CANCELLED",
"address": {
"name": "Devin Cole and Sons",
"company": "Haley-Franecki",
"address1": "123 Main St",
"address2": "",
"city": "San Francisco",
"state": "CA",
"postalCode": "94103",
"countryId": "US",
"phone": "(818) 615-8448",
"email": "test@sellersoft.com"
},
"channelFulfillmentId": null,
"meta": {},
"warehouse": {
"id": "9cae310d-c440-4d78-bdc0-bf306ec33888",
"organization": {
"id": "e8b021f4-9ab3-4fc2-af71-f35930759888",
"name": "Generation Delivery Inc.",
"createdAt": "2024-04-01T14:09:14.732646Z",
"updatedAt": "2024-04-09T21:15:15.615765Z"
},
"name": "test warehouse",
"address": {
"name": "GDI",
"company": "",
"address1": "test warehouse Rd Unit 3",
"address2": "",
"city": "Oakville",
"state": "ON",
"postalCode": "L6L 2X8",
"countryId": "CA",
"phone": "",
"email": ""
},
"dropshipper": true,
"fulfillmentCenter": true,
"rmaCenter": true,
"unitSystem": "METRIC",
"createdAt": "2024-04-01T14:18:10.903581Z",
"updatedAt": "2024-04-01T14:18:10.903581Z"
},
"warehousePickId": "c5939cc6-373b-4a16-8ea4-b0ce86ba9888",
"shippingMethod": "Priority",
"items": [
{
"product": {
"id": "440352eb-241a-4cac-834f-e0980ffca888",
"organization": {
"id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
"name": "test organization",
"createdAt": "2024-03-05T22:17:23.520948Z",
"updatedAt": "2024-04-09T21:15:15.615765Z"
},
"sku": "MX03-N-BLUE",
"brand": {
"id": "5643b7ee-7df1-48c6-b690-1e29ffa8a888",
"name": "",
"nameNormalized": "",
"createdAt": "2024-03-05T22:17:28.679732Z"
},
"gtin": "",
"name": "SKU Blue",
"remarks": "",
"imageMain": "",
"packageLengthMm": 1500.0,
"packageWidthMm": 260.0,
"packageHeightMm": 810.0,
"shippingWeightKg": 34.0,
"caseUnit": "CARTON",
"casePack": 1,
"caseLengthMm": 0.0,
"caseWidthMm": 0.0,
"caseHeightMm": 0.0,
"caseWeightKg": 0.0,
"condition": "NEW",
"serialNumberRequired": false,
"expiryDateRequired": false,
"unknown": false,
"createdAt": "2024-03-05T22:20:44.106742Z",
"updatedAt": "2024-04-01T14:31:19.875675Z",
"otherIds": []
},
"channelFulfillmentItemId": null,
"quantity": 7,
"meta": {}
},
{
"product": {
"id": "bab7c35b-2ecb-4b40-be82-8dc1e0a86888",
"organization": {
"id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
"name": "test organization",
"createdAt": "2024-03-05T22:17:23.520948Z",
"updatedAt": "2024-04-09T21:15:15.615765Z"
},
"sku": "SKU-GREY",
"brand": {
"id": "5643b7ee-7df1-48c6-b690-1e29ffa8a888",
"name": "",
"nameNormalized": "",
"createdAt": "2024-03-05T22:17:28.679732Z"
},
"gtin": "",
"name": "SKU GREY",
"remarks": "",
"imageMain": "",
"packageLengthMm": 1500.0,
"packageWidthMm": 260.0,
"packageHeightMm": 810.0,
"shippingWeightKg": 35.0,
"caseUnit": "CARTON",
"casePack": 1,
"caseLengthMm": 0.0,
"caseWidthMm": 0.0,
"caseHeightMm": 0.0,
"caseWeightKg": 0.0,
"condition": "NEW",
"serialNumberRequired": false,
"expiryDateRequired": false,
"unknown": false,
"createdAt": "2024-03-05T22:20:44.132006Z",
"updatedAt": "2024-04-01T14:31:19.885955Z",
"otherIds": []
},
"channelFulfillmentItemId": null,
"quantity": 6,
"meta": {}
},
{
"product": {
"id": "f4053402-e79b-45c2-8621-377d28060888",
"organization": {
"id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
"name": "test organization",
"createdAt": "2024-03-05T22:17:23.520948Z",
"updatedAt": "2024-04-09T21:15:15.615765Z"
},
"sku": "TEST-BLACK",
"brand": {
"id": "5643b7ee-7df1-48c6-b690-1e29ffa8a888",
"name": "",
"nameNormalized": "",
"createdAt": "2024-03-05T22:17:28.679732Z"
},
"gtin": "8711600010",
"name": "SKU Black",
"remarks": "",
"imageMain": "",
"packageLengthMm": 1470.0,
"packageWidthMm": 310.0,
"packageHeightMm": 790.0,
"shippingWeightKg": 34.0,
"caseUnit": "EACH",
"casePack": 0,
"caseLengthMm": 0.0,
"caseWidthMm": 0.0,
"caseHeightMm": 0.0,
"caseWeightKg": 0.0,
"condition": "NEW",
"serialNumberRequired": false,
"expiryDateRequired": false,
"unknown": false,
"createdAt": "2024-03-05T22:20:44.087204Z",
"updatedAt": "2024-03-05T22:20:44.087204Z",
"otherIds": []
},
"channelFulfillmentItemId": null,
"quantity": 13,
"meta": {}
}
],
"createdAt": "2024-06-03T03:40:41.743844Z",
"updatedAt": "2024-06-04T06:12:20.547434Z",
"attachments": [],
"shipments": [],
"orderOrganization": {
"id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
"name": "test organization",
"createdAt": "2024-03-05T22:17:23.520948Z",
"updatedAt": "2024-04-09T21:15:15.615765Z"
},
"shipByDate": null,
"deliverByDate": null,
"customerNote": "24c91e80-eb65-4766-aa69-0a344250b888",
"referenceIds": ["432745a6-f1be-4e6d-89c5-857617e13820", "896-7715607-1523760"],
"orderId": "2fe75f59-9141-4aa7-a00d-90defe87006f",
"orderDate": "2024-04-22T08:01:47.609Z",
"orderAccountId": "1ac48942-405a-4841-a7d8-708f50dbe888",
"orderChannelOrderId": "896-7715607-1523760"
}
],
"createdAt": "2024-04-25T06:21:49.488547Z",
"updatedAt": "2024-06-04T06:17:33.730137Z",
"shipByDate": null,
"deliverByDate": null,
"customerNote": "24c91e80-eb65-4766-aa69-0a344250b888"
}- Failed
Status Code: 400 Bad Request
json
{
"message": "Order is already assigned, can not be cancelled"
}