Create Order LATAM

🚧
Do you have questions about our APIs? If you need help, don’t forget to use our artificial intelligence — it will help you generate examples that fit your specific needs, variations, and the required parameters for using each Hound Express API.
https://ia.hound-express.com/app/techhoundchannel

Name Description
Service name createOrder
EndPoint https://ws_pods.hound-express.com/Sabueso/ws/deliveryServices/createOrder
Headers https://apis-hound-express.readme.io/docs/the-headers-request
Method POST
Parameters JsonObject see: The guide object

Name	Description
Service name	createOrder
EndPoint	https://ws_pods.hound-express.com/Sabueso/ws/deliveryServices/createOrder
Headers	https://apis-hound-express.readme.io/docs/the-headers-request
Method	POST
Parameters	JsonObject see: The guide object

📘
### 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 name
Type
MaxLength
Required
Comments
sender
Address

Required
It is the sender of the shipment
receiver
Address

Required
It is the consignee of the shipment
List of packages
Package (Array)
Package (Array)
Required
It is the list of packages that make up the order, at least one object within the array is required.
currency
String
5
Required
It's a constant value: USD
clientReference
clientreference
clientreference
Required
Use this field to assign your own reference
deliveryOption
DeliveryOption

Required
Use this field to assign your choose for the delivery option.
The default value for this field is id: 1.
To obtain the possible options see:
GetDeliveryOptions
packageType
PackageType

Required
Use this field to assign your choice for the package type. The default value should be id: 1 , which corresponds to the “envelope” packet type, but you can change it if necessary.To obtain the possible options see:
GetPackageTypes
serviceType
ServiceType
Optional
If 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.
idOrgDeliver
Org

Optional
Through 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
moreInfo
MoreInfo(Array)

Optional
Additional and customized information. Refer to the Additional Fields / More Info section
Child objects
The guide object contains sub-objects of which the filling of the following values is required
sender(Address)
Field Name
Type
Maxlength
Required
Comments
zip
(zip code)
Integer
10
Required
Zip code for the address of the sender
contact
PersonName

Required
It is an object of the type PersonName see the
contact section
for reference
city
String
100
Required
City of the sender's address.
country
String
50
Required
Country for the address of the sender
county
String
100
Optional
Neighborhood, Town, Municipality, District, Province, etc. of the sender's address
state
String
50
Optional
State for the address of the sender
email
String
100
Required
Email address that helps to contact the sender
street
String
250
Required
Street of sender's address
streetNumber
String
50
Optional
Street and number of the sender's address
apartmentNumber
String
50
Optional
Apartment, internal, etc. Number for the address of the sender
phone
Phone
10-15
Required
Phone that helps to contact the sender
phones (Array)
Array

Optional
Other phone(s) that helps to contact the sender
loactionReference
String
500
Optional
Here you can put the references of the domiciles
company
String
100
Optional
In this field you can enter your company name.
receiver (Address)
Field Name
Type
Maxlength
Required
Comments
zip
(zip code)
Integer
8
Required
Zip code for the address of the receiver shipment
contact
PersonName

Required
It is an object of the type PersonName see the
contact section
for reference
city
String
100
Optional
City of the receiver's address.
country
String
50
Required
Country for the address of the receiver shipment
county
String
100
Optional
Neighborhood, Town, Municipality, District, Province, etc. of the receiver's address
state
String
50
Optional
State for the address of the receiver shipment
email
String
100
Required
Email address that helps to contact the receiver
street
String
250
Required
Street of receiver's address
streetNumber
String
50
Optional
Street and number of the receiver's address
apartmentNumber
String
50
Optional
Apartment, internal, etc. Number for the address of the receiver shipment
phone
Phone
10-15
Required
Phone that helps to contact the receiver
phones (Array)
Array

Optional
Other phone(s) that helps to contact the receiver
loactionReference
String
500
Optional
Here you can put the references of the domiciles
packagePieces
Package
Field Name
Type
Maxlength
Required
Comments
height
Integer
9
Required
In centimeters.
It must be an integer number.
length
Integer
9
Required
In centimeters.
It must be an integer number.
width
Integer
9
Required
In centimeters.
It must be an integer number.
weight
Float
10,2
Required
In 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
description
String
500
Optional
Use this field to enter the description of the contents of the package
declaredValue
Float
10,2
Required
enter 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.
piece
Integer
9
Required
It 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.
rfc_curp
String
18
Optional
RFC: 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_code
Integer
10
Min 6
Optional
HTS 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).
contact
PersonName
Field Name
Type
Maxlength
Required
Comments
givenName
String
200
Required
In 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
surname
String
50
Optional
This 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
surname2
String
50
Optional
This 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
rfc
String
18
Optional
RFC: 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.
ServiceType
Use this field to specify some kind of service assigned to your account
Field Name
Type
Maxlength
Required
Comments
code
Integer
20
Optional
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.
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.
id
Integer

Optional
It is required only if your KAM instructs you to send it; if so, they will specify the ID to be sent.
ClientReference
Field Name
Type
Maxlength
Required
Comments
code
String
50
Required
If 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.
MoreInfo
Field Name
Type
Maxlength
Required
Comments
idField
Integer

Required
Review the catalog of additional fields
value
String
100
Required
Information corresponding to the indicated field.
Additional Fields
ID
Field Name
Required
Comments
16
HS Code / HTS Code
Optional
In case the HS Code or HTS Code is not an integer.
17
Contains perfumes
Optional
Indicates whether the order contains a perfume. The value must be ‘true’, otherwise omit this field. if product contains perfume then '1' else '0'
18
Inflammable content
Optional
Indicates whether the content is flammable. The value must be ‘true’; otherwise, omit this field. if product is flameable liquid then '1' else '0'.
19
Contains batteries
Optional
Indicates whether the order contains a battery. The value must be ‘true’, otherwise omit this field. if product contains battery then '1' else '0'
30
Description Hazardous Material
Optional
If the guide contains any Hazardous Material, you must send a description of the material. (Max. length 100 characters)
31
Internal Hazardous Material code
Optional
If the guide contains any Hazardous Material, you must send its internal code (if any). (Max. length 100 characters)
52
Consignee AccountType
Optional
You must indicate whether it is a company by entering ‘business’ or an individual by entering ‘individual’.

Field name	Type	MaxLength	Required	Comments
sender	Address		Required	It is the sender of the shipment
receiver	Address		Required	It is the consignee of the shipment
List of packages	Package (Array)	Package (Array)	Required	It is the list of packages that make up the order, at least one object within the array is required.
currency	String	5	Required	It's a constant value: USD
clientReference	clientreference	clientreference	Required	Use this field to assign your own reference
deliveryOption	DeliveryOption		Required	Use this field to assign your choose for the delivery option. The default value for this field is id: 1. To obtain the possible options see: GetDeliveryOptions
packageType	PackageType		Required	Use this field to assign your choice for the package type. The default value should be id: 1 , which corresponds to the “envelope” packet type, but you can change it if necessary.To obtain the possible options see: GetPackageTypes
serviceType		ServiceType	Optional	If 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.
idOrgDeliver	Org		Optional	Through 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
moreInfo	MoreInfo(Array)		Optional	Additional and customized information. Refer to the Additional Fields / More Info section

Field Name	Type	Maxlength	Required	Comments
zip (zip code)	Integer	10	Required	Zip code for the address of the sender
contact	PersonName		Required	It is an object of the type PersonName see the contact section for reference
city	String	100	Required	City of the sender's address.
country	String	50	Required	Country for the address of the sender
county	String	100	Optional	Neighborhood, Town, Municipality, District, Province, etc. of the sender's address
state	String	50	Optional	State for the address of the sender
email	String	100	Required	Email address that helps to contact the sender
street	String	250	Required	Street of sender's address
streetNumber	String	50	Optional	Street and number of the sender's address
apartmentNumber	String	50	Optional	Apartment, internal, etc. Number for the address of the sender
phone	Phone	10-15	Required	Phone that helps to contact the sender
phones (Array)	Array		Optional	Other phone(s) that helps to contact the sender
loactionReference	String	500	Optional	Here you can put the references of the domiciles
company	String	100	Optional	In this field you can enter your company name.

Field Name	Type	Maxlength	Required	Comments
zip (zip code)	Integer	8	Required	Zip code for the address of the receiver shipment
contact	PersonName		Required	It is an object of the type PersonName see the contact section for reference
city	String	100	Optional	City of the receiver's address.
country	String	50	Required	Country for the address of the receiver shipment
county	String	100	Optional	Neighborhood, Town, Municipality, District, Province, etc. of the receiver's address
state	String	50	Optional	State for the address of the receiver shipment
email	String	100	Required	Email address that helps to contact the receiver
street	String	250	Required	Street of receiver's address
streetNumber	String	50	Optional	Street and number of the receiver's address
apartmentNumber	String	50	Optional	Apartment, internal, etc. Number for the address of the receiver shipment
phone	Phone	10-15	Required	Phone that helps to contact the receiver
phones (Array)	Array		Optional	Other phone(s) that helps to contact the receiver
loactionReference	String	500	Optional	Here you can put the references of the domiciles

Field Name	Type	Maxlength	Required	Comments
height	Integer	9	Required	In centimeters. It must be an integer number.
length	Integer	9	Required	In centimeters. It must be an integer number.
width	Integer	9	Required	In centimeters. It must be an integer number.
weight	Float	10,2	Required	In 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
description	String	500	Optional	Use this field to enter the description of the contents of the package
declaredValue	Float	10,2	Required	enter 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.
piece	Integer	9	Required	It 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.
rfc_curp	String	18	Optional	RFC: 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_code	Integer	10 Min 6	Optional	HTS 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).

Field Name	Type	Maxlength	Required	Comments
givenName	String	200	Required	In 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
surname	String	50	Optional	This 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
surname2	String	50	Optional	This 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
rfc	String	18	Optional	RFC: 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.

Field Name	Type	Maxlength	Required	Comments
code	Integer	20	Optional	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. 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.
id	Integer		Optional	It is required only if your KAM instructs you to send it; if so, they will specify the ID to be sent.

Field Name	Type	Maxlength	Required	Comments
code	String	50	Required	If 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.

Field Name	Type	Maxlength	Required	Comments
idField	Integer		Required	Review the catalog of additional fields
value	String	100	Required	Information corresponding to the indicated field.

ID	Field Name	Required	Comments
16	HS Code / HTS Code	Optional	In case the HS Code or HTS Code is not an integer.
17	Contains perfumes	Optional	Indicates whether the order contains a perfume. The value must be ‘true’, otherwise omit this field. if product contains perfume then '1' else '0'
18	Inflammable content	Optional	Indicates whether the content is flammable. The value must be ‘true’; otherwise, omit this field. if product is flameable liquid then '1' else '0'.
19	Contains batteries	Optional	Indicates whether the order contains a battery. The value must be ‘true’, otherwise omit this field. if product contains battery then '1' else '0'
30	Description Hazardous Material	Optional	If the guide contains any Hazardous Material, you must send a description of the material. (Max. length 100 characters)
31	Internal Hazardous Material code	Optional	If the guide contains any Hazardous Material, you must send its internal code (if any). (Max. length 100 characters)
52	Consignee AccountType	Optional	You must indicate whether it is a company by entering ‘business’ or an individual by entering ‘individual’.

🚧
BRAZIL
This section details the fields that must be considered mandatory for integration with Brazil, even though they may appear as optional in the general system documentation.
When sending data to Brazil, it is essential to ensure that the following fields are always complete
Field Name
Type
Maxlength
Required
Comments
(CONTACT) RECEIVER/SENDER surname
String
50
Required
This field is used for the 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
(CONTACT) SENDER **rfc_curp **
String
18
Required
RFC: 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.
(RECEIVER) city
String
100
Required
City of the receiver's address.
(RECEIVER) streetNumber
String
50
Required
Street and number of the receiver's address
(PACKAGE) rfc_curp
String
18
Required
The information you must send is : bussisnes (CNPJ) individual (CPF).
CPF (Cadastro de Pessoas Físicas) → 11 digits
CNPJ (Cadastro Nacional da Pessoa Jurídica) → 14 digits
(RECEIVER) state
String
50
Required
State for the address of the receiver shipment Find your state code in the state catalog Brazil.
(PACKAGE) hts_code
Integer
10
Required
HTS 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). Validations (Max length 10 Min length 6 )
(PACKAGE) description
String
500
Required
Use this field to enter the description of the contents of the package
(SERVICETYPE) code
String
20
Required
If 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. There are service type (DDU)
Use the service code HXSTGRU
You can consult the services types with your agent
(MOREINFO) Contains perfumes
Boolean
True or false
Required
Indicates whether the content is flammable. The value must be ‘true’; otherwise, omit this field. if product is flameable liquid then '1' else '0'.
(MOREINFO) Inflammable content
Boolean
True or false
Required
Indicates whether the content is flammable. The value must be ‘true’; otherwise, omit this field. if product is flameable liquid then '1' else '0'.
(MOREINFO) Contains batteries
Boolean
True or false
Required
Indicates whether the order contains a battery. The value must be ‘true’, otherwise omit this field. if product contains battery then '1' else '0
(MOREINFO) AccountType
String

Required
You must indicate whether is a company you should entering ‘business’ or ‘individual’.

Field Name	Type	Maxlength	Required	Comments
(CONTACT) RECEIVER/SENDER surname	String	50	Required	This field is used for the 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
(CONTACT) SENDER rfc_curp	String	18	Required	RFC: 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.
(RECEIVER) city	String	100	Required	City of the receiver's address.
(RECEIVER) streetNumber	String	50	Required	Street and number of the receiver's address
(PACKAGE) rfc_curp	String	18	Required	The information you must send is : bussisnes (CNPJ) individual (CPF). CPF (Cadastro de Pessoas Físicas) → 11 digits CNPJ (Cadastro Nacional da Pessoa Jurídica) → 14 digits
(RECEIVER) state	String	50	Required	State for the address of the receiver shipment Find your state code in the state catalog Brazil.
(PACKAGE) hts_code	Integer	10	Required	HTS 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). Validations (Max length 10 Min length 6 )
(PACKAGE) description	String	500	Required	Use this field to enter the description of the contents of the package
(SERVICETYPE) code	String	20	Required	If 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. There are service type (DDU) Use the service code HXSTGRU You can consult the services types with your agent
(MOREINFO) Contains perfumes	Boolean	True or false	Required	Indicates whether the content is flammable. The value must be ‘true’; otherwise, omit this field. if product is flameable liquid then '1' else '0'.
(MOREINFO) Inflammable content	Boolean	True or false	Required	Indicates whether the content is flammable. The value must be ‘true’; otherwise, omit this field. if product is flameable liquid then '1' else '0'.
(MOREINFO) Contains batteries	Boolean	True or false	Required	Indicates whether the order contains a battery. The value must be ‘true’, otherwise omit this field. if product contains battery then '1' else '0
(MOREINFO) AccountType	String		Required	You must indicate whether is a company you should entering ‘business’ or ‘individual’.

🚧
State catalog
id Name Code id_name
1 Acre AC 502
2 Alagoas AL 503
3 Amapá AP 504
4 Amazonas AM 505
5 Bahia BA 506
6 Ceará CE 507
7 Espírito Santo ES 508
8 Federal District DF 509
9 Goiás GO 510
10 Maranhão MA 511
11 Mato Grosso MT 512
12 Mato Grosso do Sul MS 513
13 Minas Gerais MG 514
14 Paraíba PB 515
15 Paraná PR 516
16 Pará PA 517
17 Pernambuco PE 518
18 Piauí PI 519
19 Rio de Janeiro RJ 520
20 Rio Grande do Norte RN 521
21 Rio Grande do Sul RS 522
22 Rondônia RO 523
23 Roraima RR 524
24 Santa Catarina SC 525
25 São Paulo SP 526
26 Sergipe SE 527
27 Tocantins TO 528

id	Name	Code	id_name
1	Acre	AC	502
2	Alagoas	AL	503
3	Amapá	AP	504
4	Amazonas	AM	505
5	Bahia	BA	506
6	Ceará	CE	507
7	Espírito Santo	ES	508
8	Federal District	DF	509
9	Goiás	GO	510
10	Maranhão	MA	511
11	Mato Grosso	MT	512
12	Mato Grosso do Sul	MS	513
13	Minas Gerais	MG	514
14	Paraíba	PB	515
15	Paraná	PR	516
16	Pará	PA	517
17	Pernambuco	PE	518
18	Piauí	PI	519
19	Rio de Janeiro	RJ	520
20	Rio Grande do Norte	RN	521
21	Rio Grande do Sul	RS	522
22	Rondônia	RO	523
23	Roraima	RR	524
24	Santa Catarina	SC	525
25	São Paulo	SP	526
26	Sergipe	SE	527
27	Tocantins	TO	528

🚧
CHILE
This section details the fields that must be considered mandatory for integration with CHILE, even though they may appear as optional in the general system documentation.
When sending data to Brazil, it is essential to ensure that the following fields are always complete
Field Name
Type
Maxlength
Required
Comments
(RECEIVER)
city
String
100
Required
City of the receiver's address.
(RECEIVER)
streetNumber
String
50
Required
Street and number of the receiver's address
(SERVICETYPE) code
String
20
Required
If 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.
You can consult the services types with your agent

Field Name	Type	Maxlength	Required	Comments
(RECEIVER) city	String	100	Required	City of the receiver's address.
(RECEIVER) streetNumber	String	50	Required	Street and number of the receiver's address
(SERVICETYPE) code	String	20	Required	If 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. You can consult the services types with your agent

Response

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

👍
### Successful response
Guide

Field name
Type
MaxLength
Comments
sender
Address

This field contains the data as originally received at the request.
receiver
Address

This field contains the data as originally received at the request.
packagePieces
Package (Array)

This field contains the data as originally received at the request.
guideNumber
String
30
This field contains de guide number generated.
trackingNumber
String

This field contains the tracking number of delivery partner
format
Byte[Array]

This field contains the bytes of the label PDF.
format_fileName
String
35
This field contains the file name of the label PDF.

Field name	Type	MaxLength	Comments
sender	Address		This field contains the data as originally received at the request.
receiver	Address		This field contains the data as originally received at the request.
packagePieces	Package (Array)		This field contains the data as originally received at the request.
guideNumber	String	30	This field contains de guide number generated.
trackingNumber	String		This field contains the tracking number of delivery partner
format	Byte[Array]		This field contains the bytes of the label PDF.
format_fileName	String	35	This field contains the file name of the label PDF.

❗️
### Failed Response

wsErrors elements

Field Name Type Comments
type Integer Severity of the error
code String Error code
description String Description with more details of the detected error

Field Name	Type	Comments
type	Integer	Severity of the error
code	String	Error code
description	String	Description with more details of the detected error

❗️
### Errors
Type Code Description
error NJSONF The object recived doesn't look like a valid json
error GONULL You must send to us a valid object of type Guide, please refer to documentation on: [URL API DOCS]
error EXINSV The filed: InsuredValue must be an object ( [MESSAGE] ) to see the schema for this object refer to: [URL API ] getInsuredValueScheme
error NIVV The filed: InsuredValue.Value in the guide object can't be null, must be defined
error IVNN The filed: InsuredValue.Value in the guide must be numeric and is required ( [MESSAGE] )
error NIVT The filed: InsuredValue.Code in the guide object can't be null, must be defined
error EXPT The filed: PackageType must be an object ( [MESSAGE] ) to see the schema and posible values for this object refer to: [URL API] getPackageTypes
error NOPT The filed: PackageType in the guide object can't be null, must be defined
error NPTI The filed: PackageType.id in the guide must be numeric and is required ( [MESSAGE] )
error FLNI If you include the filed: flag in the guide it must be an integer
error FLNI If you include the filed: format_B64 in the guide it must no to be empty
error CODERR If you include the COD cost it must be a float value
error EXIM The filed: infoMERQ must be an object ( [MESSAGE] )
error EXADDT The filed: Sender must be an object ( [MESSAGE] ) to see the schema for this object refer to: [URL API] getAddressScheme
error NOADDT The filed: Sender in the guide object can't be null, must be defined
error EXRECE The filed: Receiver must be an object ( [MESSAGE] ) to see the schema for this object refer to: [URL API] getAddressScheme
error NORECE The filed: Receiver in the guide object can't be null, must be defined
error PRSERR We can't parse your json to our guide object by an unexpected exception: ( [MESSAGE] )
error EMPTYPROD There are no products in stock for product : [SKU PRODUCT]
warning STNOTMDP We 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
warning STNOTMDP We 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
error NOSTONURS We can't find the service type ( [SERVICE ID] ) on the list of services assigned to your user
error NOCPFOUND We can't find the zip code that you're looking for please verify if it is correct
warning NOSTFOUND We can't find any service type assigned to your user
error NOCPFOUND We can't find the zip code that you're looking for please verify if it is correct
error NOFDXKEY The keys id:3 is not found
error EXCEPTION OCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS DE id:3
error NORPKEY The keys id:4 is not found
error EXCEPTION OCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS DE id: 4
error EXCEPTION OCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 13
error EXCEPTION OCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 11
error EXCEPTION OCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 11
error EXCEPTION OCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 19
error EXCEPTION OCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 19
error EXCEPTION OCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 34
error EXCEPTION OCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 73
error EXCEPTION OCURRIO UNA EXCEPCION AL OBTENER LAS TARIFAS 73
error EXCES OCURRIO UNA EXCEPCION AL OBTENER LAS TARFIAS
error EXCEPTION OCURRIO UNA EXCEPCION AL OBTENER LA COBERTURA
warning RESTZONE We 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
error NOFDXKEY The keys id:3 is not found
error ERRESTC We can't consume the extended data from our deliveryPartner
error NORPKEY The keys id:4 is not found
error ERRESTC We can't consume the extended data from our deliveryPartner
error ERRQPC We can't consume the extended data from our deliveryPartner
error ERRCOG We can't recover the id: 11 format for guide: [GUIDE NUMBER] and tracking code: [CLIENT REFERENCE]
error ERRPXC We can't consume the extended data from our deliveryPartner 11
error ERRESTC We can't consume the extended data from our deliveryPartner 19
error ERRESTC We can't consume the extended data from our deliveryPartner 21
error ERRESTC We can't consume the extended data from our deliveryPartner 21
error ERRESTC We can't consume the extended data from our deliveryPartner 73
error ERRESTC We can't consume the extended data from our deliveryPartner 13
error ERRSCM We can't consume the extended data from our deliveryPartner 32
error ERRSNDX We can't consume the extended data from our deliveryPartner 34
error ERRPORTEO We can't consume the extended data from our deliveryPartner 136
error ERRESTC We can't consume the extended data from our deliveryPartner 137
error ERRCAPO API MESSAGE 3 : [API MESSAGE]
error APICODE3-[EXCEPTION CODE] API MESSAGE 3 : [API MESSAGE]
error APICODE4-[EXCEPTION STATUS] API MESSAGE 4 : [API MESSAGE]
error OVERW The weight is over the permited by the contract
error APICODE11-[API MESSAGE TYPE] API MESSAGE 11 : [API MESSAGE]
error APICODE11-[API MESSAGE TYPE] API MESSAGE 11 : [API MESSAGE]
error ESTFERR API MESSAGE 19 : [API MESSAGE]
error DHLMSG API MESSAGE 21 : [API MESSAGE]
error EXCEPTION EXCEPTION MESSAGE 73 : [EXCEPTION MESSAGE]
error EXC_ERR EXC-[EXCEPTION MESSAGE]
error SCMERR API MESSAGE 32 : [API MESSAGE]
error EXCEPTION API MESSAGE 34 : [API MESSAGE]
error NOIATA THE FIELD IATA IS NOT RECEIVED ON THE RESULT OF THE WEB SERVICE
error NOIATA THE FIELD IATA IS NOT RECEIVED ON THE RESULT OF THE WEB SERVICE
error APICODE34-[API MESSAGE TYPE] API MESSAGE 34 : [API MESSAGE]
error EXCEPTION API MESSAGE 34 : [API MESSAGE]
error EXCEPTION THE WEB SERVICE DOES NOT RETURN THE FIELDS REQUIRED TO PRINT THE LABEL
error porteoERRPN Error, no se ha generado al guia en el DP
error porteoERRPN Error, no se ha generado al guia en el DP
error porteoERRPN error, no se ha parsear la respuesta desde el webService del DP
error porteoERRPN Error, no se ha generado al guia en el DP
error ERR API MESSAGE 137 : [API MESSAGE]
error ERR API MESSAGE 137 : [API MESSAGE]
error ERR We try to create the guide for J&T but it fail
error ERR [MESSAGE ERROR]
warning ERRESTC We can't consume the extended data from our deliveryPartner 182
error ERR We try to create the guide for J&T but it fail
warning ERRESTC We can't consume the extended data from our deliveryPartner 182
error ERRMUE MalformedURLException : [MESSAGE]
error ERRIOE IOException : [EXCEPTION]
error ERRGNC Guia no creada
error ERRAPI250-[CODE] [API MESSAGE]
warning ERRESTC We can't consume the extended data from our deliveryPartner 250
warning NQUOF We don't have coverage on this area with your assigned deliveryPartner
error EMPTYPROD The product not found: [PRODUCT SKU]
error GUIDE EXIST The guide already exist
error EMPTYPROD The list of products is empty, please rectify
error WARELF We can't render the label to: [GUIDE NUMBER] we are returning the standard pdf file
warning ORDEREC We detect your org use a unique reference, and we recover the last register created under it: [CLIENT REFERENCE]
error CDESRVNN The value you are sending in the code field of the serviceType object must be numeric, please verify it.
error CDESRVNV The value you are sending in the code field of the serviceType object is not valid, please verify it
warning ONBRAKETIME The last transaccions is taking more than your timeout waiting time, please wait until the server restore the performance
warning NZIPC The filed: ServiceType in the guide object is null, it could be because we don't have coverage on this area
error NOSERV The user: [USERNAME] doesn't have the serviceType: [SERVICE ID] required to create this order
warning NOLBLN We detect your org use their own lable and as no format needed, if it is not true please inform us please
error ERRFC We can't create the attached label file: [EXCEPTION MESSAGE]
warning WARELF We can't render the label to: [GUIDE NUMBER] we are returning the standard pdf file
error ERRSG We can't create the order guide, please contact with the IT team of Hound Express to report an solve it: [EXCEPTION MESSAGE]
warning NZIPC The 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
warning NQUOF We don't have coverage on this area with your assigned deliveryPartner
error Invalid User The user does not have permission to use WMS
error Null Object The guide object is null
error Empty Products Products are required
error Quantity Missing Quantity is required
error Identifier Missing Identifier is required
error Empty Receiver Receiver is required
error Zip Missing Zip is required
error Country Missing Country is required
error County Missing County is required
error Street Number Missing Street Number is required
error Apartment Number Missing Apartment Number is required
error State Missing State is required
error City Missing City is required
error Receiver Name Missing Receiver Name is required
error Phone Missing Phone is required
error Service Type Missing Service Type is required
error Exception [EXCEPTION MESSAGE]
error ERRCGD We can't create the order, please contact with the IT team of Hound Express to report an solve it