post https://ws_pods.hound-express.com/Sabueso/ws/deliveryServices/createOrder
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
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
RequestTo 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. 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 1.
To obtain the possible options see: The Delivery OptionspackageType PackageType - Required Use 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 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 DeliveryPartnersinsuredValue InsuredValue - Optional We need to know the value of the shipment and the currency of this value flag Integer 9 Optional In 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. pickupRequest PickupRequest PickupRequest Optional isFullfitment Boolean True or False Optional It 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. WmsProducto wmsproducto(Array) - Optional It 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. labelType Integer 1 PDF
2 ZPL 200
3 ZPL 300Optional Indicates 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 objectsThe guide object contains sub-objects of which the filling of the following values is required
sender
Field Name Type Maxlength Required Comments 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 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 11-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
receiver
Field Name Type Maxlength Required Comments zip code 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 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 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 11-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.23description 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.antidumping Integer Optional Identify, by catalog, whether a product is eligible for antidumping duty application 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 6Optional 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). made_in Integer Optional Identify, by catalog, the physical location of the final production of an item (where the product was manufactured).
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 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.
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.
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 Name Type Maxlength Required Comments pickUpRequestDateTime String 30 Optional It 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.observations String 500 Optional Used to specify any recommendations about the pickupRequest that helps to make easy the pickup pickUpRequestDate String 20 Only for return This 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 Name Type Maxlength Required Comments sku String 15 Required Write the sku in the same way that it was registred in the system cantidad_producto Integer 4 Required Specify 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 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 ResponsewsErrors 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 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