Home

Using the HoundExpress API you can create a label that will be placed on the customer's package,which will be used for tracking, shipping and delivery.

🚧

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

📘

Request

To carry out the consumption of the service for the creation of the label it is necessary to send a JSON object of the guide type and it requires the filling of the following fields:

Guide

Field nameTypeMaxLengthRequiredComments
senderAddress-RequiredIt is the sender of the shipment
receiverAddress-RequiredIt is the consignee of the shipment
List of packagesPackage (Array)Package (Array)RequiredIt is the list of packages that make up the order, at least one object within the array is required.
currencyString5RequiredIt's a constant value.
clientReferenceclientReferenceclientReferenceRequiredUse this field to assign your own reference
deliveryOptionDeliveryOption-RequiredUse this field to assign your choose for the delivery option.
The default value for this field is 1.
To obtain the possible options see: The Delivery Options
packageTypePackageType-RequiredUse this field to assign your choice for the package type. The default value should be 1 , which corresponds to the “envelope” packet type, but you can change it if necessary.To obtain the possible options see: The Package Types
serviceTypeServiceTypeOptionalIf your account is enabled to be able to select among the services assigned to you, use this field to specify the type of service you want to apply to the order. It is important that if you are using the field to select the idOrgDeliver, the service belongs to the Delivery Partner that you specify.
To obtain the possible options see: The Service Types
However, remember that the privileges to use this field depend on the configuration of your account, otherwise the service is assigned by our system. (For some accounts is available to choose the service, please keep in mind an easy way to be configured on your development)
In case your account allows it, our API allows you to select through this parameter, among the different configurations assigned to the accounts that your organization has.
Ask your account executive for the possible values for this purpose.
idOrgDeliverOrg-OptionalThrough this field it is possible to specify the deliveryPartner that you want to assign to the order, within the configuration of your account you have assigned different types of services and each one of them is provided by a specific organization. Therefore, if you also specify the serviceType field, the type of service must be provided by the organization that you specify in this field.
It is only possible to specify the organization that will be the deliveryParnter without specifying the serviceType and in this case our system will automatically assign the type of service of those that belong to the organization that you chose and you have assigned to your account.
To obtain the possible options see: The DeliveryPartners
insuredValueInsuredValue-OptionalWe need to know the value of the shipment and the currency of this value
flagInteger9OptionalIn this field you can specify extended response characteristics, i.e. responses where more information about the label characteristics is provided. If you want to include the print format in the response, enter the value 1, otherwise enter the value 0.
pickupRequestPickupRequestPickupRequestOptional
isFullfitmentBooleanTrue or FalseOptionalIt is an identifier to know if they are fullfilment packages (fulfillment packages). A fullfilment package is a package with which the whole process is carried out from the moment the order is received until it is delivered to the customer.
WmsProductowmsproducto(Array) -OptionalIt is a list for internal use, generated in the system of the entity that manages the order. This list details the fulfillment products to be shipped to the end customer, providing a clear view of the items to be prepared for shipment.
labelTypeInteger1 PDF
2 ZPL 200
3 ZPL 300
OptionalIndicates the label format in which you wish to receive, if none is selected, it is sent by default in pdf.
If 1 is sent, you will receive the PDF in byte array, 2 to receive ZPL 200 DPI in byte array, 3 to receive ZPL 300 DPI in byte array.

Child objects

The guide object contains sub-objects of which the filling of the following values is required

sender

Field NameTypeMaxlengthRequiredComments
zip codeInteger10RequiredZip code for the address of the sender
contactPersonName-RequiredIt is an object of the type PersonName see the contact section for reference
cityString100RequiredCity of the sender's address.
countryString50RequiredCountry for the address of the sender
countyString100OptionalNeighborhood, Town, Municipality, District, Province, etc. of the sender's address
stateString50OptionalState for the address of the sender
emailString100RequiredEmail address that helps to contact the sender
streetString250RequiredStreet of sender's address
streetNumberString50OptionalStreet and number of the sender's address
apartmentNumberString50OptionalApartment, internal, etc. Number for the address of the sender
phonePhone11-15RequiredPhone that helps to contact the sender
phones (Array)Array-OptionalOther phone(s) that helps to contact the sender
loactionReferenceString500OptionalHere you can put the references of the domiciles

receiver

Field NameTypeMaxlengthRequiredComments
zip codeInteger10RequiredZip code for the address of the receiver shipment
contactPersonName-RequiredIt is an object of the type PersonName see the contact section for reference
cityString100OptionalCity of the receiver's address.
countryString50RequiredCountry for the address of the receiver shipment
countyString100OptionalNeighborhood, Town, Municipality, District, Province, etc. of the receiver's address
stateString50OptionalState for the address of the receiver shipment
emailString100RequiredEmail address that helps to contact the receiver
streetString250RequiredStreet of receiver's address
streetNumberString50OptionalStreet and number of the receiver's address
apartmentNumberString50OptionalApartment, internal, etc. Number for the address of the receiver shipment
phonePhone11-15RequiredPhone that helps to contact the receiver
phones (Array)Array-OptionalOther phone(s) that helps to contact the receiver
loactionReferenceString500OptionalHere you can put the references of the domiciles

packagePieces

Package

Field NameTypeMaxlengthRequiredComments
heightInteger9RequiredIn centimeters.
It must be an integer number.
lengthInteger9RequiredIn centimeters.
It must be an integer number.
widthInteger9RequiredIn centimeters.
It must be an integer number.
weightFloat10,2RequiredIn kilograms.
It may be a number with decimal point, and there must be a maximum of two figures after it. If the value contains more than two, the following figures will be ignored.
Example: if the user inputs 6.2375, the system will record 6.23
descriptionString500OptionalUse this field to enter the description of the contents of the package
DeclaredValueFloat10,2Requiredenter the declared value of the merchandise, since in Mexico and other countries there is a regulation in which the law requires the value of the merchandise to be declared and the description of the material contained in the shipment to be announced.
PieceInteger9RequiredIt is the TOTAL quantity of items that the package contains, regardless their variety.
Example: Assuming the shipment contains mice and cables, the pieces field must include the total number of articles:
For this example, if you bring 5 mice and 4 cables, the piece field should be filled as 9.
We fully understand that sometimes you have this information repeated for several shipments, so just as in the other cases you can place a fixed value.
antidumpingIntegerOptionalIdentify, by catalog, whether a product is eligible for antidumping duty application
rfc_curpString18OptionalRFC: It is the unique registration key that identifies any person who carries out an economic activity and must contribute to public spending before the SAT.

CURP: The Unique Population Registration Code (CURP) is an instrument that individually registers all inhabitants of the country, both nationals and foreign residents, as well as Mexican men and women who live in other countries.

The tax identification number of the country of residence or the social security number in the case of foreigners.
hts_codeInteger10
Min 6
OptionalHTS stands for Harmonized Tariff Schedule, a classification system used in the United States to help determine customs duties to be paid on imports. HTS codes are 10-digits (the first six digits are the same as the HS code for the goods).
made_inIntegerOptionalIdentify, by catalog, the physical location of the final production of an item (where the product was manufactured).

contact

PersonName

Field NameTypeMaxlengthRequiredComments
givenNameString200RequiredIn this field it is expected to receive the name and may include the full name but it is recommended to divide it into its different parts within the PersonName object
surnameString50OptionalThis field is used for the paternal surname, although it is optional it is recommended not to include the full name inside the givenName but it is better to divide it, since it helps in later searches
surname2String50OptionalThis field is used for the maternal last name, although it is optional it is recommended not to include the full name inside the givenName but it is better to divide it, since it helps in later searches

ServiceType

Use this field to specify some kind of service assigned to your account

Field NameTypeMaxlengthRequiredComments
codeInteger20OptionalIn case your account allows it, our API allows you to select through this parameter, among the different configurations assigned to the accounts that your organization has.
Ask your account executive for the possible values for this purpose.
Your executive can configure your account so that you can select between the different business flows, as it may be that you only want to use the services of customs clearance, b2b, c2c, etc. In these cases you can select one of these options.
To specify this option you can make use of this field using a value from the list provided by your executive.

ClientReference

Field NameTypeMaxlengthRequiredComments
codeString50OptionalIf your system generates a unique identifier that you want to link to the created order, you can send it in this field.
You can search for your orders through this field, so that you use your own tracking number.
There is the possibility of configuring your account so that in case our system receives this duplicate field, the system returns the previously created guide or if you wish we can configure your account so that this field can be repeated multiple times. In the second case, it is not possible to trace through this field.

PickupRequest

Field NameTypeMaxlengthRequiredComments
pickUpRequestDateTimeString30OptionalIt is possible to specify a tentative date and time of collection. However, this date can be automatically modified on our server for any of the following reasons: the specified time or date is not within a possible range to make the collection.
If you do not include the field to specify the tentative date and time of collection, our system will automatically schedule the date with the first available.
observationsString500OptionalUsed to specify any recommendations about the pickupRequest that helps to make easy the pickup
pickUpRequestDateString20Only for returnThis field is used to return you the real date when the pickup was scheduled.
At the time of receiving the response from our web service, within the structure of the json object of the response, you will again find the pickupRequest object already with the data that has finally been registered in our system, so that with them, for example, you can inform your client the date with which the pickup was recorded.
However, it is important that you contact your account executive, who will inform you of the operational details and possible ranges of deviation from pickup schedules.

WMS Producto

Field NameTypeMaxlengthRequiredComments
skuString15RequiredWrite the sku in the same way that it was registred in the system
cantidad_productoInteger4RequiredSpecify the quantity of product contains the guide

Response

When the consumption is done, the API will return an object with the following features:

👍

Successful response

Guide

Field nameTypeMaxLengthComments
senderAddress-This field contains the data as originally received at the request.
receiverAddress-This field contains the data as originally received at the request.
packagePiecesPackage (Array)-This field contains the data as originally received at the request.
guideNumberString30This field contains de guide number generated.
trackingNumberString-This field contains the tracking number of delivery partner
formatByte[Array]-This field contains the bytes of the label PDF.
format_fileNameString35This field contains the file name of the label PDF.

❗️

Failed Response

wsErrors elements

Field NameTypeComments
typeIntegerSeverity of the error
codeStringError code
descriptionStringDescription with more details of the detected error

❗️

Errors

TypeCodeDescription
errorNJSONFThe object recived doesn't look like a valid json
errorGONULLYou must send to us a valid object of type Guide, please refer to documentation on: [URL API DOCS]
errorEXINSVThe filed: InsuredValue must be an object ( [MESSAGE] ) to see the schema for this object refer to: [URL API ] getInsuredValueScheme
errorNIVVThe filed: InsuredValue.Value in the guide object can't be null, must be defined
errorIVNNThe filed: InsuredValue.Value in the guide must be numeric and is required ( [MESSAGE] )
errorNIVTThe filed: InsuredValue.Code in the guide object can't be null, must be defined
errorEXPTThe filed: PackageType must be an object ( [MESSAGE] ) to see the schema and posible values for this object refer to: [URL API] getPackageTypes
errorNOPTThe filed: PackageType in the guide object can't be null, must be defined
errorNPTIThe filed: PackageType.id in the guide must be numeric and is required ( [MESSAGE] )
errorFLNIIf you include the filed: flag in the guide it must be an integer
errorFLNIIf you include the filed: format_B64 in the guide it must no to be empty
errorCODERRIf you include the COD cost it must be a float value
errorEXIMThe filed: infoMERQ must be an object ( [MESSAGE] )
errorEXADDTThe filed: Sender must be an object ( [MESSAGE] ) to see the schema for this object refer to: [URL API] getAddressScheme
errorNOADDTThe filed: Sender in the guide object can't be null, must be defined
errorEXRECEThe filed: Receiver must be an object ( [MESSAGE] ) to see the schema for this object refer to: [URL API] getAddressScheme
errorNORECEThe filed: Receiver in the guide object can't be null, must be defined
errorPRSERRWe can't parse your json to our guide object by an unexpected exception: ( [MESSAGE] )
errorEMPTYPRODThere are no products in stock for product : [SKU PRODUCT]
warningSTNOTMDPWe can't find the serviceType selected ( [SERVICE ID] ) on the list of services available to the selected ([DELIVERY ID) DP, the system will ignore the serviceType
warningSTNOTMDPWe can't find the serviceType selected ( [SERVICE ID] ) on the list of services available to the selected ( [DELIVERY ID] ) DP, the system will ignore the serviceType
errorNOSTONURSWe can't find the service type ( [SERVICE ID] ) on the list of services assigned to your user
errorNOCPFOUNDWe can't find the zip code that you're looking for please verify if it is correct
warningNOSTFOUNDWe can't find any service type assigned to your user
errorNOCPFOUNDWe can't find the zip code that you're looking for please verify if it is correct
errorNOFDXKEYThe keys id:3 is not found
errorEXCEPTIONOCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS DE id:3
errorNORPKEYThe keys id:4 is not found
errorEXCEPTIONOCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS DE id: 4
errorEXCEPTIONOCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 13
errorEXCEPTIONOCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 11
errorEXCEPTIONOCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 11
errorEXCEPTIONOCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 19
errorEXCEPTIONOCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 19
errorEXCEPTIONOCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 34
errorEXCEPTIONOCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 73
errorEXCEPTIONOCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 73
errorEXCESOCURRIO UNA EXCEPCION AL OBTENER LAS TARFIAS
errorEXCEPTIONOCURRIO UNA EXCEPCION AL OBTENER LA COBERTURA
warningRESTZONEWe can't use the delivery parnter: [DELIVERY ID] to the zip code [ZIP CODE RECEIVER] becasue is on the restricted coverage zone list of services
errorNOFDXKEYThe keys id:3 is not found
errorERRESTCWe can't consume the extended data from our deliveryPartner
errorNORPKEYThe keys id:4 is not found
errorERRESTCWe can't consume the extended data from our deliveryPartner
errorERRQPCWe can't consume the extended data from our deliveryPartner
errorERRCOGWe can't recover the id: 11 format for guide: [GUIDE NUMBER] and tracking code: [CLIENT REFERENCE]
errorERRPXCWe can't consume the extended data from our deliveryPartner 11
errorERRESTCWe can't consume the extended data from our deliveryPartner 19
errorERRESTCWe can't consume the extended data from our deliveryPartner 21
errorERRESTCWe can't consume the extended data from our deliveryPartner 21
errorERRESTCWe can't consume the extended data from our deliveryPartner 73
errorERRESTCWe can't consume the extended data from our deliveryPartner 13
errorERRSCMWe can't consume the extended data from our deliveryPartner 32
errorERRSNDXWe can't consume the extended data from our deliveryPartner 34
errorERRPORTEOWe can't consume the extended data from our deliveryPartner 136
errorERRESTCWe can't consume the extended data from our deliveryPartner 137
errorERRCAPOAPI MESSAGE 3 : [API MESSAGE]
errorAPICODE3-[EXCEPTION CODE]API MESSAGE 3 : [API MESSAGE]
errorAPICODE4-[EXCEPTION STATUS]API MESSAGE 4 : [API MESSAGE]
errorOVERWThe weight is over the permited by the contract
errorAPICODE11-[API MESSAGE TYPE]API MESSAGE 11 : [API MESSAGE]
errorAPICODE11-[API MESSAGE TYPE]API MESSAGE 11 : [API MESSAGE]
errorESTFERRAPI MESSAGE 19 : [API MESSAGE]
errorDHLMSGAPI MESSAGE 21 : [API MESSAGE]
errorEXCEPTIONEXCEPTION MESSAGE 73 : [EXCEPTION MESSAGE]
errorEXC_ERREXC-[EXCEPTION MESSAGE]
errorSCMERRAPI MESSAGE 32 : [API MESSAGE]
errorEXCEPTIONAPI MESSAGE 34 : [API MESSAGE]
errorNOIATATHE FIELD IATA IS NOT RECEIVED ON THE RESULT OF THE WEB SERVICE
errorNOIATATHE FIELD IATA IS NOT RECEIVED ON THE RESULT OF THE WEB SERVICE
errorAPICODE34-[API MESSAGE TYPE]API MESSAGE 34 : [API MESSAGE]
errorEXCEPTIONAPI MESSAGE 34 : [API MESSAGE]
errorEXCEPTIONTHE WEB SERVICE DOES NOT RETURN THE FIELDS REQUIRED TO PRINT THE LABEL
errorporteoERRPNError, no se ha generado al guia en el DP
errorporteoERRPNError, no se ha generado al guia en el DP
errorporteoERRPNerror, no se ha parsear la respuesta desde el webService del DP
errorporteoERRPNError, no se ha generado al guia en el DP
errorERRAPI MESSAGE 137 : [API MESSAGE]
errorERRAPI MESSAGE 137 : [API MESSAGE]
errorERRWe try to create the guide for J&T but it fail
errorERR[MESSAGE ERROR]
warningERRESTCWe can't consume the extended data from our deliveryPartner 182
errorERRWe try to create the guide for J&T but it fail
warningERRESTCWe can't consume the extended data from our deliveryPartner 182
errorERRMUEMalformedURLException : [MESSAGE]
errorERRIOEIOException : [EXCEPTION]
errorERRGNCGuia no creada
errorERRAPI250-[CODE][API MESSAGE]
warningERRESTCWe can't consume the extended data from our deliveryPartner 250
warningNQUOFWe don't have coverage on this area with your assigned deliveryPartner
errorEMPTYPRODThe product not found: [PRODUCT SKU]
errorGUIDE EXISTThe guide already exist
errorEMPTYPRODThe list of products is empty, please rectify
errorWARELFWe can't render the label to: [GUIDE NUMBER] we are returning the standard pdf file
warningORDERECWe detect your org use a unique reference, and we recover the last register created under it: [CLIENT REFERENCE]
errorCDESRVNNThe value you are sending in the code field of the serviceType object must be numeric, please verify it.
errorCDESRVNVThe value you are sending in the code field of the serviceType object is not valid, please verify it
warningONBRAKETIMEThe last transaccions is taking more than your timeout waiting time, please wait until the server restore the performance
warningNZIPCThe filed: ServiceType in the guide object is null, it could be because we don't have coverage on this area
errorNOSERVThe user: [USERNAME] doesn't have the serviceType: [SERVICE ID] required to create this order
warningNOLBLNWe detect your org use their own lable and as no format needed, if it is not true please inform us please
errorERRFCWe can't create the attached label file: [EXCEPTION MESSAGE]
warningWARELFWe can't render the label to: [GUIDE NUMBER] we are returning the standard pdf file
errorERRSGWe can't create the order guide, please contact with the IT team of Hound Express to report an solve it: [EXCEPTION MESSAGE]
warningNZIPCThe address is formed correctly but is the ZIP Code correct?, it is possible to create the document but maybe this shipment has problems to be delivered
warningNQUOFWe don't have coverage on this area with your assigned deliveryPartner
errorInvalid UserThe user does not have permission to use WMS
errorNull ObjectThe guide object is null
errorEmpty ProductsProducts are required
errorQuantity MissingQuantity is required
errorIdentifier MissingIdentifier is required
errorEmpty ReceiverReceiver is required
errorZip MissingZip is required
errorCountry MissingCountry is required
errorCounty MissingCounty is required
errorStreet Number MissingStreet Number is required
errorApartment Number MissingApartment Number is required
errorState MissingState is required
errorCity MissingCity is required
errorReceiver Name MissingReceiver Name is required
errorPhone MissingPhone is required
errorService Type MissingService Type is required
errorException[EXCEPTION MESSAGE]
errorERRCGDWe can't create the order, please contact with the IT team of Hound Express to report an solve it
Language
Click Try It! to start a request and see the response here!