EDI Local Deliveries – Miami


DESCRIPTION

Web Service for EDI for Local Order Deliveries.

Request

Method: POST

Content-Type: application/json

URL:

Test Environment:https://training.logiztikalliance.com:5005/logCloudWSSprint/api/OrdenesLocales/InsertarEdiOrdenesLocalesQueue/{TOKEN}
Production Environment:https://cloud.logiztikalliance.com:5005/logCloudWS/api/OrdenesLocales/InsertarEdiOrdenesLocalesQueue/{TOKEN}
INPUT PARAMETERS
NameTypeRequiredDescription
AuthenticationTokenstring(50) (Required)YesAlliance cloud security token (Bearer Token).
Body
NameTypeRequiredDescription
ShipdateDateTime(MM/dd/yy)YesDelivery Date in the following format: mm/dd/yy.
Shipperstring(32)YesUnique ID given to the shipper.
BarcodeAccountstring(32)YesIs the code of the warehouse, where the goods are being delivered, please use DGG at the moment.  
ShipdateOriginalDateTime(yyyy-MM-dd HH:mm:ss)NoThis field is not being used.
UnitIDstring(11)YesUnique Barcode number, max. 11 digits and min. 7 digits and cannot be repeated. Each supplier will be assigned a prefix that should be used for the barcode. 2 digits prefix + 9 digits sequential.
UnitOfMeasurestring(32)NoThis field is not being used.
Measurestring(32)YesSend INCH or CM.
FarmNamestring(32)NoName of the farm.
AWBstring(32)NoShipment number.
Consigneestring(32)YesUnique ID given to the customer.
ClienteFinalstring(32)NoName of ship-to.
Lengthdecimal(9,3)YesLength of the piece in the unit of measure specified in MEASURE. The value must be max. 2 decimals. 
Widthdecimal(9,3)YesWidth of the piece in the unit of measure specified in MEASURE. The value must be max. 2 decimals. 
Heightdecimal(9,3)YesHeight of the piece in the unit of measure specified in MEASURE. The value must be max. 2 decimals. 
Productstring(32)NoUnique ID given to each product category.
ProductDescriptionstring(32)NoName of the exact product variety.
PalletIDstring(32)NoThis field is not being used.
POstring(32)NoPO Number of the piece.
PaymentTypestring(32)NoThis field is not being used.
Commandstring(8)YesUse U or A to insert/ update the UnitID, D to delete the UnitID.
ShipperAccountstring(32)NoThis field is not being used.
Remarksstring(256)NoNotes for operations.
IdClienteFinalstring(32)NoUnique ID given to the ship-to.
Invoicestring(32)NoThis field is not being used.
CreationDateManifiestoDateTime(yyyy-MM-dd HH:mm:ss)NoThis field is not being used.
IdProgCarrierstring(32)NoThis field is not being used.
EXAMPLE
{
    “OrderHeader”: {
      “Shipdate”: “08/11/21”,
      “Shipper”: ” EXP051585″,
      “BarcodeAccount”: “DGG”,
      “ShipdateOriginal”: “0001-01-01T00:00:00”
    },
    “OrderDetail”: [
      {
        “UnitID”: “1991197911”,
        “UnitOfMeasure”: “Box”,
        “Measure”: “Inch”,
        “FarmName”: “SANIMA FLOWERS”,
        “AWB”: “36981126566”,
        “Consignee”: ” CLI0119650″,
        “ClienteFinal”: null,
        “Length”: 41,
        “Width”: 11,
        “Height”: 6,
        “Product”: “ROS”,
        “ProductDescription”: “ROSES”,
        “PalletID”: null,
        “PO”: “”,
        “PaymentType”: “0”,
        “Command”: “A”,
        “ShipperAccount”: null,
        “Remarks”: “”,
        “IdClienteFinal”: null,
        “Invoice”: null,
        “CreationDateManifiesto”: null,
        “IdProgCarrier”: null
      }
    ]
  }
Response

 

Output Success

 

BODY

NameTypeDescription
IsSuccessbooleanTrue = the information was uploaded correctly.
False = the information was not uploaded.
unitIDstring(11)Unique barcode number sent in the EDI.
errorMessagestring(400)In case of an error, we return the error message in this field.

EXAMPLE

[
  {
    “isSucces”: true,
    “unitID”: “1991197999”,
    “errorMessage”: null
  }
]
Output Error

 

BODY

NameTypeDescription
IsSuccessbooleanTrue = the information was uploaded correctly.
False = the information was not uploaded.
unitIDstring(11) Unique barcode number sent in the EDI.
errorMessagestring(400)In case of an error, we return the error message in this field. 

EXAMPLE

[
    {
      “isSucces”: false,
      “unitID”: “1991197999”,
      “errorMessage”: “The UnitID was already used in a different delivery. Please send a unique UnitID.”
    }
]
ERRORS MESSAGES

 

SHIPDATE FORMAT IS INCORRECT

 

[
    {
        “isSuccess”: false,
        “unitID”: null,
        “errorMessage”: “Shipdate format is invalid, please use the following format: mm/dd/yy.”
    }
]
SHIPDATE CANNOT BE IN THE PAST

 

[
    {
        “isSuccess”: false,
        “unitID”: null,
        “errorMessage”: “Shipdate cannot be in the past.”
    }
]
SHIPPER IS INCORRECT

 

[
    {
        “isSuccess”: false,
        “unitID”: null,
        “errorMessage”: “Shipper is incorrect.”
    }
]
THE UNITID WAS ALREADY RECEIVED

 

[
    {
        “isSuccess”: false,
        “unitID”: “1991197911”,
        “errorMessage”: “The UnitID was already used in a different delivery. Please send a unique UnitID.”
    }
]
the unitid is longer than 11 digits

 

[
    {
        “isSuccess”: false,
        “unitID”: “1991197911999”,
        “errorMessage”: “The UnitID is longer than 11 digits.”
    }
]
MEASURE IS INCORRECT

 

[
    {
        “isSuccess”: false,
        “unitID”: “1991197911”,
        “errorMessage”: “Measure is incorrect, send inch or cm.”
    }
]
CONSIGNEE IS INCORRECT

 

[
    {
        “isSuccess”: false,
        “unitID”: null,
        “errorMessage”: “Consignee is incorrect.CLI0119650—“
    }
]
LENGTH IS NOT A NUMERIC VALUE

 

{
    “OrderDetail[0].Length”: [
        “Input string ’41A’ is not a valid decimal. Path ‘OrderDetail[0].Length’, line 17, position 21.”
    ]
}
WIDTH IS NOT A NUMERIC VALUE

 

{
    “OrderDetail[0].Width”: [
        “Input string ’11A’ is not a valid decimal. Path ‘OrderDetail[0].Width’, line 18, position 20.”
    ]
}
HEIGHT IS NOT A NUMERIC VALUE

 

{
    “OrderDetail[0].Height”: [
        “Input string ‘6A’ is not a valid decimal. Path ‘OrderDetail[0].Height’, line 19, position 20.”
    ]
}
THE COMMAND IS INCORRECT

 

[
    {
        “isSuccess”: false,
        “unitID”: “1991197911”,
        “errorMessage”: “The Command is incorrect.”
    }
]
THE UNITID CANNOT BE ELIMINATED AS IT DOES NOT EXIST

 

[
    {
        “isSuccess”: false,
        “unitID”: “1991197912”,
        “errorMessage”: “The UnitID cannot be eliminated as it does not exist.”
    }
]
IDCLIENTEFINAL IS INCORRECT

 

[
    {
        “isSuccess”: false,
        “unitID”: “1991197911”,
        “errorMessage”: “IdClienteFinal is incorrect.”
    }
]
BARCODEACCOUNT IS INCORRECT

 

[
    {
        “isSuccess”: false,
        “unitID”: null,
        “errorMessage”: “BarcodeAccount is incorrect”
    }
]
SHIPDATEORIGINAL FORMAT IS INCORRECT

 

{
    “OrderHeader.ShipdateOriginal”: [
        “Could not convert string to DateTime: 2022-15-01T00:00:00. Path ‘OrderHeader.ShipdateOriginal’, line 6, position 47.”
    ]
}