📘

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	Specifications	About
sender	Type: Object Is required	It is the sender of the shipment
sender.zip	Type: String Is required Max Lenght: 10 Min Value: 5	Zip code for the address of the sender
sender.city	Type: String Is required Max Lenght: 100	City of the sender's address.
sender.country	Type: String Is required Max Lenght: 50	Country for the address of the sender
sender.email	Type: String Is required Max Lenght: 100	Email address that helps to contact the sender
sender.street	Type: String Is required Max Lenght: 250	Street of sender's address
sender.phone	Type: String Is required Max Lenght: 50	Phone that helps to contact the sender
sender.contact	Type : Object Is required
sender.contact.givenName	Type: String Is required Max Lenght: 200	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
sender.contact.surname	Type: String Is optional Max Lenght: 50	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
sender.contact.surname2	Type: String Is optional Max Lenght: 50	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
sender.county	Type: String Is optional Max Lenght: 100	Neighborhood, Town, Municipality, District, Province, etc. of the sender's address
sender.state	Type: String Is optional Max Lenght: 50	State for the address of the sender
sender.streetNumber	Type: String Is optional Max Lenght: 50	Street and number of the sender's address
sender.apartmentNumber	Type: String Is optional Max Lenght: 50	Apartment, internal, etc. Number for the address of the sender
sender.locationReference	Type: String Is optional Max Lenght: 500	Here you can put the references of the domiciles
sender.company	Type: String Is optional Max Lenght: 100	In this field you can enter your company name.
receiver	Type: Objetc Is required	It is the consignee of the shipment
receiver.zip	Type: String Is required Lenght: 5	Zip code for the address of the receiver shipment
receiver.country	Type: String Is required Max Lenght: 50	Country for the address of the receiver shipment
receiver.email	Type: String Is required Max Lenght: 100 Must be e-mail format	Email address that helps to contact the receiver
receiver.street	Type: String Is required Max Lenght: 250	Street of receiver's address
receiver.phone	Type: String Is required Max lenght : 20 Min lenght : 10 (Should be 10 digits, or 12 digits including the area code.)	Phone that helps to contact the receiver
receiver.contact	Type: Object Is required
receiver.contact.givenName	Type: String Is required Max Lenght: 200	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
receiver.contact.rfc	Type: String Is required Max Lenght: 18 Min Lenght: 13 This can be either the RFC or the CURP.	The RFC is the identification number used by the SAT to identify individuals engaged in economic activities. The CURP is a unique code that registers all residents of the country, both citizens and foreigners. For foreigners, the tax identification number from their country of residence or their social security number is used.
receiver.contact.surname	Type: String Is optional Max Lenght: 50	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
receiver.contact.surname2	Type: String Is optional Max Lenght: 50	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
receiver.city	Type: String Is optional Max Lenght: 100	City of the receiver's address.
receiver.county	Type: String Is optional Max Lenght: 100	Neighborhood, Town, Municipality, District, Province, etc. of the receiver's address
receiver.state	Type: String Is optional Max Lenght: 50	State for the address of the receiver shipment
receiver.streetNumber	Type: String Is optional Max Lenght: 50	Street and number of the receiver's address
receiver.apartmentNumber	Type: String Is optional Max Lenght: 50	Apartment, internal, etc. Number for the address of the receiver shipment
receiver.locationReference	Type: String Is optional Max Lenght: 500	Here you can put the references of the domiciles
packagePieces	Type : Objects Array Is required Max Lenght: 1 (Only one element is allowed)	It is the list of packages that make up the order, at least one object within the array is required.
packagePieces[].height	Type: Integer Is required Min Lenght: 1	In centimeters. This field is for the parcel measurements. It must be an integer number.
packagePieces[].length	Type: Integer Is required Min Lenght: 1	In centimeters. This field is for the parcel measurements. It must be an integer number.
packagePieces[].width	Type: Integer Is required Min Lenght: 1	In centimeters. This field is for the parcel measurements. It must be an integer number.
packagePieces[].weight	Type: Integer Is required Min Value: 0.01	In kilograms. This field is for the weight of the parcel. Is the sum of the weight of each item. 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
packagePieces[].description	Type: String Is required Max Lenght: 500	Use this field to enter the description of the contents of the package
packagePieces[].declaredValue	Type: Float Is required Min Lenght: 0.1	Is the sum for each item 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.
packagePieces[].piece	Type: Integer Is required Min Lenght: 1	Is the sum for each item 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.
packagePieces[].items	Type: Objects Array Field is optional or required, depending on the settings	In this field, you can specify the information for each item contained in the package
items[].quantity	Type: Integer Is required Min Lenght: 1	Min. 1 piece
items[].description	Type: String Is required Max Lenght: 500	Item description
items[].declaredValue	Type: Float Is required Min Lenght: 0.1	In Mexico and other countries there is a regulation requiring the merchandise value to be declared and the shipment contents to be described. Its the singular value
items[].htsCode	Type: String Is required Max Lenght: 30 Min Lenght: 6	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).
items[].madeIn	Type: String Is required Max Lenght: 3	In this field, the CatCountryCode catalog code_alpha_3 must be sent. This field refers to the physical location of the final production of an item (where the product was manufactured).
items[].sku	Type: String Is optional Max Lenght: 50	SKU Item
comments	Type: String Is optional Max Lenght: 500	This field contains comments or observations from the guide.
currency	Type: String Is required Max Lenght: 5 ISO currency	It's a constant value: USD
clientReference	Type: String Is required Max Lenght: 30	Use this field to assign your own reference
packageType	Type: Integer Is required Min Lenght: 1 Values : 1 : Envelope 2 : Box	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
serviceCode	Type: String Is required Max Lenght: 30 Values: HXLRDMXST HXNLUMXST	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.
labelType	Type: Boolean Is optional Default Value: 1 Values: 1: PDF 2: ZPL 200 3: ZPL 300	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.
getLabel	Type: Boolean Is optional Default Value: true	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 true, otherwise enter the value false.
moreInfo	Type: Objects Array Is optional Default Value: true	Additional and customized information.
moreInfo[].idField	Type: Integer Is required (If you are sending moreInfo) Min Lenght: 1	Review the catalog of additional fields
moreInfo[].value	Type: String Is required (If you are sending moreInfo) Max Lenght: 100	Information corresponding to the indicated field.

🚧

ID	Field Name	Comments
11	Internal Account Number	Your customer's internal account number.
17	Contains perfumes	Indicates whether the order contains a perfume. The value must be ‘true’, otherwise omit this field.
18	Inflammable content	Indicates whether the content is flammable. The value must be ‘true’; otherwise, omit this field.
19	Contains batteries	Indicates whether the order contains a battery. The value must be ‘true’, otherwise omit this field.
30	Description Hazardous Material	If the guide contains any Hazardous Material, you must send a description of the material. (Max. length 100 characters)
31	Internal Hazardous Material code	If the guide contains any Hazardous Material, you must send its internal code (if any). (Max. length 100 characters)

👍

Response

Field	Type	Comments
type	String	Values: success or error
code	String	The success code values are: CREATED: Indicates that the order was created successfully. REFERENCE: Indicates that the system found an existing shipment with the same clientReference. In this case, it returns the existing guideNumber and label instead of creating a new order (this applies only if your account has this configuration enabled). Any other value should be considered an error code.
guideNumber	String	The guideNumber for Tracking API
trackingNumber	String	The tracking number for delivery
label	Array Byte	Label file in the specified labelType format; not included in the response if getLabel = false
wsErrors	List	Contains error messages if type = error
wsErrors[].code	String	Internal error code
wsErrors[].type	String	Internal message type : error, warning, info. Its optional.
wsErrors[].description	String	Description of the error code