Home

GetStatusList

Get the list of possible status to be found in the guide

🚧

If you need help don't forget to use our artificial intelligence

Our API provides a tool that allows you to query the list of possible status that can be found in your shipment. It is intended that you know the different status that you may find in the tracking history of your shipment through this query.

📘

Request

To consume this service there's no need to send any parameters.

❗️

Remember that you need to enter your partnerKey

Response

When you consume this API it will return an array of objects with the following features:

👍

Successful response

Array CatGuideStatus

Field NameTypeMaxLengthComments
IdInterger9Id of the status (requiered for other services used as a parameter)
CodeString12Short name for the status
DescriptionString50Description of the status
ActiveInteger9Status of the record (1: active, 0: inactive)
longDescriptionString with Integer values500Long explanation of the status

❗️

Failed Response

wsErrors elements

Field NameTypeComments
idIntegerError id
codeStringError code
typeIntegerSeverity of the error
descriptionStringDescription with more details of the detected error
Language
Click Try It! to start a request and see the response here!