Skip to main content

Enviame API (2.0.0)

Download OpenAPI specification:Download

License: Apache 2.0

Conceptos Generales

En esta documentación encontrarán todos los endpoints disponibles de nuestra API. Para utilizar estos necesitarán su propio ID de Empresa/Seller (id_seller) y su respectivo API Key. En caso de que esten trabajando en la modalidad Marketplace, también necesitarán el ID del Marketplace (marketplace_id) y utilizar su API Key.

  • Los API Key pueden ser encontrados en la sección Mi Empresa/Seller o Mi marketplace de la plataforma de Envíame. Estos endpoints están configurados para ser utilizados en el ambiente de pruebas stage, por lo que utilizan los API Key e IDs correspondientes a ese ambiente. Si de lo contrario, se utilizarán contra el ambiente de producción api, se debe quitar el subdominio stage del endpoint y utilizar tanto la apikey como el ID de Empresa/Seller correspondiente a ese ambiente.
  • Stage: https://stage.api.enviame.io
  • Producción: https://api.enviame.io Si tienen consultas con respecto a esta documentación, escribannos a support@enviame.io

Envios

Crear envio como seller

Endpoint que permite crear envíos para una Empresa/Seller

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Content-Type
required
string
Default: application/json

No se modifica

Request Body schema: application/json

Crear un nuevo envío

object
object
object
object
object
Array of objects

Responses

Request samples

Content type
application/json
Example
{
  • "shipping_order": {
    },
  • "shipping_origin": {
    },
  • "shipping_destination": {
    },
  • "dimensions": {
    },
  • "carrier": {
    }
}

Response samples

Content type
application/json
{}

Crear envio en seller como marketplace

Endpoint que permite crear envios en una Empresa/Seller asociada a un Marketplace, utilizando la api-key de este último para ello

path Parameters
marketplace_id
required
integer <int64>

ID del Marketplace, generado por Enviame

id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
api-key
required
string

Api-Key del Marketplace, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Content-Type
required
string
Default: application/json

No se modifica

Request Body schema: application/json

Crear un nuevo envío como MKP

object
object
object
object
object
Array of objects

Responses

Request samples

Content type
application/json
Example
{
  • "shipping_order": {
    },
  • "shipping_origin": {
    },
  • "shipping_destination": {
    },
  • "dimensions": {
    },
  • "carrier": {
    }
}

Response samples

Content type
application/json
{}

Transformar a multi bulto desde Seller

Endpoint que permite modificar la cantidad de bultos (n_packages) de un envío ya creado en el operador.

path Parameters
delivery_id
required
integer <int64>

ID del envío, generado por Enviame

id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Request Body schema: application/json

Cambiar bultos de un envío

n_packages
integer

Obligatorio / Cantidad de bultos a transformar

Responses

Request samples

Content type
application/json
{
  • "n_packages": 3
}

Response samples

Content type
application/json
{}

Ver envio

Endpoint que permite ver la informacion de un envio de una Empresa/Seller

path Parameters
delivery_id
required
integer <int64>

ID del envío, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

Responses

Response samples

Content type
application/json
{}

Ver envios seller

Endpoint que permite ver la información de todos los envíos de tu Seller/Empresa/Seller. Incluye filtros adicionales para acotar la lista

path Parameters
id_seller_
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

delivery_status_id
integer <int64>

Campo Opcional - ID del estado en Envíame

date_from
date

Campo Opcional - Fecha inicio del rango de búsqueda, formato "YYYY-MM-DD"

date_to
date

Campo Opcional - Fecha fin del rango de búsqueda, formato "YYYY-MM-DD"

page
integer <int64>

Campo Opcional - Número de página a consultar

limit
int <int64>

Campo Opcional - Cantidad de resultados a mostrar por página

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Responses

Response samples

Content type
application/json
{}

Imprimir etiqueta y agregar a manifiesto

Endpoint que permite la generación de la etiqueta de uno o más envíos que ese encuentren en estado Listo para despacho (ID 5) dejándolos en estado Listo para despacho - impreso (ID 26) y asignandolos a un manifiesto.

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Request Body schema: application/json

Imprimir etiqueta y agregar a manifiesto

deliveries
Array of strings

Obligatorio / ID de envíos a generar etiqueta.

type
string

Obligatorio / Tipo de formato de etiquetas (PDF)

labelsPerPage
int

Obligatorio / Cantidad de etiquetas por página.

Responses

Request samples

Content type
application/json
{
  • "deliveries": [
    ],
  • "type": "pdf",
  • "labelsPerPage": 1
}

Ver tracking del envio

Endpoint que permite ver el historial de los estados de un envío de una Empresa/Seller.

path Parameters
delivery_id
required
integer <int64>

ID del envío, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Responses

Response samples

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

Generar un manifiesto

Endpoint que permite generar un manifiesto para una Empresa/Seller, con envios de un mismo carrier y bodega de origen.

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Request Body schema: application/json

Crear un manifiesto

deliveries
Array of strings

Obligatorio / ID de envíos a generar el manifiesto.

Responses

Request samples

Content type
application/json
{
  • "deliveries": [
    ]
}

Cerrar manifiesto

Endpoint que permite cerrar un manifiesto y asi impedir que se puedan agregar más envios a este.

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

id_manifiesto
required
integer <int64>

ID del manifiesto, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Responses

Response samples

Content type
application/json
{}

Eliminar envío

Endpoint que permite eliminar envios, asignandoles el estado Eliminado (ID 12)

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

delivery_id
required
integer <int64>

ID del envío, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Responses

Response samples

Content type
application/json
{
  • "data": "El envío se ha eliminado correctamente"
}

Actualizar estado de un envío de transporte interno

Endpoint para actualizar el estado de los envíos que pertenezcan al operador -Transporte interno-

path Parameters
delivery_id
required
integer <int64>

ID del envío, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Request Body schema: application/json

Cambiar estado de un envío

code
string

Obligatorio / ID del estado que se necesita aplicar al envío

comment
string

Opcional / Comentario que será agregado en el registro de actualización del estado.

change_at
string

Opcional / Fecha que quedará registrada como fecha de actualización de estado

Responses

Request samples

Content type
application/json
{
  • "code": 7,
  • "comment": "Cambio de estado realizado para pruebas",
  • "change_at": "2025-03-18 10:00:00"
}

Response samples

Content type
application/json
{}

Empresa/Seller

Crear Bodega Empresa/Seller

Endpoint que permite crear bodegas para una Empresa/Seller. Es necesario tener al menos una bodega creada para poder generar envíos."

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Content-Type
required
string
Default: multipart/form-data

No se modifica

Request Body schema: multipart/form-data
name
string

Obligatorio / Nombre de la bodega

code
string

Obligatorio / Código alfanumérico de la bodega

place
string

Obligatorio / Comuna (CL) - Ciudad/Municipio (CO)- Distrito (PE) - Colonia (MX) - Municipio (AR) donde está ubicada la bodega

full_address
string

Obligatorio / Dirección completa de la bodega, sin incluir comuna

information
string

Información adicional o complemento de la direccion

contact_name
string

Nombre del contacto de la bodega

contact_phone
string

Número de telefono del contacto

contact_email
string

Correo electronico del contacto

Responses

Request samples

Content type
multipart/form-data
{
  "value": {
    "name": "Bodega Prueba Docu",
    "code": "bod_prueba_docu",
    "place": "Cerrillos",
    "full_address": "Avenida Siempreviva 987",
    "information": "Bodega B5",
    "contact_name": "Cosme Fulanito",
    "contact_phone": 998769876,
    "contact_email": "bodega-prueba@enviame.io"
  }
}

Response samples

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

Ver Empresa/Seller

Endpoint que permite ver la informacion de una Empresa/Seller

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Responses

Response samples

Content type
application/json
{}

Editar bodega de un Seller/Empresa/Seller

Endpoint permite editar una bodega ya creada y asignada a una Empresa/Seller.

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

warehouse_code
required
string

Codigo alfanumerico de la bodega

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Request Body schema: application/json
name
string

Nombre de la bodega

place
string

Obligatorio / Comuna (CL) - Ciudad/Municipio (CO)- Distrito (PE) - Colonia (MX) - Municipio (AR) donde está ubicada la bodega

full_address
string

Dirección de la bodega, sin contar la comuna

Responses

Request samples

Content type
application/json
{
  • "name": "Bodega Prueba Docu",
  • "place": "Cerrillos",
  • "full_address": "Avenida Siempreviva 9870"
}

Response samples

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

Listar Empleados/Usuarios Empresa/Seller

Endpoint para listar los usuarios creados como empleados de una Empresa/Seller

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ],
  • "meta": {
    }
}

Ver una bodega de Empresa/Seller

Endpoint que permite ver los datos de una bodega ya creada en una Empresa/Seller.

path Parameters
id_seller_
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

warehouse_code
required
string

Codigo alfanumerico de la bodega

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Responses

Response samples

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

Listar bodegas Empresa/Seller

Endpoint que permite ver el listado completo de bodegas de una Empresa/Seller

path Parameters
id_seller_
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ],
  • "meta": {
    },
  • "errors": [ ]
}

Listado de carriers Activos en Empresa/Seller

Endpoint que permite listar los carriers asignados a una Empresa/Seller.

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Content-Type
required
string
Default: application/json

No se modifica

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

Eliminar bodega de un seller

Endpoint que permite eliminar bodegas de una Empresa/Seller

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por enviame

warehouse_id
required
integer <int64>

ID de la bodega, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Content-Type
required
string
Default: application/json

No se modifica

Responses

Response samples

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

Retiros

Crear retiro como seller de un Marketplace

Endpoint para programar retiros utilizando la api-key de un Marketplace.
La respuesta depende del horario de corte de cada carrier.

path Parameters
marketplace_id
required
integer <int64>

ID del Marketplace, generado por Enviame

id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
api-key
required
string

Api-Key del Marketplace, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Request Body schema: multipart/form-data
carrier_code
string

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

warehouse_code
string

Obligatorio / Código de la Bodega donde se retirarán los productos.

qty
int <int64>

Obligatorio / Cantidad total de bultos a retirar.

contact_name
string

Obligatorio / Nombre de contacto responsable de retiro (empleado).

contact_phone
string

Obligatorio / Numero telefónico de contacto responsable de retiro (empleado).

range_time
integer

Requerido (AM o PM) / Puede ser AM para retiro antes de as 12 PM o PM para después de las 12 PM.

pickup_date
integer <date>

Opcional / Fecha de retiro en formato AAAA-MM-DD / Al ir vacío se programa para el día siguiente.

weight
integer

Obligatorio / Peso (Kg.) aproximado total de los bultos.

size
string

Obligatorio / "xs, s, m, l, c" / Tamaño total de los bultos

custom_size
string

Opcional/ solo aplica para size = C / Medidas del pallet o carga completa.

Responses

Request samples

Content type
multipart/form-data
{
  "value": {
    "carrier_code": "BLX",
    "warehouse_code": "bod_ruka1",
    "qty": 4,
    "contact_name": "Usuario Bodega",
    "contact_phone": 123456789,
    "range_time": "AM",
    "pickup_date": "21-03-2025",
    "weight": 5,
    "size": "s",
    "custom_size": null
  }
}

Response samples

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

Crear retiro como Empresa/Seller

Endpoint para programar retiros utilizando la api-key de una Empresa/Seller. La respuesta depende del horario de corte de cada carrier.

header Parameters
api-key
required
string

Api-Key del Marketplace, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Request Body schema: multipart/form-data
carrier_code
string

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

warehouse_code
string

Obligatorio / Código de la Bodega donde se retirarán los productos.

qty
int <int64>

Obligatorio / Cantidad total de bultos a retirar.

contact_name
string

Obligatorio / Nombre de contacto responsable de retiro (empleado).

contact_phone
string

Obligatorio / Numero telefónico de contacto responsable de retiro (empleado).

range_time
integer

Requerido (AM o PM) / Puede ser AM para retiro antes de as 12 PM o PM para después de las 12 PM.

pickup_date
integer <date>

Opcional / Fecha de retiro en formato AAAA-MM-DD / Al ir vacío se programa para el día siguiente.

weight
integer

Obligatorio / Peso (Kg.) aproximado total de los bultos.

size
string

Obligatorio / "xs, s, m, l, c" / Tamaño total de los bultos

custom_size
string

Opcional/ solo aplica para size = C / Medidas del pallet o carga completa.

Responses

Request samples

Content type
multipart/form-data
{
  "value": {
    "carrier_code": "BLX",
    "warehouse_code": "bod_ruka1",
    "qty": 4,
    "contact_name": "Usuario Bodega",
    "contact_phone": 123456789,
    "range_time": "AM",
    "pickup_date": "21-03-2025",
    "weight": 5,
    "size": "s",
    "custom_size": null
  }
}

Response samples

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

Listar retiros como Seller

Lista todos los retiros creados por una Empresa/Seller. Solo funciona en ambiente de producción.

path Parameters
id_seller_
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
Accept
required
string
Default: application/json

No se modifica

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

Devoluciones

Crear devolución

Endpoint que permite crear una devolución para una Empresa/Seller.

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Content-Type
required
string
Default: application/json

No se modifica

Request Body schema: application/json
object
object
object
object

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    },
  • "message": "creation success"
}

Ver tracking de devolución

Endpoint que permite ver el historial de los estados de una devolucion de una Empresa/Seller.

path Parameters
imported_id
required
string

Número de envío o referencia con la cual se creó el envío. Tambien se puede utilizar el delivery_id

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    },
  • "message": "success"
}

Crear devolución desde un envío

Endpoint que permite crear una devolucion usando como base los datos de un envío ya creado para una Empresa/Seller.

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

imported_id
required
string

Número de envío o referencia con la cual se creó el envío. Tambien se puede utilizar el delivery_id

header Parameters
api-key
required
string

Api-Key de la Empresa/Seller, generado por Enviame

Content-Type
required
string
Default: application/json

No se modifica

Request Body schema: application/json
object
object

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    },
  • "message": "creation success"
}

Marketplace

Crear Bodega en Empresa/Seller como Marketplace

Endpoint que permite crear bodegas para una Empresa/Seller utilizando el API Key del Marketplace al cual está asociado. Es necesario tener al menos una bodega creada para poder generar envíos.

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

id_Marketplace
required
integer <int64>

ID del Marketplace, generado por Enviame

header Parameters
api-key
required
string

Api-Key del Marketplace, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Request Body schema: multipart/form-data
name
string

Obligatorio / Nombre de la bodega

code
string

Obligatorio / Código alfanumérico de la bodega

place
string

Obligatorio / Comuna (CL) - Ciudad/Municipio (CO)- Distrito (PE) - Colonia (MX) - Municipio (AR) donde está ubicada la bodega

full_address
string

Obligatorio / Dirección completa de la bodega, sin incluir comuna

information
string

Información adicional o complemento de la direccion

contact_name
string

Nombre del contacto de la bodega

contact_phone
string

Número de telefono del contacto

contact_email
string

Correo electronico del contacto

Responses

Request samples

Content type
multipart/form-data
{
  "value": {
    "name": "Bodega Prueba Docu",
    "code": "bod_prueba_docu",
    "place": "Cerrillos",
    "full_address": "Avenida Siempreviva 987",
    "information": "Bodega B5",
    "contact_name": "Cosme Fulanito",
    "contact_phone": 998769876,
    "contact_email": "bodega-prueba@enviame.io"
  }
}

Response samples

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

Editar Bodega de una Empresa/Seller desde Marketplace

Endpoint que permite modificar datos de bodega de una Empresa/Seller asociada a un Marketplace.

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

marketplace_id
required
integer <int64>

ID del Marketplace, generado por Enviame

warehouse_code
required
string

Codigo alfanumerico de la bodega

header Parameters
api-key
required
string

Api-Key del Marketplace, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Request Body schema: application/json
name
string

Nombre de la bodega

place
string

Obligatorio / Comuna (CL) - Ciudad/Municipio (CO)- Distrito (PE) - Colonia (MX) - Municipio (AR) donde está ubicada la bodega

full_address
string

Dirección de la bodega, sin contar la comuna

Responses

Request samples

Content type
application/json
{
  • "name": "Bodega 2",
  • "place": "Cerrillos",
  • "full_address": "Avenida Siempreviva 24"
}

Response samples

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

Eliminar Bodega de una Empresa/Seller desde Marketplace

Endpoint que permite eliminar una de las bodegas de una Empresa/Seller asociada a un Marketplace.

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

marketplace_id
required
integer <int64>

ID del Marketplace, generado por Enviame

warehouse_id
required
integer <int64>

ID de la bodega, generado por Enviame

header Parameters
api-key
required
string

Api-Key del Marketplace, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Responses

Response samples

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

Listar Sellers

Endpoint que permite listar todas las Empresa/Seller asociadas a un Marketplace.

path Parameters
marketplace_id
required
integer <int64>

ID del Marketplace, generado por Enviame

header Parameters
api-key
required
string

Api-Key del Marketplace, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Responses

Response samples

Content type
application/json
{}

Asignar carrier a Empresa/Seller

Endpoint que permite asignar un carrier a una Empresa/Seller, de los que ya tenga asignados el Marketplace.

path Parameters
id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

marketplace_id
required
integer <int64>

ID del Marketplace, generado por Enviame

header Parameters
api-key
required
string

Api-Key del Marketplace, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Request Body schema: application/json

Create a new pet in the store

code
string

Obligatorio / Codigo del carrier

Responses

Request samples

Content type
application/json
{
  • "code": "BLX"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ],
  • "meta": {
    },
  • "errors": [ ]
}

Editar Seller como Marketplace

Endpoint que permite editar datos de una Empresa/Seller perteneciente a un Marketplace

path Parameters
marketplace_id
required
integer <int64>

ID del Marketplace, generado por Enviame

id_seller
required
integer <int64>

ID de la Empresa/Seller, generado por Enviame

header Parameters
api-key
required
string

Api-Key del Marketplace, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Request Body schema: multipart/form-data
name
string

Nombre de la Empresa/Seller

corporate_name
string

Nombre corporativo / Razon social

code
string

Codigo alfanumerico de la Empresa/Seller

dni
string

RUT (DNI) de la Empresa/Seller

website
string

Sitio web de la Empresa/Seller

Responses

Request samples

Content type
multipart/form-data
{
  "value": {
    "name": "Team Akagi",
    "corporate_name": "Akagi Team",
    "code": "akagi",
    "dni": "11.111.111-1",
    "website": "www.akagiteam.cl"
  }
}

Response samples

Content type
application/json
{}

Crear Seller como Marketplace

Endpoint que permite crear una Empresa/Seller en un Marketplace

path Parameters
marketplace_id_
required
integer <int64>

ID del Marketplace, generado por Enviame

header Parameters
api-key
required
string

Api-Key del Marketplace, generado por Enviame

Accept
required
string
Default: application/json

No se modifica

Request Body schema: application/json

Crear seller como marketplace

name
string

Obligatorio / Nombre de la Empresa/Seller

corporate_name
string

Obligatorio / Nombre corporativo / Razon social

code
string

Código alfanumerico que se asignará a la Empresa/Seller

dni
string

Obligatorio / RUT (DNI) de la Empresa/Seller

rule
integer

ID de la regla a asignar, no se ocupa

carrier_code
Array of strings

Listado de couriers a agregar a la Empresa/Seller

Responses

Request samples

Content type
application/json
{
  • "name": "Team Mitsui",
  • "corporate_name": "Mitsui Team",
  • "code": "mitsui_team",
  • "dni": 111111111111,
  • "rule": 0,
  • "carrier_code": [
    ]
}

Response samples

Content type
application/json
{}

Tarifas

Consulta de tarifas

Este endpoint permite consultar tarifas de envío según diversos parámetros. Soporta consultas por peso (kilogramos - kg) y por distancia (kilómetros - km).

query Parameters
from_place_code
required
string

Código de origen (código de comuna CL, código dane CO, ubigueo PE, código postal MX).

to_place_code
required
string

Código de destino (código de comuna CL, código dane CO, ubigueo PE, código postal MX).

from_place
string

Nombre del lugar de origen, disponible para Chile, Colombia y Perú.

to_place
string

Nombre del lugar de destino, disponible para Chile, Colombia y Perú.

from_address
string

Dirección de origen del envío. Solo para tarifas por KM (Chile).

to_address
string

Dirección de destino del envío. Solo para tarifas por KM (Chile).

weight
required
number

Peso del producto en kilogramos (kg).

length
number

Largo del producto en centímetros (cm).

width
number

Ancho del producto en centímetros (cm).

height
number

Alto del producto en centímetros (cm).

volume
number

Volumen del producto en metros cúbicos (m³), solo para Chile.

type
string
Example: type=nextday&type=estandar

Categoría de servicio.

carrier
string

Filtra por un código de carrier específico.

service
string

Filtra por un código de servicio específico de un carrier. Requiere el parámetro carrier.

carriers[]
Array of strings

Filtra por una lista de carriers. Se combina con type. Ejemplo: carriers[]=CARRIER1&carriers[]=CARRIER2.

km_distance
number

Distancia en kilómetros.

declared_value
number

Valor declarado del producto. Obligatorio para CO

header Parameters
x-api-key
required
string

Clave de API del cliente para autenticación.

Responses

Request samples

curl -X GET "https://api.enviame.io/api/v1/prices?weight=1&length=1&width=1&height=1&to_address=HERNANDO%20DE%20AGUIRRE%20268%20OF%20202&from_address=Avenida%20Manquehue%20Norte%201337,%20Local%2011&from_place_code=13101&to_place_code=13101" \
-H "x-api-key: YOUR_API_KEY"

Response samples

Content type
application/json
Example
{
  • "status": "success",
  • "data": [
    ],
  • "meta": {
    }
}