Ventas
En esta sección se encuentran todas las API's de Ventiapp relacionadas a Ventas
get
https://ventiapi.azurewebsites.net/api
/orders/orders
Get Orders
Las opciones válidas para el parámetro de sort son:
- added_desc : Fecha de Alta en VentiApp descendiente
- added_asc: Fecha de Alta en VentiApp ascendiente
- created_desc: Fecha de creación inicial de la compra descendiente
- created_asc: Fecha de creación inicial de la compra ascendiente
- modified_desc: Fecha de modificación de la compra descendiente
- modified_asc: Fecha de modificación de la compra ascendiente
Las opciones válidas para el parámetro channel son:
- "amazon" (Amazon)
- "claroshop" (Claroshop)
- "elektra" (Elektra)
- "linio" (Linio)
- "liverpool" (Liverpool)
- "meli" (Mercado Libre)
- "mshops" (Mercado Shops)
- "prestashop" (Prestashop)
- "shopify" (Shopify)
- "venticommerce" (VentiCommerce)
- "vtex" (VTEX)
- "walmart" (Walmart) //Plataforma antigua MIRAKL //DEPRECATED
- "walmartEDI" (Walmart) // Plataforma nueva Walmart EDI
- "wish" (Wish)
- "woocommerce" (WooCommerce)
- "walmartUS" (Walmart United States) //Version USA
- "amazon_us" (Amazon United States) //Version USA
- "tiendanube" (Tienda Nube)
- "ventiapp" (Órdenes creadas manualmente o através de POS)
get
https://ventiapi.azurewebsites.net/api
/orders/findorder
Find Order
post
https://ventiapi.azurewebsites.net/api
/orders/createorder
Create Order
Body de la llamada:
{
"channel": "your_channel",
"externalId": "111444123",
"total": 660.0,
"currency": "MXN",
"tax": 0.16,
"comments": "Send it before tuesday",
"title": "Order Title",
"cartId": "00000101110002",
"externalNumber": "12314512",
"items": [{
"itemExternalId": "MLM3312341",
"title": "Item 1",
"price": 460.0,
"itemQuantity": 1,
"total": 460.0,
"sku": "ITEM-RED001",
"erpId": "ITEM-123"
},
{
"itemExternalId": "MLM3317841",
"title": "Item 2",
"price": 200.0,
"itemQuantity": 1,
"total": 200.0,
"sku": "PLAINITEM001",
"erpId": "ITEM-456"
}
],
"buyer": {
"name": "John",
"lastname": "Doe",
"email": "[email protected]",
"state": "Distrito Federal",
"address": "Street Address 123",
"city": "Mexico City",
"zipcode": "06700",
"nickname": "JOHNDOEVENTI",
"phone": "5584848152",
"externalId": "551331413"
},
"shipping": {
"sellerInfo": "MYSELLERNAME",
"sellerId": "MYSELLERID",
"shipmentType": "Express",
"shippingStatus": "shipped",
"shippingCourier": "drop_off",
"shippingId": "27586098188",
"shippingTrackingId": "10003313132",
"shippingCourierExternal": "Fedex Express",
"shippingCost": 120.0
}
put
https://ventiapi.azurewebsites.net/api
/orders/updateorder/
Update Order
Ejemplo de la llamada:
{
"channel": "your_channel",
"externalId": "111444123",
"total": 660.0,
"currency": "MXN",
"tax": 0.16,
"comments": "Send it before tuesday",
"title": "Order Title",
"cartId": "00000101110002",
"externalNumber": "12314512",
"items": [{
"itemExternalId": "MLM3312341",
"title": "Item 1",
"price": 460.0,
"itemQuantity": 1,
"total": 460.0,
"sku": "ITEM-RED001",
"erpId": "ITEM-123"
},
{
"itemExternalId": "MLM3317841",
"title": "Item 2",
"price": 200.0,
"itemQuantity": 1,
"total": 200.0,
"sku": "PLAINITEM001",
"erpId": "ITEM-456"
}
],
"buyer": {
"name": "John",
"lastname": "Doe",
"email": "[email protected]",
"state": "Distrito Federal",
"address": "Street Address 123",
"city": "Mexico City",
"zipcode": "06700",
"nickname": "JOHNDOEVENTI",
"phone": "5584848152",
"externalId": "551331413"
},
"shipping": {
"sellerInfo": "MYSELLERNAME",
"sellerId": "MYSELLERID",
"shipmentType": "Express",
"shippingStatus": "shipped",
"shippingCourier": "drop_off",
"shippingId": "27586098188",
"shippingTrackingId": "10003313132",
"shippingCourierExternal": "Fedex Express"
}
get
https://ventiapi.azurewebsites.net/api
/orders/printlabel/
Print Label
post
https://ventiapi.azurewebsites.net/api
/orders/updateshippinglabel/?orderId=XXXX
Update Shipping Label
Body de la llamada:
{
"shippingTrackingId": "78713341882",
"shippingLabelUrl": "https://myserver.com/78713341882.pdf",
"shippingCourier": "DHL",
"shippingCourierCode": "XXX",
"shippingInvoiceNumber": "INV0001"
}
shippingTrackingId: Tracking ID del envío
shippingLabelUrl: URL para descargar el PDF, ZPL ó guía
shippingCourier: Paquetería utilizada para el envío
shippingCourierCode(opcional): Código opcional a requerir según el canal de la venta (solo aplica en Liverpool)
shippingInvoiceNumber(opcional): ID de Factura para asociar la guía
MercadoLibre: shippingTrackingId, status(solo para el update si es creación se pone por defecto "shipped").
Wish:shippingTrackingId, shippingCourier.
WalmartEDI: shippingTrackingId, shippingCourier, shippingLabelUrl.
Vtex : shippingTrackingId,shippingCourier,shippingInvoiceNumber ,shippingLabelUrl.
Elektra: shippingTrackingId, shippingCourier, shippingLabelUrl.
Amazon: shippingTrackingId, shippingCourier.
Shopify: shippingTrackingId, shippingCourier, shippingLabelUrl.
Liverpool: shippingTrackingId, shippingCourier, shippingCourierCode, shippingLabelUrl.
WooCommerce: N/A
Claroshop: N/A
Linio: N/A
TiendaNube : N/A
post
https://ventiapi.azurewebsites.net/api
/orders/updateshippingstatus/?orderId=XXXX
Update Shipping Status
Body de la llamada:
{
"shippingStatus": "shipped"
}
post
https://ventiapi.azurewebsites.net/api
/orders/adddigitalredeems
Add Digital Redeems
Body de la llamada:
{
"orderId": "4592185", //ID DE VENTA INTERNO DE VENTIAPP
"dateRedeem": "18/02/2021",
"redeems": [
{
"productName": "OFFICE",
"brand": "OFFICE",
"key": "KEY012345678", //OPCIONAL
"description": "MICROSOFT 365 EMPRESA BÁSICO"
},
{
"productName": "Avast Free Antivirus 2021",
"brand": "Avast",
"urlRedeem": "https://www.avast.com/redeem?id=123456", //OPCIONAL
"description": "Detecte virus, ransomware y otras amenazas en tiempo real."
}
],
"messages":[ //OPCIONAL
{
"text":"Hola {{NOMBRE}} {{APELLIDO}}, gracias por comprar en {{NOMBRE_TIENDA}}"
},
{
"text":"Para hacer Redeem de tu licencia de {{NOMBRE_PRODUCTO}} deberás ingresar aquí {{LINK_REDEEM}}"
},
{
"text":"Te recordamos que puedes verificar nuestros tutoriales en los adjuntos dentro del portal de redeem"
}
],
"attachments":[ //OPCIONAL
{
"url":"https://ventiapp.com/help/redeem.pdf",
"text":"Manual de redeem para producto digital"
},
{
"url":"https://ventiapp.com/help/redeem2.pdf",
"text":"Manual de redeem 2 para producto digital"
},
]
}
Información sustituible:
El nuevo campo de messages soporta información sustituible, la cual se generará a partir de la información de la orden. Los campos son los siguientes:
{{NOMBRE}} -> Nombre del comprador
{{APELLIDO}} -> Apellido del comprador
{{NOMBRE_PRODUCTO}} -> Nombre del item que se compro en la orden
{{NOMBRE_TIENDA}} -> Nombre de la tienda oficial, ó nombre del usuario del canal de venta
{{LINK_REDEEM}} -> Aquí aparecerá el link hacia el portal de redeem de Ventiapp
put
https://ventiapi.azurewebsites.net/api/orders/
UpdateExternalErpId
Update external ID
Las opciones válidas para el parámetro canal son:
- "meli" (Mercado Libre)
- "amazon" (Amazon)
- "amazon_us" (Amazon United States) // Version USA
- "bestbuyca" (Best Buy CA) // Version Canada
- "claroshop" (Claroshop)
- "cyberpuerta" (Cyberpuerta)
- "doto" (Doto)
- "elektra" (Elektra)
- "linio" (Linio)
- "liverpool" (Liverpool)
- "magento" (Magento)
- "market" (Market)
- "mshops" (Mercado Shops)
- "prestashop" (Prestashop)
- "shiphero" (ShipHero)
- "shopify" (Shopify)
- "tiendanube" (Tienda Nube)
- "ventiapp" (Ventiapp)
- "venticommerce" (VentiCommerce)
- "vtex" (VTEX)
- "walmart" (Walmart)
- "walmartus" (Walmart United States) // Version USA
- "walmartedi" (Walmart) // Plataforma Walmart EDI
- "wish" (Wish)
- "woocommerce" (WooCommerce)
post
https://ventiapi.azurewebsites.net/api/orders/
UpdateErpId
Update ERP ID
Webhooks
En el apartado de Webhook se definen notas importantes de las cuales es recomendado que se tengan en cuenta, sobre todo con compras de Mercado Libre y Linio. Ver aquí
Fechas
Todos los campos de fechas que se retornan por API están en Zona Horaria Universal (UTC), la cual deberás calcular si deseas tener en tiempo local de tu país.
A partir del 21/10/2020 las ordenes consultadas por API tendrán la siguiente unificación de los estados originales del canal a los siguientes.
Estado | Descripción |
confirmed | Confirmada, sin pagar |
pending | Orden pendiente, en estado de espera |
paid | Pagada |
cancelled | Cancelada |
returned | Retornada |
refused | Rechazada |
partial_returned | Devolución Parcial |
Existen varios tipos distintos de logística de acuerdo al tipo de órden que se generer desde la plataforma web ó marketplace. A continuación una lista de los estados más utilizados, es posible que existan adicionales en casos especiales. Este campo es shippingCourier
Estado | Descripción |
drop_off | Estado de Dropshipping, cuando tu negocio está encargado del envío |
xd_drop_off | Estado de Dropshipping, cuando tu negocio está encarado del envío pero este será auna agencia |
fulfillment | Estado de envío de Fulfillment, estará encargado el marketplace |
custom | Estado de envío customizado, generalmente es cuando el usuario define sus tipos de envío |
not_specified | Estado de envío sin especificar, en este caso hay que ponerse de acuerdo con el comprador |
post
https://ventiapi.azurewebsites.net/api/orders/
redact
Ofusca datos personales de los compradores
Body de la llamada:
{
"orders":["12345","12351","45412","434912315233","20000000142461235"]
}
post
https://ventiapi.azurewebsites.net/api/orders/
CancelOrder
Cancela ó notifica requerimiento de Cancelación
get
https://ventiapi.azurewebsites.net/api/orders
/GetReturn
Obtiene la devolución de una venta en específico
Última actualización 20d ago