Barcode Information
DESCRIPTION
The customer can use this API to get detailed information on each box.
Request
Method: GET
Content-Type: application/json
URL:
| Test Environment: | https://training.logiztikalliance.com:5005/logCloudWSPre/api/v2/ClientesExternosA/ListarCodigosDeBarraPorCliente/{CUSTOMERCODE}/{SHIPMENTNR} |
| Production Environment: | https://cloud.logiztikalliance.com:5005/logCloudWS/api/v2/ClientesExternosA/ListarCodigosDeBarraPorCliente/{CUSTOMERCODE}/{SHIPMENTNR} |
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 |
| customerCode | String (50) | Yes | Customer code. |
| shipmentNr | String (50) | Yes | Shipment number. |
| authenticationToken | String (128) | Yes | Alliance cloud security token (Api Key). |
RESPONSE
BODY
| Name | Type | Required | Description |
| barcode | string (16) | Yes | Barcode number that was shipped on the specific shipment. |
| length | decimal(9,3) | No | Length of the piece. |
| width | decimal(9,3) | No | Width of the piece. |
| height | decimal(9,3) | No | Height of the piece. |
| unitOfMeasurement | string (16) | Yes | Unit of measure for the dimensions, CM or INCH. |
| grossWeight | decimal(9,3) | No | Gross weight of the piece. |
| volumeWeight | decimal(9,3) | No | Volume weight of the piece. |
| shipmentMeasureVolume | boolean | Yes | True if the shipment was charged by volume weight, false if the shipment was charged by gross weight. |
| productCode | string(32) | No | Product category code (ex. ROS for roses). |
| productDescription | string(128) | No | Product variety, whatever text the customer or the supplier sent us. |
| packing | int | No | Number of units in the box. |
| piecePrice | decimal(9,3) | No | Supplier price of the box. |
| supplierDeliveryDate | datetime(yyyy-MM-dd HH:mm:ss) | No | Supplier delivery date and time. |
| boxSize | string(16) | Yes | Box type (e.g. FB, HB, QB…) |
OUTPUT ERROR MESSAGES
Wrong token:
“Unauthorized”
Error in customer code:
{
“error”: “The ApiKey does not have access to that customer code”
}
Error in shipment number:
{
“error”: “The shipment number does not contain pieces of the customer.”
}
Missing parameters:
{
“error”: “Missing input parameters. Please send Authentication Token, Shipment Number and Customer Code. ”
}
EXAMPLE
[
{
"barcode": "12202603312",
"length": 103.0,
"width": 30.0,
"height": 13.0,
"unitOfMeasurement": "CM",
"grossWeight": 6.695,
"volumeWeight": 7.695,
"ShipmentMeasureVolume": true,
"productCode": "ROS",
"productDescription": "IMPACT 50CM X2 25ST FL",
"packing": 120,
"piecePrice": 10.3,
"supplierDeliveryDate": "2024-10-07 12:56:47.967",
"boxSize": "HB"
},
{
"barcode": "12202603313",
"length": 113.0,
"width": 35.0,
"height": 16.0,
"unitOfMeasurement": "CM",
"grossWeight": 6.955,
"volumeWeight": 6.695,
"ShipmentMeasureVolume": true,
"productCode": "ROS",
"productDescription": "IMPACT 60CM X2 25ST FL",
"packing": 120,
"piecePrice": 11.3,
"supplierDeliveryDate": "2024-10-07 12:56:47.967",
"boxSize": "HB"
}
]
OUTPUT ERROR MESSAGES
Wrong token:
“Unauthorized”
Error in customer code:
{
“error”: “The ApiKey does not have access to that customer code”
}
Error in shipment number:
{
“error”: “The shipment number does not contain pieces of the customer.”
}
Missing parameters:
{
“error”: “Missing input parameters. Please send Authentication Token, Shipment Number and Customer Code. ”
}