Skip to main content

Enviame API (2.0.0)

Download OpenAPI specification:Download

License: Apache 2.0

Intro

Hello world, this is the new Enviame API v2 definition.

Empresa/Seller

Crear Bodega empresa Seller

Con el siguiente endpoint podrás crear bodegas para tu empresa/Seller, utilizando el API Key de esta misma empresa. Es necesario tener al menos una bodega creada para poder generar envíos

header Parameters
api-key
required
string

Utilizar Api-key del Marketplace asociado al Seller (esta se encuentra en info de la empresa (MKT)).

Accept
required
string
Default: application/json

Obligatorio / No se modifica

Request Body schema: multipart/form-data
name
string

Obligatorio / Nombre De Bodega

code
string

Obligatorio / Codigo De Bodega

place
string

Obligatorio / Ciudad-o-Comuna De Bodega

full_address
string

Obligatorio / Direccion Completa De La Bodega

Responses

Response samples

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

Ver Empresa/seller

Con este endpoint podrás ver la informacion de Seller /empresa

header Parameters
api-key
required
string

Obligatorio/Se encuentra en info de la empresa.

Accept
required
string
Default: application/json

Obligatorio / No se modifica

Responses

Response samples

Content type
application/json
{}

Editar Seller

header Parameters
api-key
required
string

Obligatorio/Se encuentra en info de la empresa.

Accept
required
string
Default: application/json

Obligatorio / No se modifica

Request Body schema: multipart/form-data
name
string

opcional/nombre seller

corporate_name
string

opcional/nombre coorporativo

code
string

requerido/codigo empresa

dni
string

opcional/dni empresa

website
string

opcional/sitioweb empresa

Responses

Response samples

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

Editar bodega de un Seller/Empresa

header Parameters
api-key
required
string

Obligatorio/Se encuentra en info de la empresa.

Accept
required
string
Default: application/json

Obligatorio / No se modifica

Request Body schema: application/json
name
string

opcional/nombre bodega

code
string

opcional/codigo bodega

place
string

requerido/place de bodega

full_address
string

opcional/direccion de bodega

Responses

Request samples

Content type
application/json
{
  • "name": "Bodega Prueba",
  • "code": "prueba",
  • "place": "Las condes",
  • "full_address": "avenida 123, Las condes"
}

Response samples

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

Editar bodega de un seller

header Parameters
api-key
required
string

Obligatorio/Se encuentra en info de la empresa.

Accept
required
string
Default: application/json

Obligatorio / No se modifica

Content-Type
required
string
Default: application/json

Especifica el formato del contenido enviado al servidor

Request Body schema: application/json
object
name
string

opcional/nombre de bodega

code
string

opcional/codigo de bodega

place
string

obligatorio/place de bodega

full_address
string

opcional/direccion de bodega

Responses

Request samples

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

Response samples

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

Listar Empleados/Usuarios empresa (seller)

header Parameters
api-key
required
string

Obligatorio/Se encuentra en info de la empresa.

Responses

Response samples

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

Ver una bodega de empresa Seller

Con el siguiente endpoint podrás ver una bodega d tu Empresa/Seller utilizando el API Key que se encuentra en información de tu Empresa.

header Parameters
api-key
required
string

Obligatorio/Se encuentra en info de la empresa.

Accept
required
string
Default: application/json

Obligatorio / No se modifica

Responses

Response samples

Content type
application/json
{}

Listar bodegas empresa Seller

Con este endpoint podrás ver la informacion de Seller /empresa

header Parameters
api-key
required
string

Obligatorio/Se encuentra en info de la empresa.

Accept
required
string
Default: application/json

Obligatorio / No se modifica

Responses

Response samples

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

Listar Empleados/Usuarios empresa (seller)

Obtiene listado de empleados asignados a la empresa indicada en el URL (ID de empresa).

header Parameters
api-key
required
string

Obligatorio/Se encuentra en info de la empresa.

Accept
required
string
Default: application/json

Obligatorio / No se modifica

Responses

Response samples

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

Eliminar un envío desde Seller

Con este endpoint podrás eliminar envíos de tu Empresa/Seller . Deja en estado eliminado el envío en nuestra plataforma condiciones:para ser eliminado el envio no puedo tener estados de movimiento

header Parameters
api-key
required
string

Obligatorio/Se encuentra en info de la empresa.

Accept
required
string
Default: application/json

Obligatorio / No se modifica

Content-Type
required
string
Default: application/json

Especifica el formato del contenido enviado al servidor

Responses

Response samples

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

Listado de carriers Activos en Empresa/Seller

Obtiene listado de carriers asignados a la empresa indicada en el URL (ID de empresa)

header Parameters
api-key
required
string

Obligatorio/Se encuentra en info de la empresa.

Accept
required
string
Default: application/json

Obligatorio / No se modifica

Content-Type
required
string
Default: application/json

Especifica el formato del contenido enviado al servidor

Responses

Response samples

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

Eliminar bodega de un seller

Con el siguiente endpoint podrás eliminar bodegas de tu empresa/Seller

header Parameters
api-key
required
string

Utilizar Api-key del Marketplace asociado al Seller (esta se encuentra en info de la empresa (MKT)).

Accept
required
string
Default: application/json

Obligatorio / No se modifica

Content-Type
required
string
Default: application/json

Especifica el formato del contenido enviado al servidor

Responses

Response samples

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

Envios

Crear envio como seller

Con el siguiente endpoint podrás crear envíos para tu Empresa/Seller utilizando el API Key que se encuentra en información de tu Empresa.

Para esto debes:

1.- Utilizar el API Key de tu Empresa/Seller

2.- En url se debe colocar ID de Empresa/Seller

path Parameters
id_seller
required
integer <int64>

ID del seller/Empresa proporcionado por Enviame

header Parameters
api-key
required
string

api-key del seller/empresa proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Request Body schema: application/json

Create a new pet in the store

n_packages
integer

Numero de bultos

content_description
string

Descripción del producto

imported_id
string

Indicar Número de envío de no ser así se asignará uno automático

order_price
float

Valor del producto

weight
float

Peso en kilos

volumen
integer

Indicar el volumen en metros (m³)

shipping_origin.warehouse_code
integer

Código de bodega Empresa/Seller

shipping_destination.name
string

Agregar el nombre de la persona a la que va dirigida el producto

shipping_destination.email
string

Correo del destinatario necesario para la notificación al cliente final

shipping_destination.phone
integer

Numero de celular del destinatario

delivery_address.place
string

Comuna (CL) - Ciudad/Municipio (CO)- Distrito (PE) - Colonia (MX) - Municipio (AR)

delivery_address.full_address
string

Dirección del destinatario

delivery_address.information
string

Una información detallada del destino.

delivery_address.level1
string

Provincia(PE)- Departamento (CO, AR) - Estado (MX)

delivery_address.level2
string

Municipio (MX)

delivery_address.level3
string

Ciudad (MX)

carrier.carrier_code
string

Código del Carrier

carrier.carrier_service
string

Tipo de servicio del Carrier

carrier.tracking_number
integer

Numero del tracking que asigna el carrier

delivery_address.pickup_point_code
integer

Código del pudo del retiro

Responses

Request samples

Content type
application/json
{
  • "n_packages": 0,
  • "content_description": "string",
  • "imported_id": "string",
  • "order_price": null,
  • "weight": null,
  • "volumen": 0,
  • "shipping_origin.warehouse_code": 0,
  • "shipping_destination.name": "string",
  • "shipping_destination.email": "string",
  • "shipping_destination.phone": 0,
  • "delivery_address.place": "string",
  • "delivery_address.full_address": "string",
  • "delivery_address.information": "string",
  • "delivery_address.level1": "string",
  • "delivery_address.level2": "string",
  • "delivery_address.level3": "string",
  • "carrier.carrier_code": "string",
  • "carrier.carrier_service": "string",
  • "carrier.tracking_number": 0,
  • "delivery_address.pickup_point_code": 0
}

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Crear envio en seller como marketplace

Con este endpoint podrás crear envíos en Seller como Marketplace utilizando el API Key de tu MKT el API Key se encuentra en información de tu Marketplace.

Para esto debes:

1.- Utilizar el API Key de tu Empresa/Marketplace

2.- En URL se debe colocar Id de Companies/ Seller

3.- En URL se debe colocar id de Marketplaces

path Parameters
id_MKP
required
integer <int64>

ID del MKP proporcionado por Enviame

id_seller
required
integer <int64>

ID del seller/Empresa proporcionado por Enviame

header Parameters
api-key
required
string

api-key del seller/MKP proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Request Body schema: application/json

Create a new pet in the store

n_packages
integer

Numero de bultos

content_description
string

Descripción del producto

imported_id
string

Indicar Número de envío de no ser así se asignará uno automático

order_price
float

Valor del producto

weight
float

Peso en kilos

volumen
integer

Indicar el volumen en metros (m³)

shipping_origin.warehouse_code
integer

Código de bodega Empresa/Seller

shipping_destination.name
string

Agregar el nombre de la persona a la que va dirigida el producto

shipping_destination.email
string

Correo del destinatario necesario para la notificación al cliente final

shipping_destination.phone
integer

Numero de celular del destinatario

delivery_address.place
string

Comuna (CL) - Ciudad/Municipio (CO)- Distrito (PE) - Colonia (MX) - Municipio (AR)

delivery_address.full_address
string

Dirección del destinatario

delivery_address.information
string

Una información detallada del destino.

delivery_address.level1
string

Provincia(PE)- Departamento (CO, AR) - Estado (MX)

delivery_address.level2
string

Municipio (MX)

delivery_address.level3
string

Ciudad (MX)

carrier.carrier_code
string

Código del Carrier

carrier.carrier_service
string

Tipo de servicio del Carrier

carrier.tracking_number
integer

Numero del tracking que asigna el carrier

delivery_address.pickup_point_code
integer

Código del pudo del retiro

Responses

Request samples

Content type
application/json
{
  • "n_packages": 0,
  • "content_description": "string",
  • "imported_id": "string",
  • "order_price": null,
  • "weight": null,
  • "volumen": 0,
  • "shipping_origin.warehouse_code": 0,
  • "shipping_destination.name": "string",
  • "shipping_destination.email": "string",
  • "shipping_destination.phone": 0,
  • "delivery_address.place": "string",
  • "delivery_address.full_address": "string",
  • "delivery_address.information": "string",
  • "delivery_address.level1": "string",
  • "delivery_address.level2": "string",
  • "delivery_address.level3": "string",
  • "carrier.carrier_code": "string",
  • "carrier.carrier_service": "string",
  • "carrier.tracking_number": 0,
  • "delivery_address.pickup_point_code": 0
}

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Transformar a multi bulto desde Seller

Endpoint para transformar envíos que tienen 1 bulto y en estado 5 (Listo para despacho), a cantidad de bultos indicada..

Para esto debes:

1.- Utilizar API-key de tu empresa la cual se encuentra en info. de empresa de tu perfil Envíame.

2.- En la URL se debe indicar el ID de tu empresa, la cual se encuentra en info de empresa de tu perfil Envíame y, también, el ID del envío a transform

path Parameters
id_envio
required
integer <int64>

ID generado por enviame

id_seller
required
integer <int64>

ID del seller/Empresa proporcionado por Enviame

header Parameters
api-key
required
string

api-key del seller proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Request Body schema: application/json

Create a new pet in the store

n_packages
integer

Obligatorio / Cantidad de bultos a transformar

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Ver envio

Con este endpoint podrás ver tu envío como Seller/Empresa utilizando el API Key esta la encuentras en info. de tu empresa de la plataforma Enviame

Para esto debes:

1.- En URL se debe colocar id deliveries del envío

path Parameters
id_envio
required
integer <int64>

ID generado por enviame

header Parameters
api-key
required
string

api-key del seller proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Responses

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Ver envios seller

Endpoint que permite ver la información de todos los envíos de tu Seller/Empresa

Para esto debes:

En la URL se debe colocar el company_id

path Parameters
id_empresa
required
integer <int64>

ID generado por enviame

header Parameters
api-key
required
string

api-key del seller proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Responses

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Imprimir etiqueta y agregar a manifiesto

Genera la etiqueta de envíos que ese encuentren en estado 5 (Listo para despacho) dejándolos en estado 26 (Listo para despacho - impreso).

path Parameters
id_empresa
required
integer <int64>

ID generado por enviame

header Parameters
api-key
required
string

api-key del seller proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Request Body schema: application/json

Create a new pet in the store

deliveries
Array of arrays

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": "string",
  • "labelsPerPage": null
}

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Ver tracking del envio

Con el siguiente endpoint podrás ver el historial de los estados de los Envios para tu Empresa/Seller utilizando el API Key que la encuentras en info de tu empresa. Para esto debes:

1.- Utilizar el API Key de tu Empresa/Seller

2.- En URL se debe colocar Id del envío

path Parameters
id_envio
required
integer <int64>

ID generado por enviame

header Parameters
api-key
required
string

api-key del seller proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Responses

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Generar un manifiesto

Si los envíos indicados en body se encuentran en estado 5 (Listo para despacho), al ejecutar esta solicitud se actualizarán al estado 26 (Listo para despacho - impreso). Además el envío será agregado al manifiesto actualmente abierto del operador correspondiente

path Parameters
id_empresa
required
integer <int64>

ID generado por enviame

header Parameters
api-key
required
string

api-key del seller proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Request Body schema: application/json

Create a new pet in the store

deliveries
Array of arrays

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Cerrar manifiesto

Endpoint parar cerrar un manifiesto y cambiar a estado cerrado/confirmado.

path Parameters
id_empresa
required
integer <int64>

ID generado por enviame

id_manifiesto
required
integer <int64>

ID generado por enviame

header Parameters
api-key
required
string

api-key del seller proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Responses

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Eliminar envío

Endpoint para eliminar ordenes

path Parameters
id_empresa
required
integer <int64>

ID generado por enviame

id_envio
required
integer <int64>

ID generado por enviame

header Parameters
api-key
required
string

api-key del seller proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Responses

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Actualizar estado de un envío de transporte interno

Con este servicio podrás actualizar el estado de los envíos que pertenezcan al operador -Transporte interno-

°Para obtener el listado de posibles valores para el campo CODE, por favor solicitar en un correo hacia support@enviame.io.

path Parameters
id_envio
required
integer <int64>

ID generado por enviame

header Parameters
api-key
required
string

api-key del seller proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Request Body schema: application/json

Create a new pet in the store

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

Obligatorio / Fecha que quedará registrada como fecha de actualización de estado ejemplo: 2024-03-21 15:45:10.

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "comment": "string",
  • "change_at": "string"
}

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Retiros

Crear retiro como seller de un Marketplace

Endpoint para programar retiros a través de las credenciales del MKT a la bodega indicada, del seller indicado con el carrier seleccionado.
El código de carrier se puede encontrar en "soporte y ayuda" de su perfil de Envíame.

La respuesta depende del horario de corte de cada carrier.

header Parameters
api-key
required
string

Utilizar Api-key del Marketplace asociado al Seller (esta se encuentra en info de la empresa (MKT)).

Accept
required
string
Default: application/json

Obligatorio / No se modifica

Request Body schema: application/json
carrier_code
string

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

warehouse_code
string

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

qty
int <int64>

Requerido / Cantidad total de bultos a retirar.

contact_name
string

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

contact_phone
string

Requerido / 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 / Al ir vacío se programa para el día siguiente.

weight
integer

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

size
string

Requerido / "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
application/json
{
  • "carrier_code": "BLX",
  • "warehouse_code": "bodega_centro",
  • "qty": 12,
  • "contact_name": "Ivan Rodriguez",
  • "contact_phone": 999827309,
  • "range_time": "12:00",
  • "pickup_date": "12:00",
  • "weight": 24,
  • "size": "m",
  • "custom_size": "string"
}

Response samples

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

Crear retiro como Empresa/Seller

Endpoint para programar retiros a la bodega indicada con el carrier seleccionado. El código de carrier se puede encontrar en "soporte y ayuda" de su perfil de Envíame. La respuesta que se obtiene depende del horario de corte de cada carrier. Para esto debes

header Parameters
api-key
required
string

Utilizar Api-key del Marketplace asociado al Seller (esta se encuentra en info de la empresa (MKT)).

Accept
required
string
Default: application/json

Obligatorio / No se modifica

Request Body schema: application/json
carrier_code
string

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

warehouse_code
string

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

qty
int <int64>

Requerido / Cantidad total de bultos a retirar.

contact_name
string

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

contact_phone
string

Requerido / 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 / Al ir vacío se programa para el día siguiente.

weight
integer

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

size
string

Requerido / "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
application/json
{
  • "carrier_code": "BLX",
  • "warehouse_code": "string",
  • "qty": null,
  • "contact_name": "string",
  • "contact_phone": "string",
  • "range_time": 0,
  • "pickup_date": 0,
  • "weight": 0,
  • "size": "string",
  • "custom_size": "string"
}

Response samples

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

Listar retiros como Marketplaces

Lista todos los retiros de un seller. Solo funciona en ambiente de producción.

header Parameters
Accept
required
string
Default: application/json

Obligatorio / No se modifica

Responses

Response samples

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

Listar retiros como Seller

Lista todos los retiros de un seller. Solo funciona en ambiente de producción.

header Parameters
Accept
required
string
Default: application/json

Obligatorio / No se modifica

Responses

Response samples

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

Devoluciones

Crear devolución

header Parameters
api-key
required
string

Utilizar Api-key del Marketplace asociado al Seller (esta se encuentra en info de la empresa (MKT)).

Content-Type
required
string
Default: application/json

Especifica el formato del contenido enviado al servidor

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"
}

Ver tracking de devolución

header Parameters
api-key
required
string

Utilizar Api-key del Marketplace asociado al Seller (esta se encuentra en info de la empresa (MKT)).

Responses

Response samples

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

Crear devolución desde un envío

header Parameters
api-key
required
string

Utilizar Api-key del Marketplace asociado al Seller (esta se encuentra en info de la empresa (MKT)).

Content-Type
required
string
Default: application/json

Especifica el formato del contenido enviado al servidor

Request Body schema: application/json
object
object

Responses

Request samples

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

Response samples

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

Users

Crear Empleado/Usuario empresa (seller)

Con el siguiente endpoint podrás crear Empleados/Usuarios para tu empresa/Seller utilizando el API Key de tu Marketplace. Esto porque es necesario tener al menos un usuario creado.

header Parameters
api-key
required
string

Utilizar Api-key del Marketplace asociado al Seller (esta se encuentra en info de la empresa (MKT)).

Accept
required
string
Default: application/json

Obligatorio / No se modifica

Request Body schema: multipart/form-data
first_name
string

Requerido / Nombre

last_name
string

Requerido / apellido

email
string

Requerido / correo del usuaior

phone
string

optional / telefono

mobile
string

optional / numero mobil

password
string

obligatoria / contraseña

password_confirmation
string

obligatoria / contraseña

Responses

Response samples

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

Marketplace

Crear Bodega en empresa Seller como Marketplace

Con el siguiente endpoint podrás crear bodegas para tu empresa/Seller utilizando el API Key de tu Marketplace. Esto porque es necesario tener al menos una bodega creada para poder generar envíos.

Para esto debes:

1.- Utilizar el API Key de la empresa marketplace.

2.- Indicar el ID de tu marketplace.

3.- Indicar el ID de la empresa.

path Parameters
id_seller
required
integer <int64>

ID del seller/Empresa proporcionado por Enviame

id_Marketplace
required
integer <int64>

ID del seller/Empresa proporcionado por Enviame

header Parameters
api-key
required
string

API-Key-empresa-Marketplace

Accept
required
string
Default: application/json

Obligatorio

Request Body schema: multipart/form-data
Nombre_Bodega
string

Obligatorio / Nombre_Bodega

code
string

Obligatorio / CCodigo_Bodega

place
string

Requerido / Comuna O ciudad de Bodega

full_address
string

Requerido / Direccion de Bodega

level1
string

Requerido Solamente si eres de / Perú (Provincia) ó Colombia (Departamento)

Responses

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Editar Bodega de una empresa seller desde Marketplace

Endpoint para modificar datos de bodega de una empresa/seller con credenciales de un Marketplace.

Para esto debes:

1.- Utilizar API-key de tu Marketplace la cual se encuentra en info. de empresa de tu perfil Envíame.

2.- En la URL se debe indicar el ID de tu Empresa, la cual se encuentra en info. de empresa de tu perfil Envíame , el ID del Marketplace y el código de bodega a modificar.

3.- Código de bodega se encuentra en perfil de la empresa, pestaña Bodegas, columna código o bien, se puede obtener con el endpoint Ver Bodega Seller

path Parameters
id_seller
required
integer <int64>

ID del seller/Empresa proporcionado por Enviame

id_Marketplace
required
integer <int64>

ID del Marketplace proporcionado por Enviame

code_bodega
required
string

Codigo asiganado a la bodega

header Parameters
api-key
required
string

api-key del seller/empresa proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Request Body schema: application/json

Create a new pet in the store

name
integer

Opcional / Nombre de la Bodega.

code
string

Opcional / Código de la bodega. NO debe contener espacios**.**

place
string

Requerido / Comuna, Distrito, Ciudad (Según País).

full_address
float

Opcional / Dirección de Bodega.

level1
float

Requerido si eres de Peru | Colombia / Provincia o Dpto (Según País).

Responses

Request samples

Content type
application/json
{
  • "name": 0,
  • "code": "string",
  • "place": "string",
  • "full_address": null,
  • "level1": null
}

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Eliminar Bodega de una empresa Seller desde Marketplace

Este endpoint permite eliminar una bodega de uno de tus sellers/empresas desde el Marketplace..

Para esto debes:

1.- Indicar el ID de tu marketplace.

2.- Indicar el ID de la empresa.

3.- Indicar el ID de la bodega a eliminar.

path Parameters
id_Marketplace
required
integer <int64>

ID del Marketplace proporcionado por Enviame

id_seller
required
integer <int64>

ID del seller/empresa proporcionado por Enviame

code_bodega
required
string

Codigo asiganado a la bodega

header Parameters
api-key
required
string

api-key del seller/empresa proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Responses

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Listar Sellers

Con este endpoint podrás obtener todos los Seller de tu Marketplaces utilizando el API Key el cual lo encuentras en la info de tu empresa.

Para esto debes:

1.- En URL se debe colocar Id de Marketplaces/Companies.

2.- Utilizar el API Key de tu Marketplaces.

path Parameters
id_Marketplace
required
integer <int64>

ID del Marketplace proporcionado por Enviame

header Parameters
api-key
required
string

api-key del seller/empresa proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Responses

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Asignar carrier a seller (empresa)

Este Endpoint te permite asignar un carrier a la empresa en contrato Distribución. El parámetro code es el código del carrier correspondiente.

Para esto debes:

1.- En url se debe colocar Id de Marketplace e Id de empresa/seller..

2.- En body codigo de Carrier que se quiere asignar. El código de carrier lo puedes encontrar en tu perfil/Pestaña de ayuda.

3.- Utilizar el API Key de la empresa marketplace.

path Parameters
id_seller
required
integer <int64>

ID del seller/Empresa proporcionado por Enviame

id_Marketplace
required
integer <int64>

ID del Marketplace proporcionado por Enviame

header Parameters
api-key
required
string

api-key del seller/empresa proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Request Body schema: application/json

Create a new pet in the store

code
string

Requerido | Codigo del carrier

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Editar Seller como Marketplace

Endpoint para modificar nombre, código, DNI, o sitio web de un seller desde un Marketplace..

Para esto debes:

1.- Utilizar API-key de tu Marketplace la cual se encuentra en info. de empresa de tu perfil Envíame..

2.- n la URL se debe indicar el ID de tu Marketplace, la cual se encuentra en info. de empresa de tu perfil Envíame y el ID del seller a modificar.

path Parameters
id_seller
required
integer <int64>

ID del seller/Empresa proporcionado por Enviame

id_Marketplace
required
integer <int64>

ID del Marketplace proporcionado por Enviame

header Parameters
api-key
required
string

api-key del seller/empresa proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Request Body schema: application/json

Create a new pet in the store

code
string

Opcional / Código del Seller. NO debe contener espacios**.**

corporate_name
string

Opcional / Nombre de la empresa.

dni
string

Opcional / DNI/RUT del seller.

website
string

Opcional / Página web del seller.

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "corporate_name": "string",
  • "dni": "string",
  • "website": "string"
}

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}

Crear Seller como Marketplace

Con el siguiente endpoint podrás crear un Seller para tu marketplace utilizando el API Key del Marketplace.

Para esto debes:

1.- En url se debe colocar Id de marketplace..

2.- Utilizar el API Key de tu marketplace..

path Parameters
id_Marketplace
required
integer <int64>

ID del Marketplace proporcionado por Enviame

header Parameters
api-key
required
string

api-key del MKP proporcionado por Enviame

Accept
required
string
Default: application/json

Obligatorio

Request Body schema: application/json

Create a new pet in the store

name
string

Nombre del seller

corporate_name
string

Razón Social del Seller.

dni
string

Opcional / DNI/RUT del seller.

rule
string

Colocar el id de la regla del Seller.

carrier_code
string

Códigos de los carriers que va usar el seller.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "corporate_name": "string",
  • "dni": "string",
  • "rule": "string",
  • "carrier_code": "string"
}

Response samples

Content type
application/json
{
  • "data": "No autenticado.",
  • "code": 401
}