Cancel Sales Order
DESCRIPTION
This API is used to cancel a complete sales order from Customer’s system to Alliance Cloud
REQUEST
Method: POST
Content-Type: application/json
URL:
| Test Environment: | https://testsalesapi.logiztikalliance.com/order/cancel |
| Production Environment: | https://salesapi.logiztikalliance.com/order/cancel |
API Test Environment Access
To access the API test environment, please contact our Customer Service team at customerservice.ec@logiztikalliance.com. Be sure to include the IP address from which testing will be performed.
Example: 123.123.125.14
INPUT PARAMETERS
| Name | Type | Required | Description |
| apiKey | String (128) | Yes | Alliance cloud security token/ ApiKey |
BODY
| Name | Type | Required | Description |
| idOrder | int | Yes | Unique number that identifies the purchase order. |
RESPONSE SUCCESS
| Name | Type | Description |
| error | String | Represents a string in which the service response will be detailed. |
| status | String | This field will have only two types of responses: 1 which will mean that everything was successful and 0 when an error has occurred. |
EXAMPLE
BODY
{
"idOrder": "123456"
}RESPONSE
{
"error": "Cancel successfully processed: 2",
"status": "1"
}ERROR MESSAGES
Order does not exist
{
"error": "Order does not exist",
"status": "0"
}Boxes status Dispatched WH
{
"error": "Boxes not available: 2 DISPATCHED WH (XX356783596, XX356783605)",
"status": "0"
}Boxes with label printed or picked
{
"error": " Boxes not available: 2 - Pieces ER433835387, ER433835388 have already had label printed or have been picked cannot be canceled.",
"status": "0"
}Boxes status Received WH
{
"error": " Boxes not available: 2 RECEIVED (XX4587895412, XX4587895413)",
"status": "0"
}Mixed Order – Boxes In&Out Received WH and boxes Inventory with label printed or picked
{
"error": " Boxes not available: 6 - RECEIVED: NR434384208, NR434384210, NR434384209 - Pieces NR434004613, NR434065275, NR434065276 have already had label printed or have been picked cannot be canceled. ",
"status": "0"
}Syntax Error
"idOrder": "",
{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"errors": {
"inventarioRequest": [
"The idOrder field is required."
],
"$.idOrder": [
"',' is an invalid start of a value. Path: $.idOrder | LineNumber: 2 | BytePositionInLine: 3."
]
},
"traceId": "00-f838cdaef47b71de65478ac3eb350304-0dd97001e6c63f30-00"
}