Emisión de Guía

POST

http://ec2-54-188-18-143.us-west-2.compute.amazonaws.com:4000/api/labels

Este endpoint permite generar una guía de envío, proporcionando los datos de origen, destino e información adicional del paquete. La emisión requiere un token de autenticación válido y el identificador (UUID) de la cotización previamente obtenida.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

address_from

object (Address Copy)

required

Dirección del remitente

Example:

{"country_code":"MX","zip_code":"66058"}

name

string

required

Nombre de la persona

street1

string

required

Calle de la casa

neighborhood

string

required

Vecindario/colonia

external_number

string

required

No. exterior de la casa

city

string

required

Ciudad/Delegacion

state

string

required

Estado

phone

string

required

Número de teléfono en caso de requerir contacto

string

required

Dirección de correo electrónico

country

string

required

Pais

country_code

string

required

Código de país (Mexico -> MX)

Example:

reference

string

optional

Referencias de la casa origen/destino, ej. "Enfrente de un oxxo"

company

string

optional

Compañía

address_to

object (Address Copy)

required

Dirección del destinatario

Example:

{"country_code":"MX","zip_code":"66058"}

parcel

object

required

Datos del paquete a enviar (se emite con las medidas puestas en la cotización)

currency

string

required

Moneda del valor del producto

Example:

MXN

distance_unit

string

required

Unidad de medida de distancia

Example:

mass_unit

string

required

Unidad de medida de peso

Example:

product_id

string

required

ID del producto

Example:

01010101

product_value

number

required

Valor del producto (valor mínimo de 1)

>= 1

Example:

4321

quantity_products

integer

required

Cantidad de productos

Example:

content

string

required

Contenido

Example:

GIFT

rate_token

string

required

UUID de la cotización a elegir

label_format

string

optional

Formato de impresión (PDF/THERMAL) por defecto PDF

Example

{
    "address_from": {
        "name": "Fulanito Juarez",
        "street1": "Mercedes",
        "neighborhood": "Barrio Guadalupe",
        "external_number": "243",
        "city": "Iztapalapa",
        "company": "compañia",
        "state": "CDMX",
        "phone": "5518426237",
        "email": "example@example.com",
        "country": "MEXICO",
        "country_code": "MX",
        "reference": "Enfrente de un oxxo"
    },
    "address_to": {
        "name": "Fulanito Juarez",
        "street1": "Mercedes",
        "neighborhood": "Barrio Guadalupe",
        "external_number": "243",
        "company": "compañia",
        "city": "Iztapalapa",
        "state": "CDMX",
        "phone": "5518426237",
        "email": "example@example.com",
        "country": "MEXICO",
        "country_code": "MX",
        "reference": "Enfrente de un oxxo"
    },
    "parcel": {
        "currency": "MXN",
        "product_id": "01010101",
        "product_value": 4324,
        "quantity_products": 1,
        "content": "GIFT"
    },
    "label_format": "THERMAL",
    "rate_token": "RATE_UUID"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://ec2-54-188-18-143.us-west-2.compute.amazonaws.com:4000/api/labels' \
--header 'Content-Type: application/json' \
--data-raw '{
    "address_from": {
        "name": "Fulanito Juarez",
        "street1": "Mercedes",
        "neighborhood": "Barrio Guadalupe",
        "external_number": "243",
        "city": "Iztapalapa",
        "company": "compañia",
        "state": "CDMX",
        "phone": "5518426237",
        "email": "example@example.com",
        "country": "MEXICO",
        "country_code": "MX",
        "reference": "Enfrente de un oxxo"
    },
    "address_to": {
        "name": "Fulanito Juarez",
        "street1": "Mercedes",
        "neighborhood": "Barrio Guadalupe",
        "external_number": "243",
        "company": "compañia",
        "city": "Iztapalapa",
        "state": "CDMX",
        "phone": "5518426237",
        "email": "example@example.com",
        "country": "MEXICO",
        "country_code": "MX",
        "reference": "Enfrente de un oxxo"
    },
    "parcel": {
        "currency": "MXN",
        "product_id": "01010101",
        "product_value": 4324,
        "quantity_products": 1,
        "content": "GIFT"
    },
    "label_format": "THERMAL",
    "rate_token": "RATE_UUID"
}'

Responses

🟢200Success

application/json

Body

token

string

required

created_at

string

required

tracking_number

string

required

label_url

string

required

price

string

required

Example

{
    "token": "82d9a-4490-bf73-1244e00608a5",
    "created_at": "2024-11-04T18:12:45",
    "tracking_number": "794809162",
    "label_url": "http://static.example.com/uploa48299245754-DdcfIeguBdfY38OF0Gw.pdf",
    "price": "100"
}

Obtener cotizacion

Historial de guías