CreateOrder Exportación
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.
Name Description Service name createOrderExport 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 order 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 |
|---|---|---|---|---|
Address |
Required |
It is the sender of the shipment |
||
Address |
Required |
It is the consignee of the shipment |
||
packagePieces |
Required |
List of packages that make up the order, minimum one object is required within the array |
||
currency |
String |
5 |
Required |
It's a constant value: USD |
clientReference |
Optional |
Use this field to assign your own reference |
||
deliveryOption |
DeliveryOption |
Required |
Use this field to assign your choose for the delivery option. |
|
packageType |
PackageType |
Required |
Use this field to assign your choose for the package type. |
|
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. |
||
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. |
|
insuredValue |
InsuredValue |
Optional |
We need to know the value of the shipment and the currency of this value |
|
flag |
Integer |
9 |
Optional |
Within this field you can specify extended response characteristics. |
tipo_peso |
Integer |
1 |
Required |
Constant value: 1 |
isExportacion |
Boolean |
Required |
Constant value: True |
Child objectsThe guide object contains sub-objects of which the filling of the following values is required
sender (Address)
| Field Name | Type | Maxlength | Required | Comments |
|---|---|---|---|---|
zip |
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 for the address of the sender |
country |
String |
2 |
Required |
MX ( Country Code in Alpha-2 format ISO 3166-1 ) |
county |
String |
100 |
Optional |
Neighborhood, Town, municipality, district, County, etc. for the address of the sender |
state |
String |
2 |
Required |
State, Province, or other top-level administrative region. Mandatory for some countries (AU, CA, CN, MX, MY, US). Ideally, use the abbreviations (2 letters for US/CA). |
String |
100 |
Required |
Email address that helps to contact the sender |
|
street |
String |
250 |
Required |
Street for the address of the sender |
streetNumber |
String |
50 |
Optional |
Street Number for the address of the sender |
apartmentNumber |
String |
50 |
Optional |
Apartment, internal, etc. Number for the address of the sender |
phone |
Phone |
100 |
Required |
Phone that helps to contact the sender |
phones (Array) |
Array |
Optional |
Other phone(s) that helps to contact the sender |
receiver(Address)
| Field Name | Type | Maxlength | Required | Comments |
|---|---|---|---|---|
zip |
Integer |
10 |
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 |
Required |
City for the address of the receiver shipment |
country |
String |
2 |
Required |
US ( Country Code in Alpha-2 format ISO 3166-1 ) |
county |
String |
100 |
Optional |
Neighborhood, Town, municipality, district, County, etc. for the address of the receiver shipment |
state |
String |
2 |
Required |
State, Province, or other top-level administrative region. Mandatory for some countries (AU, CA, CN, MX, MY, US). Ideally, use the abbreviations (2 letters for US/CA). |
String |
100 |
Required |
Email address that helps to contact the receiver |
|
street |
String |
250 |
Required |
Street for the address of the receiver shipment |
streetNumber |
String |
50 |
Optional |
Street Number for the address of the receiver shipment |
apartmentNumber |
String |
50 |
Optional |
Apartment, internal, etc. Number for the address of the receiver shipment |
phone |
Phone |
100 |
Required |
Phone that helps to contact the receiver |
phones (Array) |
Array |
Optional |
Other phone(s) that helps to contact the receiver |
packagePieces
Package
| Field Name | Type | Maxlength | Required | Comments |
|---|---|---|---|---|
height |
Integer |
9 |
Required |
In centimeters. |
length |
Integer |
9 |
Required |
In centimeters. |
width |
Integer |
9 |
Required |
In centimeters. |
weight |
Float |
7.1 |
Required |
In kilograms. |
description |
String |
500 |
Optional |
Use this field to enter the description of the contents of the package |
DeclaredValue |
Float |
10,2 |
Required |
In Mexico and other countries there is a regulation where the law requires that the value of the merchandise is declared and the description of the material that the shipment contains must be announced. |
Piece |
Integer |
9 |
Required |
It is the TOTAL quantity of items that the package contains, regardless their variety. |
items |
9 |
Required |
Must not be empty |
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
ServiceTypeUse this field to specify some kind of service assigned to your account
| Field Name | Type | Maxlength | Required | Comments |
|---|---|---|---|---|
id |
Integer |
999 |
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. |
ClientReference
| Field Name | Type | Maxlength | Required | Comments |
|---|---|---|---|---|
code |
String |
50 |
Optional |
If your system generates a unique identifier that you want to link to the created order, you can send it in this field. |
Item
Field Name Type Maxlength Required Comments description String 100 Required Item description quantity Integer 99 Required Min. 1 piece length Float 99.9 Required In centimeters. Min 0.1 width Float 99.9 Required In centimeters. Min 0.1 height Float 99.9 Required In centimeters. Min 0.1 actual_weight Float 7.1 Required In kilograms. Min 0.1 declared_customs_value Float 999.9 Required In Mexico and other countries there is a regulation where the law requires that the value of the merchandise is declared and the description of the material that the shipment contains must be announced. declared_currency String 3 Required USD (CODIGO de ISO-4217 )
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.
flag
Integer
9
This field contains the data as originally received at the request.
### 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
### 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 ERRRM El pais del consignatario es requerido y debe ser US error ERRRM El pais del consignatario debe ser US error ERRRS El estado del consignatario es requerido error ERRRC La ciudad del consignatario es requerido error ERRRM El correo del consignatario es requerido error ERRSM El correo del remitente es requerido error ERRLI Para exportaciones debe indicar el contenido del paquete error ERRQI Todos los productos deben tener quantity mayor a 0 error ERRDI Todos los productos deben tener description error ERRDCI Todos los productos deben tener declare_currency error ERRDCI El campo declare_currency debe ser un codigo de la ISO-4217 error ERRDCVI Todos los productos deben tener declare_custom_value mayor a 0 error ERRLEI Todos los productos deben tener length mayor a 0 error ERRW Todos los productos deben tener width mayor a 0 error ERRHI Todos los productos deben tener height mayor a 0 error ERRAWI Todos los productos deben tener actual_weight mayor a 0 error ERRAWOF El campo actual_weight de los productos deben ser menor a 7.1 error EXCERRVG Error en validacion: [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