Skip to main content

How can we help?

Search

Important API Update

Edited:

We’re making an update to the /v1/consignment-imports API endpoint to introduce stricter validation when consignments are imported.

 

What's changing?

We're introducing stricter validation for imported consignments. 

Following this update: 

  • All consignment imports will require a valid Client Partner code. 
  • Inwards and outwards consignment imports will require a valid Warehouse code. 

If a required code is missing or does not match a valid code in Consignly, the API will return a 400 Bad Request response with details of the validation error, for example:

{
 "errorType": "Verification Failed",
 "errorMessages": [
   "Client Code 'MYUNKNOWNCODE' not found"
 ],
 "action": null
}

 

Why are we making this change?

We're making this change to ensure consignments are associated with the correct Client Partner and Warehouse at the point of import.

 

What do you need to do? 

If you have an integration using this endpoint, please check that the Client Partner and Warehouse codes being supplied are valid and mapped correctly.

If your integration already supplies valid Client Partner and Warehouse codes, no changes are needed.

 

Thanks, 
The Consignly Team

white+orange-symbol-600h_Icon_Orange.png