Enviame API (2.0.0)
Download OpenAPI specification:Download
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
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
- Payload
{- "shipping_order": {
- "n_packages": 1,
- "content_description": "Orden CL9712070429",
- "imported_id": "CL9712070429",
- "order_price": 21990,
- "weight": 1,
- "volumen": 1,
- "type": "delivery"
}, - "shipping_origin": {
- "warehouse_code": "bod_sell"
}, - "shipping_destination": {
- "customer": {
- "name": "Cliente Feliz",
- "email": "prueba@enviame.io",
- "phone": 987654321
}, - "delivery_adress": {
- "place": "Curicó",
- "full_address": "Calle Falsa 123",
- "information": "Indicaciones adicionales"
}
}, - "dimensions": {
- "width": 10,
- "height": 10,
- "length": 10
}, - "carrier": {
- "carrier_code": "SKN"
}
}
Response samples
- 200
- 401
{- "status": "success",
- "data": {
- "identifier": 1581956,
- "imported_id": "123",
- "tracking_number": "298623F",
- "status": {
- "id": 5,
- "name": "Listo para despacho",
- "code": "CREATED",
- "info": "Ya creamos tu envío en: STARKEN - ",
- "created_at": "2021-09-24 12:13:23"
}, - "customer": {
- "full_name": "Cliente Feliz",
- "phone": "987654321",
- "email": "prueba@enviame.io"
}, - "shipping_address": {
- "full_address": "Calle Falsa 123",
- "place": "Curicó",
- "type": "home"
}, - "country": "CL",
- "carrier": "STARKEN",
- "service": "priority",
- "label": {
- "ZPL": null,
- "PNG": null
}, - "barcodes": null,
- "deadline_at": null,
- "created_at": "2021-09-24 12:13:22",
- "updated_at": "2021-09-24 12:13:24",
- "links": [
- {
- "rel": "tracking-web",
}
]
}, - "errors": [ ]
}
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
- Payload
{- "shipping_order": {
- "n_packages": 1,
- "content_description": "Orden CL9712070429",
- "imported_id": "CL9712070429",
- "order_price": 21990,
- "weight": 1,
- "volumen": 1,
- "type": "delivery"
}, - "shipping_origin": {
- "warehouse_code": "bod_sell"
}, - "shipping_destination": {
- "customer": {
- "name": "Cliente Feliz",
- "email": "prueba@enviame.io",
- "phone": 987654321
}, - "delivery_adress": {
- "place": "Curicó",
- "full_address": "Calle Falsa 123",
- "information": "Indicaciones adicionales"
}
}, - "dimensions": {
- "width": 10,
- "height": 10,
- "length": 10
}, - "carrier": {
- "carrier_code": "SKN"
}
}
Response samples
- 200
- 401
{- "status": "success",
- "data": {
- "identifier": 1581956,
- "imported_id": "123",
- "tracking_number": "298623F",
- "status": {
- "id": 5,
- "name": "Listo para despacho",
- "code": "CREATED",
- "info": "Ya creamos tu envío en: STARKEN - ",
- "created_at": "2021-09-24 12:13:23"
}, - "customer": {
- "full_name": "Cliente Feliz",
- "phone": "987654321",
- "email": "prueba@enviame.io"
}, - "shipping_address": {
- "full_address": "Calle Falsa 123",
- "place": "Curicó",
- "type": "home"
}, - "country": "CL",
- "carrier": "STARKEN",
- "service": "priority",
- "label": {
- "ZPL": null,
- "PNG": null
}, - "barcodes": null,
- "deadline_at": null,
- "created_at": "2021-09-24 12:13:22",
- "updated_at": "2021-09-24 12:13:24",
- "links": [
- {
- "rel": "tracking-web",
}
]
}, - "errors": [ ]
}
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
- Payload
{- "n_packages": 3
}
Response samples
- 200
- 401
{- "status": "success",
- "data": {
- "identifier": 1812125,
- "imported_id": "pruebasoporte1",
- "tracking_number": "259682",
- "status": {
- "id": 5,
- "name": "Listo para despacho",
- "code": "CREATED",
- "info": "Envio con tracking_number 259682 se ha reinyectado en el carrier como multibulto. - ",
- "created_at": "2025-03-17 09:32:45"
}, - "customer": {
- "full_name": "Prueba Soporte",
- "phone": null,
- "email": null
}, - "shipping_address": {
- "full_address": "Calle Falsa 2345",
- "place": "Santiago",
- "type": "home"
}, - "country": "CL",
- "carrier": "BLUEXPRESS",
- "service": "priority",
- "label": {
- "PNG": null
}, - "barcodes": "259682",
- "deadline_at": "No informada.",
- "created_at": "2025-03-17 09:26:03",
- "updated_at": "2025-03-17 09:32:45",
- "links": [
- {
- "rel": "tracking-web",
}
]
}
}
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
- 200
- 401
{- "status": "success",
- "data": {
- "identifier": 1812125,
- "imported_id": "pruebasoporte1",
- "tracking_number": "259682",
- "status": {
- "id": 5,
- "name": "Listo para despacho",
- "code": "CREATED",
- "info": "Envio con tracking_number 259682 se ha reinyectado en el carrier como multibulto. - ",
- "created_at": "2025-03-17 09:32:45"
}, - "customer": {
- "full_name": "Prueba Soporte",
- "phone": null,
- "email": null
}, - "shipping_address": {
- "full_address": "Calle Falsa 2345",
- "place": "Santiago",
- "type": "home"
}, - "country": "CL",
- "carrier": "BLUEXPRESS",
- "service": "priority",
- "label": {
- "PNG": null
}, - "barcodes": "259682",
- "deadline_at": "No informada.",
- "created_at": "2025-03-17 09:26:03",
- "updated_at": "2025-03-17 09:32:45",
- "links": [
- {
- "rel": "tracking-web",
}
]
}
}
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
- 200
- 401
{- "status": "success",
- "data": [
- {
- "identifier": 1812125,
- "imported_id": "pruebasoporte1",
- "tracking_number": "259682",
- "status": {
- "id": 5,
- "name": "Listo para despacho",
- "code": "CREATED",
- "info": "Envio con tracking_number 259682 se ha reinyectado en el carrier como multibulto. - ",
- "created_at": "2025-03-17 09:32:45"
}, - "customer": {
- "full_name": "Prueba Soporte",
- "phone": null,
- "email": null
}, - "shipping_address": {
- "full_address": "Calle Falsa 2345",
- "place": "Santiago",
- "type": "home"
}, - "country": "CL",
- "carrier": "BLUEXPRESS",
- "service": "priority",
- "label": {
- "ZPL": {
- "raw": null,
}, - "PNG": null
}, - "barcodes": "259682",
- "deadline_at": "No informada.",
- "created_at": "2025-03-17 09:26:03",
- "updated_at": "2025-03-17 09:32:45",
- "links": [
- {
- "rel": "tracking-web",
}
]
}, - {
- "identifier": 1797285,
- "imported_id": "19134",
- "tracking_number": "245619",
- "status": {
- "id": 5,
- "name": "Listo para despacho",
- "code": "CREATED",
- "info": "Ya creamos tu envío en: STARKEN - ",
- "created_at": "2024-10-28 13:18:29"
}, - "customer": {
- "full_name": "Daniela karina Fuentes perez",
- "phone": "966847822",
- "email": "danielakrt@gmail.com"
}, - "shipping_address": {
- "full_address": "TENIENTE MERINO CON HUAQUEN 881",
- "place": "La Ligua",
- "type": "home"
}, - "country": "CL",
- "carrier": "STARKEN",
- "service": "normal",
- "label": {
- "ZPL": {
- "raw": null,
}, - "PNG": null
}, - "barcodes": "245619",
- "deadline_at": "No informada.",
- "created_at": "2024-10-28 13:17:10",
- "updated_at": "2024-10-28 13:18:29",
- "links": [
- {
- "rel": "tracking-web",
}
]
}, - {
- "identifier": 1780508,
- "imported_id": "848",
- "tracking_number": "No informado",
- "status": {
- "id": 4,
- "name": "Rechazado por Carrier",
- "code": "PENDING",
- "info": "Envio rechazado por carrier - ",
- "created_at": "2024-05-29 16:35:54"
}, - "customer": {
- "full_name": "Matías Alarcón",
- "phone": "940286302",
- "email": "matiasyanezalarcon@gmail.com"
}, - "shipping_address": {
- "full_address": "Arlegui 469 Oficina 15",
- "place": "Algarrobo",
- "type": "home"
}, - "country": "CL",
- "carrier": "STARKEN",
- "service": "normal",
- "label": {
- "PDF": null,
- "ZPL": {
- "raw": null,
- "url": null
}, - "PNG": null
}, - "barcodes": null,
- "deadline_at": "No informada.",
- "created_at": "2024-04-25 09:34:13",
- "updated_at": "2024-05-29 15:35:54",
- "links": [
- {
- "rel": "tracking-web",
}
]
}
], - "meta": {
- "pagination": {
- "total_pages": 10,
- "total": 30,
- "per_page": 3,
- "current_page": 1,
- "count": 3
}
}
}
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
- Payload
{- "deliveries": [
- 1812125
], - "type": "pdf",
- "labelsPerPage": 1
}
Response samples
- 200
- 401
{- "status": "success",
- "data": {
- "carrier": "BLUEXPRESS",
- "summary_id": 2706
}
}
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
- 200
- 401
{- "data": {
- "identifier": 1812125,
- "imported_id": "pruebasoporte1",
- "tracking_number": "259682",
- "status": {
- "id": 26,
- "name": "Listo para despacho - Impreso",
- "code": "CREATED",
- "info": "Etiqueta impresa",
- "created_at": "2025-03-17 17:22:51"
}, - "customer": {
- "full_name": "Prueba Soporte",
- "phone": null,
- "email": null
}, - "shipping_address": {
- "full_address": "Calle Falsa 2345",
- "place": "Santiago",
- "type": "home"
}, - "country": "CL",
- "carrier": "BLUEXPRESS",
- "service": "priority",
- "label": {
- "PNG": null
}, - "barcodes": "259682",
- "tracking": [
- {
- "status_id": 26,
- "code": "CREATED",
- "name": "Listo para despacho - Impreso",
- "comment": "Etiqueta impresa",
- "created_at": "2025-03-17 17:22:51"
}, - {
- "status_id": 5,
- "code": "CREATED",
- "name": "Listo para despacho",
- "comment": "Envio con tracking_number 259682 se ha reinyectado en el carrier como multibulto.",
- "created_at": "2025-03-17 09:32:45"
}, - {
- "status_id": 5,
- "code": "CREATED",
- "name": "Listo para despacho",
- "comment": "Ya creamos tu envío en: BLUEXPRESS ",
- "created_at": "2025-03-17 09:26:12"
}, - {
- "status_id": 1,
- "code": "PENDING",
- "name": "Creado",
- "comment": "Envio creado por api",
- "created_at": "2025-03-17 09:26:04"
}
], - "deadline_at": "No informada.",
- "created_at": "2025-03-17 09:26:03",
- "updated_at": "2025-03-17 09:32:45"
}
}
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
- Payload
{- "deliveries": [
- 1812125
]
}
Response samples
- 200
- 401
{- "data": {
- "carrier": "BLUEXPRESS",
- "summary_id": 2706
}
}
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
- 200
- 401
{- "data": {
- "id": 2706,
- "firestore_id": null,
- "company_id": 1402,
- "carrier_id": 31,
- "warehouse_id": 2757,
- "delivery_label_print_status_id": 2,
- "description": "202503170522_1402_2757_31_SERpriority_express",
- "type": 1,
- "deliveries": [
- 1812125
], - "carrier_services": "",
- "user_id": 3823,
- "active": false,
- "voucher": null,
- "has_voucher": null,
- "extra_fields": null,
- "deleted_at": null,
- "created_at": "2025-03-17 17:22:46",
- "updated_at": "2025-03-18 09:41:44",
- "deliveries_backup": [
- 1812125
], - "closed_at": null,
- "creator_email": null,
- "summary_origin": "api",
- "countDeliveries": 1
}
}
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
- 200
- 401
{- "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
- Payload
{- "code": 7,
- "comment": "Cambio de estado realizado para pruebas",
- "change_at": "2025-03-18 10:00:00"
}
Response samples
- 200
- 401
{- "data": {
- "identifier": 1812125,
- "imported_id": "pruebasoporte1",
- "tracking_number": "259682",
- "status": {
- "id": 7,
- "name": "En tránsito",
- "code": "IN_TRANSIT",
- "info": "Cambio de estado realizado para pruebas - ",
- "created_at": "2025-03-18 10:00:00"
}, - "customer": {
- "full_name": "Prueba Soporte",
- "phone": null,
- "email": null
}, - "shipping_address": {
- "full_address": "Calle Falsa 2345",
- "place": "Santiago",
- "type": "home"
}, - "country": "CL",
- "carrier": "BLUEXPRESS",
- "service": "priority",
- "label": {
- "PNG": null
}, - "barcodes": "259682",
- "deadline_at": "No informada.",
- "created_at": "2025-03-17 09:26:03",
- "updated_at": "2025-03-17 09:32:45",
- "links": [
- {
- "rel": "tracking-web",
}
]
}
}
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
- Payload
{ "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
- 201
- 500
{- "status": "success",
- "data": {
- "identifier": 18030,
- "marketplace_creator": 1402,
- "marketplace_exclusive": false,
- "is_active": true,
- "name": "Bodega Prueba Docu",
- "code": "bod_prueba_docu",
- "contact_name": "Cosme Fulanito",
- "contact_phone": 998769876,
- "contact_email": "bodega-prueba@enviame.io",
- "address": {
- "place": "Cerrillos",
- "place_id": 105,
- "full_address": "Avenida Siempreviva 987",
- "information": "Bodega B5",
- "zip_code": null,
- "latitude": null,
- "longitude": null
}, - "created_at": "2025-03-18 14:32:54",
- "updated_at": "2025-03-18 14:32:54",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}
]
}, - "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
- 200
- 500
{- "status": "success",
- "data": {
- "identifier": 1402,
- "name": "capsula",
- "corporate_name": "capsule corp",
- "dni": 199875629,
- "website": null,
- "activated": 1,
- "logo": null,
- "code": "capsula",
- "country": "CL",
- "rule": null,
- "created_at": "2021-06-21 18:32:57",
- "updated_at": "2023-06-27 18:03:28",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}, - {
- "rel": "companies.employees",
}, - {
- "rel": "companies.warehouses",
}, - {
- "rel": "companies.carriers",
}
]
}, - "errors": [ ]
}
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
- Payload
{- "name": "Bodega Prueba Docu",
- "place": "Cerrillos",
- "full_address": "Avenida Siempreviva 9870"
}
Response samples
- 200
- 401
- 500
{- "status": "success",
- "data": {
- "identifier": 18030,
- "marketplace_creator": 1402,
- "marketplace_exclusive": false,
- "is_active": true,
- "name": "Bodega Prueba Docu",
- "code": "bod_prueba_docu",
- "contact_name": "Cosme Fulanito",
- "contact_phone": 998769876,
- "contact_email": "bodega-prueba@enviame.io",
- "address": {
- "place": "Cerrillos",
- "place_id": 105,
- "full_address": "Avenida Siempreviva 9870",
- "information": "Bodega B5",
- "zip_code": null,
- "latitude": null,
- "longitude": null
}, - "created_at": "2025-03-18 14:32:54",
- "updated_at": "2025-03-18 14:32:54",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}
]
}, - "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
- 200
- 401
- 500
{- "status": "success",
- "data": [
- {
- "identifier": 1311,
- "marketplace_creator": null,
- "marketplace_exclusive": false,
- "is_active": false,
- "first_name": "René",
- "first_last": null,
- "full_name": "René Álvarez",
- "email": "rene.alvarez@acroventus.com",
- "phone": 56934104505,
- "mobile": 56934104505,
- "position": null,
- "created_at": "2021-07-07 22:08:56",
- "updated_at": "2021-07-07 22:08:56",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}
]
}, - {
- "identifier": 3288,
- "marketplace_creator": null,
- "marketplace_exclusive": false,
- "is_active": false,
- "first_name": "Usuario",
- "first_last": null,
- "full_name": "Usuario Documentacion",
- "email": "documentaciones@enviame.io",
- "phone": null,
- "mobile": null,
- "position": null,
- "created_at": "2025-03-19 12:26:56",
- "updated_at": "2025-03-19 12:26:56",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}
]
}
], - "meta": {
- "pagination": {
- "total": 2,
- "count": 2,
- "per_page": 15,
- "current_page": 1,
- "total_pages": 1,
- "links": { }
}
}
}
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
- 200
- 401
- 500
{- "status": "success",
- "data": {
- "identifier": 18030,
- "marketplace_creator": 1402,
- "marketplace_exclusive": false,
- "is_active": true,
- "name": "Bodega Prueba Docu",
- "code": "bod_prueba_docu",
- "contact_name": "Cosme Fulanito",
- "contact_phone": 998769876,
- "contact_email": "bodega-prueba@enviame.io",
- "address": {
- "place": "Cerrillos",
- "place_id": 105,
- "full_address": "Avenida Siempreviva 9870",
- "information": "Bodega B5",
- "zip_code": null,
- "latitude": null,
- "longitude": null
}, - "created_at": "2025-03-18 14:32:54",
- "updated_at": "2025-03-18 14:32:54",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}
]
}, - "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
- 201
- 401
- 500
{- "status": "success",
- "data": [
- {
- "identifier": 3121,
- "marketplace_creator": 1402,
- "marketplace_exclusive": false,
- "is_active": false,
- "name": "Bodega Suc1",
- "code": 3125060,
- "contact_name": null,
- "contact_phone": null,
- "contact_email": null,
- "address": {
- "place": "Quilicura",
- "place_id": 320,
- "full_address": "Hidalgo 1208",
- "information": null,
- "zip_code": null,
- "latitude": null,
- "longitude": null
}, - "created_at": "2022-02-10 17:10:31",
- "updated_at": "2022-02-10 17:10:31",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}
]
}, - {
- "identifier": 18030,
- "marketplace_creator": 1402,
- "marketplace_exclusive": false,
- "is_active": true,
- "name": "Bodega Prueba Docu",
- "code": "bod_prueba_docu",
- "contact_name": "Cosme Fulanito",
- "contact_phone": 998769876,
- "contact_email": "bodega-prueba@enviame.io",
- "address": {
- "place": "Cerrillos",
- "place_id": 105,
- "full_address": "Avenida Siempreviva 9870",
- "information": "Bodega B5",
- "zip_code": null,
- "latitude": null,
- "longitude": null
}, - "created_at": "2025-03-18 14:32:54",
- "updated_at": "2025-03-18 14:32:54",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}
]
}
], - "meta": {
- "pagination": {
- "total": 2,
- "count": 2,
- "per_page": 15,
- "current_page": 1,
- "total_pages": 1,
- "links": { }
}
}, - "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
- 201
- 401
- 500
{- "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
- 201
- 500
{- "status": "success",
- "data": {
- "identifier": 2758,
- "marketplace_creator": 1402,
- "marketplace_exclusive": false,
- "is_active": true,
- "name": "bodega capsula 2",
- "code": "bod_capsula2",
- "contact_name": null,
- "contact_phone": null,
- "contact_email": null,
- "address": {
- "place": "Quilicura",
- "place_id": 320,
- "full_address": "direccion completa nueva 2",
- "information": null,
- "zip_code": null,
- "latitude": null,
- "longitude": null
}, - "created_at": "2021-06-21 22:37:57",
- "updated_at": "2025-03-20 15:09:38",
- "deleted_at": "2025-03-20 15:09:38",
- "links": [
- {
- "rel": "self",
}
]
}, - "errors": [ ]
}
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
- Payload
{ "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
- 200
- 422
- 500
{- "code": 201,
- "data": {
- "identifier": "1285372591218",
- "company": {
- "id": 2279,
- "code": "DEV",
- "name": "Development",
- "dni": 106719926
}, - "address": {
- "place_id": 378,
- "full_address": "Avenida Vitacura 123",
- "place": "Santiago",
- "information": "H23",
- "place_parents": {
- "parent1": {
- "id": 61,
- "name": "Santiago",
- "level_name": "Provincia"
}, - "parent2": {
- "id": 7,
- "name": "Metropolitana de Santiago",
- "level_name": "Region"
}
}, - "place_level_name": "Comuna",
- "zip_code": null
}, - "carrier": {
- "code": "BLX",
- "name": "Bluexpress",
- "country": "CL",
- "is_integrated": 1,
- "time_zome": "America/Santiago",
- "config": {
- "time_limit": "10:29",
- "time_limit_key": "default"
}
}, - "range_time": "13:00 - 18:00",
- "qty": 7,
- "weight": 10,
- "contact": {
- "name": "John Doe",
- "phone": 999999999
}, - "status": {
- "code": "created",
- "name": "retiro creado",
- "date": "2025-04-04 16:50:11"
}, - "created_at": "2025-04-04 16:50:11",
- "updated_at": "2025-04-04 16:50:11",
- "deleted_at": null,
- "uuid": "d3e8a7ae-5a2a-43b3-a77b-e8c0a3e1718a",
- "marketplace": {
- "id": 10,
- "code": "enviame",
- "name": "Envíame"
}, - "type": {
- "code": "normal",
- "name": "retiro normal"
}, - "size": "s",
- "dimensions": "10cm x 15cm x 5cm",
- "pickup_date": "2025-04-07 00:00:00",
- "warehouse": {
- "id": 8710,
- "code": "DEV",
- "name": "DEV",
- "contact": {
- "name": "Javier Smith",
- "phone": 998874910,
- "email": "cinthia.garrido@enviame.io"
}
}, - "need_evaluation": false,
- "carrier_pickup_number": 1285372591218,
- "carrier_pickup_created": false,
- "max_cancelation_date": null,
- "id": "cRr8Kbj8zPAb4OsCyQxU"
}
}
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
- Payload
{ "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
- 200
- 422
- 500
{- "code": 201,
- "data": {
- "identifier": "1285372591218",
- "company": {
- "id": 2279,
- "code": "DEV",
- "name": "Development",
- "dni": 106719926
}, - "address": {
- "place_id": 378,
- "full_address": "Avenida Vitacura 123",
- "place": "Santiago",
- "information": "H23",
- "place_parents": {
- "parent1": {
- "id": 61,
- "name": "Santiago",
- "level_name": "Provincia"
}, - "parent2": {
- "id": 7,
- "name": "Metropolitana de Santiago",
- "level_name": "Region"
}
}, - "place_level_name": "Comuna",
- "zip_code": null
}, - "carrier": {
- "code": "BLX",
- "name": "Bluexpress",
- "country": "CL",
- "is_integrated": 1,
- "time_zome": "America/Santiago",
- "config": {
- "time_limit": "10:29",
- "time_limit_key": "default"
}
}, - "range_time": "13:00 - 18:00",
- "qty": 7,
- "weight": 10,
- "contact": {
- "name": "John Doe",
- "phone": 999999999
}, - "status": {
- "code": "created",
- "name": "retiro creado",
- "date": "2025-04-04 16:50:11"
}, - "created_at": "2025-04-04 16:50:11",
- "updated_at": "2025-04-04 16:50:11",
- "deleted_at": null,
- "uuid": "d3e8a7ae-5a2a-43b3-a77b-e8c0a3e1718a",
- "marketplace": {
- "id": 10,
- "code": "enviame",
- "name": "Envíame"
}, - "type": {
- "code": "normal",
- "name": "retiro normal"
}, - "size": "s",
- "dimensions": "10cm x 15cm x 5cm",
- "pickup_date": "2025-04-07 00:00:00",
- "warehouse": {
- "id": 8710,
- "code": "DEV",
- "name": "DEV",
- "contact": {
- "name": "Javier Smith",
- "phone": 998874910,
- "email": "cinthia.garrido@enviame.io"
}
}, - "need_evaluation": false,
- "carrier_pickup_number": 1285372591218,
- "carrier_pickup_created": false,
- "max_cancelation_date": null,
- "id": "cRr8Kbj8zPAb4OsCyQxU"
}
}
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
- 200
- 422
- 500
{- "status": "success"
}
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
- Payload
{- "origin": {
- "place": "Santiago",
- "full_address": "Av. Leones 12",
- "information": "Bodega 305",
- "zip_code": null,
- "contact": {
- "name": "Carlos Rodriguez",
- "phone": 987654321,
- "email": "carlos.rodriguez@example.com"
}
}, - "destination": {
- "place": "Valparaiso",
- "full_address": "Calle de la Aurora 15",
- "information": "Oficina 4",
- "zip_code": null,
- "contact": {
- "name": "Juan García",
- "phone": 897658900,
- "email": "juan.garcia@example.com"
}
}, - "carrier": {
- "code": "BLX",
- "service": "priority",
- "attributes": null
}, - "order": {
- "imported_id": "pruebadevolucion1",
- "type": "return",
- "n_packages": 2,
- "packages": [
- {
- "id": 1,
- "price": 1000,
- "description": "Paquete de ropa 1",
- "weight": 1,
- "volume": 1
}
]
}
}
Response samples
- 200
- 422
- 500
{- "status": "success",
- "data": {
- "address_information": "Bodega 305",
- "carrier": {
- "code": "BLX",
- "service": "priority",
- "type": "parcel",
- "attributes": [
- {
- "name": null,
- "value": null
}
], - "attribute": null
}, - "client_name": "Carlos Rodriguez",
- "company_name": "Development",
- "country": "CL",
- "created_at": "2025-03-20 13:54:23",
- "current_status": {
- "comment": "Creado en carrier BLX con OT 9308064846",
- "created_at": "2025-03-20 13:54:25",
- "name": "Listo para despacho",
- "status_code": "CREATED",
- "deadline_at": null,
- "delivery_id": null,
- "description": "Paquete de ropa 1",
- "full_address": "Av. Los Leones 12",
- "id": 300085797,
- "imported_id": "pruebadevolucion1",
- "level1": "Santiago",
- "level2": "Metropolitana de Santiago",
- "n_packages": 2,
- "place": "Santiago",
- "place_id": 378,
- "shipper_data": {
- "name": "Development"
}, - "tracking_number": 9308064846,
- "transit_days": null
}
}, - "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
- 200
- 422
- 500
{- "status": "success",
- "data": {
- "current": {
- "comment": "Creado en carrier BLX con OT 9308064846",
- "created_at": "2025-03-20 13:54:25",
- "name": "Listo para despacho",
- "status_code": "CREATED",
- "status_id": 5
}, - "identifier": 300085797,
- "imported_id": "pruebadevolucion1",
- "statuses": [
- {
- "comment": "Creado por api",
- "created_at": "Thu, 20 Mar 2025 13:54:23 GMT",
- "name": "Creado",
- "status_code": "PENDING",
- "status_id": 1
}, - {
- "comment": "Creado en carrier BLX con OT 9308064846",
- "created_at": "Thu, 20 Mar 2025 13:54:25 GMT",
- "name": "Listo para despacho",
- "status_code": "CREATED",
- "status_id": 5
}
], - "tracking_number": 9308064846,
- "labels": {
- "PDF": {
- "raw": null,
}
}
}, - "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
- Payload
{- "origin": {
- "place": "Santiago",
- "full_address": "Av. Portugal 500",
- "information": "Casa blanca, 2do piso",
- "contact": {
- "name": "Carlos Rodriguez",
- "phone": 987654321,
- "email": "carlos.rodriguez@example.com"
}
}, - "carrier": {
- "code": "BLX",
- "service": "ecommercereturn",
- "attribute": null
}
}
Response samples
- 200
- 422
- 500
{- "status": "success",
- "data": {
- "address_information": "Casa blanca 2 pisos",
- "carrier": {
- "code": "BLX",
- "service": "ecommercereturn",
- "type": "parcel",
- "attributes": [
- {
- "name": null,
- "value": null
}
], - "attribute": null
}, - "client_name": "Carlos Rodriguez",
- "company_name": "Development",
- "country": "CL",
- "created_at": "2025-03-21 15:24:05",
- "current_status": {
- "comment": "Creado en carrier BLX con OT 260071",
- "created_at": "2025-03-21 15:24:14",
- "name": "Listo para despacho",
- "status_code": "CREATED",
- "deadline_at": null,
- "delivery_id": 1812125,
- "description": "Prueba Multibulto",
- "full_address": "Av. Portugal 500",
- "id": 300000437,
- "imported_id": "pruebasoporte1",
- "level1": "Santiago",
- "level2": "Metropolitana de Santiago",
- "n_packages": 3,
- "place": "Santiago",
- "place_id": 378,
- "shipper_data": {
- "name": "Development"
}, - "tracking_number": 260071,
- "transit_days": null
}
}, - "message": "creation success"
}
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
- Payload
{ "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
- 201
- 401
{- "status": "success",
- "data": {
- "identifier": 18035,
- "marketplace_creator": 23314,
- "marketplace_exclusive": false,
- "is_active": true,
- "name": "Bodega 2",
- "code": "bod_prueba_akagi",
- "contact_name": "Contacto Prueba",
- "contact_phone": 987656789,
- "contact_email": "bodega-prueba@enviame.io",
- "address": {
- "place": "Cerrillos",
- "place_id": 105,
- "full_address": "Calle Bodega Akagi 2",
- "information": "Oficina 7",
- "zip_code": null,
- "latitude": null,
- "longitude": null
}, - "created_at": "2025-03-21 18:49:26",
- "updated_at": "2025-03-21 18:49:26",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}
]
}, - "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
- Payload
{- "name": "Bodega 2",
- "place": "Cerrillos",
- "full_address": "Avenida Siempreviva 24"
}
Response samples
- 200
- 401
{- "status": "success",
- "data": {
- "identifier": 18035,
- "marketplace_creator": 23314,
- "marketplace_exclusive": false,
- "is_active": true,
- "name": "Bodega 2",
- "code": "bod_prueba_akagi",
- "contact_name": "Contacto Prueba",
- "contact_phone": 987656789,
- "contact_email": "bodega-prueba@enviame.io",
- "address": {
- "place": "Cerrillos",
- "place_id": 105,
- "full_address": "Calle Bodega Akagi 2",
- "information": "Oficina 7",
- "zip_code": null,
- "latitude": null,
- "longitude": null
}, - "created_at": "2025-03-21 18:49:26",
- "updated_at": "2025-03-21 18:49:26",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}
]
}, - "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
- 200
- 401
{- "status": "success",
- "data": {
- "identifier": 18035,
- "marketplace_creator": 23314,
- "marketplace_exclusive": false,
- "is_active": true,
- "name": "Bodega 2",
- "code": "bod_prueba_akagi",
- "contact_name": "Contacto Prueba",
- "contact_phone": 987656789,
- "contact_email": "bodega-prueba@enviame.io",
- "address": {
- "place": "Cerrillos",
- "place_id": 105,
- "full_address": "Calle Bodega Akagi 2",
- "information": "Oficina 7",
- "zip_code": null,
- "latitude": null,
- "longitude": null
}, - "created_at": "2025-03-21 18:49:26",
- "updated_at": "2025-03-21 19:23:57",
- "deleted_at": "2025-03-21 19:23:57",
- "links": [
- {
- "rel": "self",
}
]
}, - "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
- 200
- 401
{- "status": "success",
- "data": [
- {
- "identifier": 23315,
- "name": "Team Rukawa",
- "corporate_name": "Rukawa Team",
- "dni": 111111111111,
- "website": null,
- "activated": 1,
- "logo": null,
- "code": "rukawa",
- "api_key": "526507674963f91839ff24d52d97e2cc",
- "country": "CL",
- "rule": null,
- "created_at": "2025-03-18 13:07:24",
- "updated_at": "2025-03-18 16:07:25",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}, - {
- "rel": "companies.employees",
}, - {
- "rel": "companies.warehouses",
}, - {
- "rel": "companies.carriers",
}
]
}, - {
- "identifier": 23316,
- "name": "Team Sakuragi",
- "corporate_name": "Sakuragi",
- "dni": 111111111111,
- "website": null,
- "activated": 1,
- "logo": null,
- "code": "sakuragi",
- "api_key": "b07bcc089587489ed0c3018b2cb50d10",
- "country": "CL",
- "rule": null,
- "created_at": "2025-03-18 13:08:57",
- "updated_at": "2025-03-18 16:08:58",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}, - {
- "rel": "companies.employees",
}, - {
- "rel": "companies.warehouses",
}, - {
- "rel": "companies.carriers",
}
]
}, - {
- "identifier": 23317,
- "name": "Akagi",
- "corporate_name": "Akagi",
- "dni": 111111111111,
- "website": null,
- "activated": 1,
- "logo": null,
- "code": "akagiii",
- "api_key": "935a4d6a35fd2fc593f9705de644b66c",
- "country": "CL",
- "rule": null,
- "created_at": "2025-03-18 13:39:21",
- "updated_at": "2025-03-18 16:46:32",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}, - {
- "rel": "companies.employees",
}, - {
- "rel": "companies.warehouses",
}, - {
- "rel": "companies.carriers",
}
]
}
], - "meta": {
- "pagination": {
- "total": 3,
- "count": 3,
- "per_page": 15,
- "current_page": 1,
- "total_pages": 1,
- "links": { }
}
}, - "errors": [ ]
}
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
- Payload
{- "code": "BLX"
}
Response samples
- 200
- 401
{- "status": "success",
- "data": [
- {
- "name": "BLUEXPRESS",
- "code": "BLX",
- "country": "CL",
- "configurations": [
- {
- "name": "BLUEXPRESS",
- "code": "BLX",
- "description": "Bluexpress [New]",
- "default": false
}
]
}
], - "meta": {
- "pagination": {
- "total": 1,
- "count": 1,
- "per_page": 15,
- "current_page": 1,
- "total_pages": 1,
- "links": { }
}
}, - "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
- Payload
{ "value": { "name": "Team Akagi", "corporate_name": "Akagi Team", "code": "akagi", "dni": "11.111.111-1", "website": "www.akagiteam.cl" } }
Response samples
- 200
- 401
- 500
{- "status": "success",
- "data": {
- "identifier": 23317,
- "name": "Team Akagi",
- "corporate_name": "Akagi Team",
- "dni": "11.111.111-1",
- "website": "www.akagiteam.cl",
- "activated": 1,
- "logo": null,
- "code": "akagiii",
- "country": "CL",
- "rule": null,
- "created_at": "2025-03-18 13:39:21",
- "updated_at": "2025-03-18 16:43:25",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}, - {
- "rel": "companies.employees",
}, - {
- "rel": "companies.warehouses",
}, - {
- "rel": "companies.carriers",
}
]
}
}
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
- Payload
{- "name": "Team Mitsui",
- "corporate_name": "Mitsui Team",
- "code": "mitsui_team",
- "dni": 111111111111,
- "rule": 0,
- "carrier_code": [
- "BLX, CHX, CCH, SKN"
]
}
Response samples
- 200
- 401
{- "status": "success",
- "data": {
- "identifier": 23321,
- "name": "Team Mitsui",
- "corporate_name": "Mitsui Team",
- "dni": 111111111111,
- "website": null,
- "activated": 1,
- "logo": null,
- "code": "mitsui_team",
- "country": "CL",
- "rule": null,
- "created_at": "2025-03-25 19:35:21",
- "updated_at": "2025-03-25 19:35:21",
- "deleted_at": null,
- "links": [
- {
- "rel": "self",
}, - {
- "rel": "companies.employees",
}, - {
- "rel": "companies.warehouses",
}, - {
- "rel": "companies.carriers",
}
]
}
}