Skip to main content
API docs by Redocly

Enviame API (3.0.0)

Download OpenAPI specification:Download

License: Apache 2.0

Intro

Hola mundo, esta es la nueva definición de la API v3 de Enviame.

Autenticación

Antes de usar esta versión de la API, debes solicitar una configuración inicial de la cuenta de tu empresa a nuestro equipo de soporte. Se te proporcionará un ejemplo de cURL para una aplicación Auth0 que habremos creado para ti (disculpa esta forma poco sofisticada, estamos trabajando en una mejor configuración). La aplicación Auth0 proporciona tokens de acceso válidos para llamar a nuestros métodos de API.

Retiros

Obtener retiros como Empresa/Seller

Lista todos los retiros creados por una Empresa/Seller.

path Parameters
shipper_id
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
Accept
required
string
Default: application/json

No modificar

Authorization
required
string
Default: Bearer xxxxx

Token Bearer para autenticación

Request Body schema: application/json
required
code
integer
Array of objects

Request samples

Content type
application/json
{
  • "code": 201,
  • "data": [
    ]
}

Crear retiro como Empresa/Seller

Endpoint para crear retiros como Empresa/Seller. La respuesta depende de la disponibilidad de cada carrier.

path Parameters
shipper_id
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
Accept
required
string
Default: application/json

No modificar

Authorization
required
string
Default: Bearer xxxxx

Token Bearer para autenticación

Request Body schema: multipart/form-data
required
carrier_code
required
string

Código del carrier al cual se solicitará el retiro.

warehouse_code
required
string

Código de la bodega desde la cual se solicitará el retiro.

qty
required
number <int64>

Cantidad de paquetes

contact_name
required
string

Nombre del contacto responsable del retiro.

contact_phone
required
string

Número de teléfono del contacto responsable del retiro.

warehouse_contact_email
string <email>

Correo electrónico del contacto responsable del retiro en la bodega.

range_time
required
string

Rango de horario para el retiro (Ej: 13:00 - 14:00)

pick_up_date
required
string <date>

Fecha del retiro en formato AAAA-MM-DD.

information
string <= 250 characters

Información adicional para agregar al retiro.

weight
required
integer

Peso (Kg) de los paquetes.

size
required
string

Tamaño de los paquetes (xs, s, m, l, c)

width
integer

Ancho de los paquetes. Requerido cuando el tamaño es "c"

length
integer

Largo de los paquetes. Requerido cuando el tamaño es "c"

height
integer

Alto de los paquetes. Requerido cuando el tamaño es "c"

description
string <= 250 characters

Descripción de los paquetes. Requerido cuando el tamaño es "c"

Responses

Request samples

Content type
multipart/form-data
{
  "carrier_code": "BLX",
  "warehouse_code": "bod_ruka1",
  "weight": 5,
  "qty": 4,
  "contact_name": "Usuario Bodega",
  "contact_phone": 987654321,
  "warehouse_contact_email": "contacto@bodega.com",
  "range_time": "13:00 - 14:00",
  "pick_up_date": "2026-03-01",
  "size": "c",
  "width": 80,
  "length": 80,
  "height": 80,
  "information": "Este es un retiro",
  "description": "Requerido porque es tipo c"
}

Response samples

Content type
application/json
{
  • "code": 201,
  • "data": {
    }
}

Crear retiro de devolución como Empresa/Seller

Endpoint para crear retiros de devolución como Empresa/Seller. La respuesta depende de la disponibilidad de cada carrier.

path Parameters
shipper_id
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
Accept
required
string
Default: application/json

No modificar

Authorization
required
string
Default: Bearer xxxxx

Token Bearer para autenticación

Request Body schema: application/json
required
carrier_code
required
string

Código del carrier al cual se solicitará el retiro.

return_deliveries
required
Array of strings

OTs de las devoluciones.

qty
required
integer

Cantidad de paquetes

weight
required
integer

Peso (Kg) de los paquetes.

required
object
pick_up_date
required
string <date>

Fecha del retiro en formato AAAA-MM-DD.

contact_name
required
string

Nombre del contacto responsable del retiro.

contact_phone
required
string

Número de teléfono del contacto responsable del retiro.

range_time
required
string

Rango de horario del retiro (Ej: 13:00 - 14:00)

information
required
string <= 250 characters

Información adicional para agregar al retiro de devolución.

size
required
string

Tamaño de los paquetes (xs, s, m, l, c)

width
integer

Ancho de los paquetes. Requerido cuando el tamaño es "c"

length
integer

Largo de los paquetes. Requerido cuando el tamaño es "c"

height
integer

Alto de los paquetes. Requerido cuando el tamaño es "c"

description
string <= 250 characters

Descripción de los paquetes. Requerido cuando el tamaño es "c"

Responses

Request samples

Content type
application/json
{
  • "carrier_code": "CHX",
  • "qty": 1,
  • "weight": 1,
  • "address": {
    },
  • "pick_up_date": "2026-01-02",
  • "contact_name": "Nombre del contacto",
  • "contact_phone": "999999999",
  • "range_time": "15:00 - 16:00",
  • "size": "c",
  • "length": 80,
  • "width": 80,
  • "height": 80,
  • "information": "Caja grande",
  • "description": "Paquete de prueba",
  • "return_deliveries": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 201,
  • "data": {
    }
}

Exportar retiros

Exportar retiros a un archivo Excel

Request Body schema: application/json
required
pickup_date_from
string <date>

Fecha desde

pickup_date_to
string <date>

Fecha hasta

pickup_date
string <date>

Si se establece este parámetro, los parámetros pickup_date_from y pickup_date_to serán ignorados.

updated_at_from
string <date>

Fecha de última actualización desde

updated_at_to
string <date>

Fecha de última actualización hasta

shipper_id
integer <int64>

ID del Shipper

organization_id
integer <int64>

ID de la Organización

carrier_code
string

Código del carrier

carrier_pickup_number
string

Número de retiro del carrier

status_code
Array of strings
Items Enum: "scheduled" "done" "failed" "canceled"

Estados de los retiros a exportar

type
string
Value: "return"

Tipos de retiros

Responses

Request samples

Content type
application/json
{
  • "pickup_date_from": "2019-08-24",
  • "pickup_date_to": "2019-08-24",
  • "pickup_date": "2019-08-24",
  • "updated_at_from": "2019-08-24",
  • "updated_at_to": "2019-08-24",
  • "shipper_id": 0,
  • "organization_id": 0,
  • "carrier_code": "string",
  • "carrier_pickup_number": "string",
  • "status_code": [
    ],
  • "type": "return"
}

Response samples

Content type
application/json
{}

PUDOs

Listar PUDOs por lugar

Obtiene una lista de PUDOs, basada en el lugar proporcionado.

query Parameters
type
required
string
Enum: "store" "courier"
Example: type=store

El tipo de PUDOs que desea recuperar.

place_name
required
string

Especifica el nombre de la unidad administrativa geográfica más pequeña para el país especificado. Para Chile, se refiere al nombre de la comuna; para Colombia, corresponde al municipio; para Perú, se refiere al nombre del distrito. En el caso de México, este parámetro acepta el nombre de cualquier división administrativa como colonia, ciudad, municipio o estado.

parent_place_name
string

requerido: solo para Colombia y Perú.

Especifica el nombre de la división administrativa padre del lugar dado para el país especificado. Para Chile y Perú, se refiere al nombre de la provincia; para Colombia, corresponde al departamento. En el caso de México, este parámetro se ignora y no es necesario.

place_level_name
string
Enum: "state" "municipality" "city" "neighborhood"
Example: place_level_name=city

requerido: solo para México.

Nombre de la subdivisión geográfica correspondiente al lugar enviado.

zip_code
string

aplica: solo para México.

El código postal de la colonia. Si se proporciona este campo, se asume que el lugar corresponde a una colonia.

page
integer

El número de página a partir del cual se mostrarán los resultados de búsqueda.

limit
integer

Por defecto 20 por página.

Número de resultados por página.

header Parameters
Authorization
required
string
Default: Bearer xxxxx

Token Bearer para autenticación

Responses

Response samples

Content type
application/json
Example
{
  • "status": "success",
  • "message": "PUDOs obtained successfully",
  • "paging": {
    },
  • "data": [
    ]
}

Tickets

Obtener todos los tickets

Obtener una lista de tickets.

query Parameters
delivery_id
integer <int64>

ID del envío

current_type
string

tipo actual del ticket

current_status
string

estado actual del ticket

page
integer <int64>

número de página a recuperar

limit
integer <int64>

número de tickets por página a recuperar

delivery_status
string

filtrar ticket por estado actual del envío

ticket_mode
string
Enum: "delivery" "return"

filtrar por modo de ticket (delivery o return)

order_by
string
Enum: "CREATED_AT_ASC" "CREATED_AT_DESC" "LAST_MESSAGE_ASC" "LAST_MESSAGE_DESC" "WAITING_DAYS_ASC" "WAITING_DAYS_DESC"

ordenar por un campo específico. Los campos disponibles son: CREATED_AT_ASC, CREATED_AT_DESC, LAST_MESSAGE_ASC, LAST_MESSAGE_DESC, WAITING_DAYS_ASC, WAITING_DAYS_DESC

created_at_from
string

filtrar tickets creados desde una fecha en zona horaria UTC

created_at_to
string

filtrar tickets creados hasta una fecha en zona horaria UTC

country
string
Enum: "CL" "PE" "CO" "MX"

filtrar tickets donde el carrier es del país especificado

carrier
string

filtrar tickets por código de carrier

shipper
string

filtrar tickets por código de shipper

shipper_id
string

filtrar tickets por ID de shipper

current_status_date_from
string

filtrar tickets donde la fecha de su estado actual es igual o mayor a una fecha especificada en UTC

current_status_date_to
string

filtrar tickets donde la fecha de su estado actual es igual o menor a una fecha especificada en UTC

current_type_date_from
string

filter tickets where the date of their current subject is equal to or less than a specified date in utc

current_type_date_to
string

filtrar tickets donde la fecha de su asunto actual es igual o menor a una fecha especificada en UTC

current_stage_date_from
string

filtrar tickets donde la fecha de su etapa actual es igual o menor a una fecha especificada en UTC

current_stage_date_to
string

filtrar tickets donde la fecha de su etapa actual es igual o menor a una fecha especificada en UTC

last_message_from
string

filtrar tickets donde la fecha de su último mensaje es igual o menor a una fecha especificada en UTC

last_message_to
string

filtrar tickets donde la fecha de su último mensaje es igual o menor a una fecha especificada en UTC

current_stage
string
Enum: "ISSUE" "COMPLAINT" "COMPENSATION" "CLOSED" "DISAGREEMENT"

filtrar tickets por etapa actual

fulfillment
boolean

filtrar tickets por tipo de cumplimiento

organization
string

filtrar tickets por código de organización

organization_id
integer <int64>

filtrar tickets por ID de organización

read_client
boolean

filtrar tickets donde el último mensaje ha sido leído o no por el cliente

read_agent
boolean

filtrar tickets donde el último mensaje ha sido leído o no por el agente

header Parameters
Authorization
required
string
Default: Bearer xxxxx

Token Bearer para autenticación

Responses

Response samples

Content type
application/json
{
  • "status": "fail",
  • "message": "string",
  • "errors": [
    ]
}

Obtener detalles del ticket por ID de envío

Obtener un ticket por ID de envío.

path Parameters
delivery_id
required
integer <int64>

ID del envío

header Parameters
Authorization
required
string
Default: Bearer xxxxx

Token Bearer para autenticación

Responses

Response samples

Content type
application/json
{
  • "status": "fail",
  • "message": "string",
  • "errors": [
    ]
}

Crear un mensaje para un ticket

Crear un mensaje para un ticket.

path Parameters
delivery_id
required
integer <int64>

ID del envío

header Parameters
Authorization
required
string
Default: Bearer xxxxx

Token Bearer para autenticación

Request Body schema: application/json
required
message
string

El mensaje a enviar.

timezone
string

La zona horaria del mensaje.

object
object

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "timezone": "string",
  • "type": {
    },
  • "extra_fields": {
    }
}

Response samples

Content type
application/json
{
  • "status": "fail",
  • "message": "string",
  • "errors": [
    ]
}

Envíos

Actualización manual de estado

Permite la actualización manual del estado de un envío (delivery o return). Por defecto, esto solo está permitido para transporte interno (INT), a menos que la empresa u organización tenga habilitada la configuración de carrier externo.

path Parameters
delivery_id
required
integer

ID interno del envío.

header Parameters
Authorization
required
string
Default: Bearer xxxxx

Token Bearer para autenticación

Request Body schema: application/json
required
required
object
status
required
integer

ID del nuevo estado.

info
string

Información adicional sobre el cambio.

user
string

Correo electrónico del usuario que realiza el cambio (opcional, por defecto el usuario del token).

date
string

Fecha del cambio (YYYY-MM-DD HH:MM:SS).

object

Datos de respaldo (opcional).

Responses

Request samples

Content type
application/json
{
  • "status_change": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Status updated successfully"
}

Obtener tracking de envío y devolución

Obtiene el tracking de un envío usando su identificador (delivery_id, imported_id o tracking_number).

path Parameters
identifier
required
string

delivery_id, imported_id o tracking_number.

header Parameters
Authorization
required
string
Default: Bearer xxxxx

Token Bearer para autenticación

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crear envío

Endpoint para crear envíos para una Empresa.

path Parameters
company_id
required
integer <int64>

ID de la Empresa, generado por Enviame

header Parameters
Accept
required
string
Default: application/json

No modificar

Content-Type
required
string
Default: application/json

No modificar

Authorization
required
string
Default: Bearer xxxxx

Token Bearer para autenticación

Request Body schema:

Crear un nuevo envío

object
object
object
object
object
Array of objects


Permitir arreglo vacío

Request samples

Content type
{
  • "shipping_order": {
    },
  • "shipping_origin": {
    },
  • "shipping_destination": {
    },
  • "dimensions": {
    },
  • "carrier": {
    },
  • "extra_fields": [
    ]
}

Devoluciones

Crear devolución

path Parameters
id_seller
required
integer

ID del Seller

header Parameters
Authorization
required
string
Default: Bearer xxxxx

Token Bearer para autenticación

Request Body schema: application/json
required
required
object or object

Origen de la devolución (domicilio o PUDO/agencia)

required
object or object

Destino de la devolución (domicilio o bodega)

required
object
required
object

Responses

Request samples

Content type
application/json
Example
{
  • "origin": {
    },
  • "destination": {
    },
  • "order": {
    },
  • "carrier": {
    }
}

Response samples

Content type
application/json
{
  • "code": "success",
  • "message": "OK",
  • "data": {
    },
  • "errors": [ ]
}

Crear devolución desde un envío existente

path Parameters
id_seller
required
integer

ID del Seller

delivery_id
required
integer

ID del envío original

header Parameters
Authorization
required
string
Default: Bearer xxxxx

Token Bearer para autenticación

Request Body schema: application/json
required
object
object

Responses

Request samples

Content type
application/json
{
  • "order": {
    },
  • "carrier": {
    }
}

Response samples

Content type
application/json
{
  • "code": "success",
  • "message": "OK",
  • "data": {
    },
  • "errors": [ ]
}