Find articles, help and tips about our API

Register / Login
building
Updated on 10 agosto, 2023

International/National Generation of Labels

Prod URL

				
					https://api-clientes.vercel.app/v2/shipments/generate

Sandbox URL

				
					https://sandbox.api-drenvio.com/v2/shipments/generate

Request

Almost all providers support up to 50 characters in each field, when the ShippingId is N6 it will only allow 25 characters. Keep that in mind when making a shipment. 

Field Description Type Required
origin
Origin Address of shipment
Object AddressObject
true
destination
Destination address of the shipment
Object
AddressObject
true
shipments
shipment details
Object
ShipmentObject
true
packages
packages
Array
PackagesObject
true
service_id
Id of the service selected
string

true
insurance
The insurance of shipment
number
true
carriers
Selected carrier (Provided in the rate)
Array
true

Address Object

Field Description Type Required
name
Name of the person making/receiving the shipment.
string
true
company
Company of the person making/receiving the shipment, if not provided will be NA.
string
false
email
Email of the person making/receiving the shipment.
string
true
phone
Phone number of the person making/receiving the shipment.
string
true
street
Street of the person making/receiving the shipment.
string
true
number
Number of building of the address.
string
true
int_number
Interior Number of building of the address.
string
false
district
District of the address.
string
true
city
City of the address.
string
true
country
Always MX until next major update.
string
true
reference
A reference to help find the address. if not provided will be NA.
string
false
state

2 digit state code of the address, those can be found here.
Enum StateCodes
true
postalCode
5 digit postal code of the address.
string
true

Packages Object

Field Description Type Required
width
Width of the package in CM.
number
true
height
Height of the package in CM.
number
true
Length
Length of the package in CM.
number
true
weight
Weight of the package in KG.
number
true
type
The type of the package
Enum:
box
 envelope
 pallet
true
name
Content of the package
string
true
content
Content of the package
string
true
declared_value
Declared Value of the package
string
true
contentQuantity
Amount of packages
number
true
volumetric
Volumetric of the shipment
number
true
main_weight
Main weight of the shipment
number
true

Shipment Object

Field Description Type Required
carrier
Provided in the rate
string
true
ObjectId
Provided in the rate
string
true
ShippingId
Provided in the rate
string
true
service
Provided in the rate
string
true
price
Provided in the rate
number
true
contentExplanation
An explanation of the content of the shipment, must include fabrication materials
string
true
contentQuantity
How many items are in the box
number
true
Field Description Value
MX

Aguascalientes
Baja California
Baja California Sur
Campeche
Chiapas
Chihuahua
Coahuila
Colima
Ciudad de México
Durango
Guanajuato
Guerrero
Hidalgo
Jalisco
México
Michoacán
Morelos
Nayarit
Nuevo León
Oaxaca
Puebla
Querétaro
Quintana Roo
San Luis Potosí
Sinaloa
Sonora
Tabasco
Tamaulipas
Tlaxcala
Veracruz
Yucatán
Zacatecas

AG
BC
BS
CM
CS
CH
CO
CL
DF
DG
GT
GR
HG
JA
MX
MI
MO
NA
NL
OA
PU
QE
QR
SL
SI
SO
TB
TM
TL
VE
YU
ZA

Request

				
					{
  "origin": {
    "city": "Monterrey",
    "company": "SACR0 DESIGN",
    "country": "MX",
    "district": "MIRAVALLE",
    "email": "sample_sample@drenvio.com",
    "int_number": "2",
    "name": "SAMPLE FULL NAME",
    "number": "282",
    "phone": "8683457800",
    "postal_code": "66250",
    "reference": "SAMPLE DISTRICT",
    "state": "NL",
    "street": "ANTONIO VIVALDI"
  },
  "destination": {
    "city": "Monterrey",
    "company": "PARROQUIA DE NUESTRA SEÑORA DE LA PIEDAD",
    "country": "MX",
    "district": "Piedad Narvarte",
    "email": "sample_sample@drenvio.com",
    "name": "SAMPLE FULL NAME",
    "number": "320",
    "phone": "8683457800",
    "postal_code": "66260",
    "reference": "SAMPLE DISTRICT",
    "state": "NL",
    "street": "Obrero Mundial "
  },
  "shipment": {
    "carrier": "jtexpress",
    "contentExplanation": "EXAMPEL CONTENT",
    "contentQuantity": 1,
    "ObjectId": "code",
    "price": 133.4,
    "service": "ground",
    "ShippingId": "N4"
  },
  "insurance": 0,
  "packages": [
    {
      "content": "ORNAMENTOS O DECORACIONES",
      "contentQuantity": 1,
      "declared_value": 0,
      "height": 10,
      "weight": 1,
      "width": 10,
      "length": 10,
      "type": "box",
      "name": "Paquete enviado de pruebas",
      "volumetric": 0.2,
      "main_weight": 1
    }
  ],
  "service_id": "jtexpress_mx_D-C01_ground",
  "carriers": [
    "jtexpress"
  ]
}

Response

				
					{
    "shipment_status": "Activa",
    "pickups_status": "En espera",
    "_id": "649f036f8b74c6f35e052902",
    "user": "auth0|5f60f5e21e076c00797eee99",
    "origin": {
        "_id": "649f036e8b74c6f35e0528ff",
        "name": "SAMPLE FULL NAME",
        "company": "SACR0 DESIGN",
        "email": "sample_sample@drenvio.com",
        "phone": "8683457800",
        "street": "ANTONIO VIVALDI",
        "number": "282",
        "int_number": "2",
        "district": "MIRAVALLE",
        "city": "Monterrey",
        "state": "NL",
        "country": "MX",
        "postal_code": "66250",
        "reference": "SAMPLE DISTRICT",
        "title": "SAMPLE FULL NAMEdireccion",
        "user": "auth0|5f60f5e21e076c00797eee99"
    },
    "destination": {
        "_id": "649f036e8b74c6f35e052900",
        "name": "SAMPLE FULL NAME",
        "company": "PARROQUIA DE NUESTRA SEÑORA DE LA PIEDAD",
        "email": "sample_sample@drenvio.com",
        "phone": "8683457800",
        "street": "Obrero Mundial ",
        "number": "320",
        "int_number": "0",
        "district": "Piedad Narvarte",
        "city": "Monterrey",
        "state": "NL",
        "country": "MX",
        "postal_code": "66260",
        "reference": "SAMPLE DISTRICT",
        "title": "SAMPLE FULL NAMEdireccion",
        "user": "auth0|5f60f5e21e076c00797eee99"
    },
    "packages": [
        {
            "_id": "649f036e8b74c6f35e052901",
            "weight": 1,
            "height": 10,
            "width": 10,
            "length": 10,
            "declared_value": 0,
            "volumetric": 0.2,
            "type": "box",
            "content": "ORNAMENTOS O DECORACIONES",
            "name": "ORNAMENTOS O DECORACIONES",
            "main_weight": 1,
            "user": "auth0|5f60f5e21e076c00797eee99"
        }
    ],
    "label": "https://storage.googleapis.com/download/storage/v1/b/drenvio-8741f.appspot.com/o/jtexpress%2FUAT301007251337?generation=1688142703394521&alt=media",
    "shipping_id": "N4",
    "carrier": "jtexpress",
    "service": "ground",
    "service_id": "jtexpress_mx_D-C01_ground",
    "price": 133.4,
    "insurance": 0,
    "tracking": "UAT301007251337",
    "metadata": {
        "format": "PDF_4_6",
        "extended_area": false,
        "jtexpress": {
            "txlogisticId": "1688142698350"
        }
    },
    "created_at": "2023-06-30T16:31:43.681Z"
}
On this page