Generar guia

Esta guía te permite generar una guía de envío utilizando el API de DrEnvio. Incluye información sobre los distintos entornos disponibles, la lista de transportistas compatibles, los parámetros de solicitud, la estructura de la respuesta y más.

Entornos

La API de DrEnvio soporta dos entornos: Producción y Sandbox.

Entorno de Producción: El entorno de producción es donde se procesan los envíos reales. Para utilizar el API de producción, envía tus solicitudes a la siguiente URL:

URL utilizada para la generación de envíos con Redpack y en el caso de Fedex, sólo cuando el ShippingId es G1.

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

URL utilizada para la generación de envíos con las paqueterías restantes.

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

Entorno de Sandbox: El entorno de sandbox se utiliza con fines de prueba. Proporciona datos simulados para ayudarte a desarrollar y probar tu integración antes de pasar a producción. Para utilizar el API de sandbox, envía tus solicitudes a la siguiente URL:

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

API request

Para generar la guía, envía una solicitud POST con un body JSON como este:

{
  "origin": {
    "city": "Monterrey",
    "company": "SACR0 DESIGN",
    "country": "MX",
    "district": "MIRAVALLE",
    "email": "sample_sample@localhost",
    "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@localhost",
    "name": "SAMPLE FULL NAME",
    "number": "320",
    "phone": "8683457800",
    "postal_code": "66260",
    "reference": "SAMPLE DISTRICT",
    "state": "NL",
    "street": "Obrero Mundial "
  },
  "shipment": {
    "carrier": "fedex",
    "contentExplanation": "EXAMPEL CONTENT",
    "contentQuantity": 1,
    "ObjectId": "code",
    "price": 133.4,
    "service": "ground",
    "ShippingId": "N4",
    "satContent": "31181701"
  },
  "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": "fedex_mx_D-C02_ground",
  "carriers": ["fedex"]
}

Descripción de los campos

Campo	Descripción	Tipo	Requerido
origin	Dirección de origen del envío	Object AddressObject	true
destination	Dirección de destino del envío	Object AddressObject	true
shipments	Detalles del envío	Object ShipmentObject	true
packages	Paquetes	Array PackagesObject	true
service_id	Id del servicio seleccionado	string	true
insurance	El seguro del envío (MXN para nacional, USD para internacional)	number	true
carriers	Transportista(s) seleccionado(s) (Proporcionado en la tarifa)	Array de strings	true

Dirección (Object)

El campo last_name solo se utiliza para envíos de 99Minutos que contengan el ShippingId en N11 y para todas las paqueterías que tengan el código A-P10 en el service_id.

Si se deja el campo como opcional, para los envíos con el código A-P10 se rellenará automáticamente con el campo company. Para todos los envíos que no cumplan con las condiciones mencionadas, el campo debe ser ignorado.

Campo	Descripción	Tipo	Requerido
name	Nombre de la persona que realiza/recibe el envío.	string	true
last_name	Apellido de la persona que realiza/recibe el envío.	string	false
company	Empresa de la persona que realiza/recibe el envío, si no se proporciona será NA.	string	true
email	Correo electrónico de la persona que realiza/recibe el envío.	string	true
phone	Número de teléfono de la persona que realiza/recibe el envío.	string	true
street	Calle de la persona que realiza/recibe el envío.	string	true
number	Número del edificio de la dirección.	string	true
int_number	Número interior del edificio de la dirección.	string	false
district	Distrito de la dirección.	string	true
city	Ciudad de la dirección.	string	true
country	Siempre MX hasta la próxima actualización importante.	string	true
reference	Una referencia para ayudar a encontrar la dirección, si no se proporciona será NA.	string	true
state	Código de estado de 2 dígitos de la dirección, se pueden encontrar aquí.	StateCode Enum	true
postalCode	Código postal de 5 dígitos de la dirección.	string	true

Paquete (Object)

Campo	Descripción	Tipo	Requerido
width	Ancho del paquete en CM.	number	true
height	Altura del paquete en CM.	number	true
length	Longitud del paquete en CM.	number	true
weight	Peso del paquete en KG.	number	true
type	El tipo de paquete.	Enum: box, envelope, pallet	true
name	Contenido del paquete.	string	true
content	Contenido del paquete.	string	true
declared_value	Valor declarado del paquete.	number	true
contentQuantity	Cantidad de paquetes.	number	true

Código de Estado (Enum)

Name	StateCode2Digit
Aguascalientes	AG
Baja California	BC
Baja California Sur	BS
Campeche	CM
Chiapas	CS
Chihuahua	CH
Ciudad de México	CX
Coahuila	CO
Colima	CL
Durango	DG
Guanajuato	GT
Guerrero	GR
Hidalgo	HG
Jalisco	JA
Estado de México	EM
Michoacán	MI
Morelos	MO
Nayarit	NA
Nuevo León	NL
Oaxaca	OA
Puebla	PU
Querétaro	QT
Quintana Roo	QR
San Luis Potosí	SL
Sinaloa	SI
Sonora	SO
Tabasco	TB
Tamaulipas	TM
Tlaxcala	TL
Veracruz	VE
Yucatán	YU
Zacatecas	ZA

Envío (Object)

El campo satContent es un código identificador del tipo de producto requerido en México por el SAT, se obtiene con el servicio de Consulta de código de productos del SAT.

Si no se utiliza el servicio mencionado, se puede colocar el código de paquete genérico en sun lugar (ejemplo: satContent: ‘31181701’)

Campo	Descripción	Tipo	Requerido
carrier	Proporcionado en la tarifa	string	true
ObjectId	Proporcionado en la tarifa	string	true
ShippingId	Proporcionado en la tarifa	string	true
service	Proporcionado en la tarifa	string	true
price	Proporcionado en la tarifa	number	true
contentExplanation	Una explicación del contenido del envío, debe incluir los materiales de fabricación	string	true
contentQuantity	Cuántos artículos hay en la caja	number	true
satContent	Código de identificación del tipo de producto que estás enviando	string	true

API 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@localhost",
      "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@localhost",
      "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/fedex%2FUAT301007251337?
  generation=1688142703394521&alt=media",
  "shipping_id": "N4",
  "carrier": "fedex",
  "service": "ground",
  "service_id": "fedex_mx_D-C02_ground",
  "price": 133.4,
  "insurance": 0,
  "tracking": "UAT301007251337",
  "metadata": {
      "format": "PDF_4_6",
      "extended_area": false,
  },
  "created_at": "2023-06-30T16:31:43.681Z"
}