Cancel Inventory Sale


 DESCRIPTION

Web Service for cancel sales.

Request

Method: POST

Content-Type: application/json

URL:

Test Environment: https://training.logiztikalliance.com:5005/logCloudWSSprint/api/v2/integration/cancelSale
Production Environment: https://cloud.logiztikalliance.com:5005/logCloudWS/api/v2/integration/cancelSale
INPUT PARAMETERS
Name Type Required Description
AuthenticationToken string(50) (Required) Yes Alliance cloud security token (Api Key).
Body
Name Type Required Description
house string(16) Yes The house number.
barcodes string array Yes Barcode list.
Barcode number, has to be a unique number per box, maximum 11 digits long. Logiztik Alliance Group provides a 2-letter prefix that should be used together with an alphanumeric sequential.
EXAMPLE
[
    {
      “house”: “LA01010101”,
      “barcodes”: [
        “SU000000001”,
        “SU000000002”,
        “SU000000003”,
        “SU000000004”
      ]
    }
  ]
Response

 

Output Success

 

BODY

Name Type Description
isSuccess boolean Output Success (True).
message string(150) Message Success.
error object error  

EXAMPLE

{
  “isSuccess”: true,
  “message”: “Venta cancelada con éxito”,
  “error”: null
}
 
Output Error

 

BODY

Name Type Description
isSuccess boolean Output Error (False).
message string(150) In case of an error, we return the error message in this field.
error object error Errors list
house string(16) The house number.
message string(150) In case of an error, we return the error message in this field.

EXAMPLE

{
    “isSuccess”: false,
    “message”: null,
    “error”: [
        {
            “house”: “LA01010101”,
            “message”: “The House LA01010101 does not exist in the agency”
        }
    ]
}
 
ERRORS MESSAGES

 

THE HOUSE DOES NOT EXIST IN THE AGENCY
{
    “isSuccess”: false,
    “message”: null,
    “error”: [
        {
            “house”: “LA01010101”,
            “message”: “The House LA01010101 does not exist in the agency”
        }
    ]
}
THE HOUSE BELONGS TO THE SHIPMENT WITH SHIPMENT DATE
{
    “isSuccess”: false,
    “message”: null,
    “error”: [
        {
            “house”: “LA2083375275”,
            “message”: “The House LA2083375275 belongs to the shipment LOG-0065 7461 with shipment date in the past Fri, 26 Aug 2022”
        }
    ]
}
UNAUTHORIZED

401 Unauthorized