Documentación

VENTAS

Permite buscar ventas realizadas sobre publicaciones tanto en mercadolibre como en el sitio.

Indice

Busqueda Busqueda por Id Busqueda por filtros Actualizar los datos de Facturación Actualizar los datos de Shipping

Acciones

BUSQUEDA POR ID

Retorna la información de una VENTA identificada por su ID

GET  /v1/shops/{SHOP_ID}/orders/{ORDER_ID} 

Mostrar ejemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/orders/{order_id}?access_token={access_token} 

Parametros

ParametroValoresEjemplo
access_token Codigo de seguridad access_token=APP_USR-4X30-XXXXX-
SHOP_ID Id de usuario https://api.mercadoshops.com/v1/shops /15XXXXX24/
ORDER_ID Id de venta https://api merdoshops.com/v1/shops/15XXXXX24/orders/11111111?acess_token=**************
{
id
Id unico de VENTA
Tipo
STRING
store_id
Id del sitio
Tipo
NUMERICO
channel
Canal de venta la de publicacion
Tipo
STRING
Valores Posibles:
mshops
mercadoshops
meli
mercadolibre
external_reference
Numero de Referencia externa de la venta
Tipo
NUMERICO
currency
Moneda de la venta
Tipo
STRING
amount
Monto de la Venta
Tipo
NUMERICO
products_total
Suma total de los importes de productos
Tipo
NUMERICO
products_discounts_total
Suma total de los importes de descuentos en productos
Tipo
NUMERICO
products_grand_total
Suma total de los importes de productos incluyendo descuentos
Tipo
NUMERICO
discounts_total
Suma total de los descuentos
Tipo
NUMERICO
shipping_total
Suma total de los importes de envios
Tipo
NUMERICO
grand_total
Suma total de la VENTA
Tipo
NUMERICO
creation_date
Fecha de realización de la VENTA
Tipo
Date(ISO_8601)
buyer_message
Mensaje del comprador
Tipo
STRING
status
{ Estados de la venta
Tipo
OBJETO
delivered
Despachado
Tipo
BOOLEAN
Valores Posibles
true
Despacho realizado
false
Despacho sin realizar
paid
Pagado
Tipo
BOOLEAN
Valores Posibles
true
Pago realizado
false
Pago sin realizar
closed
Venta Cerrada
Tipo
BOOLEAN
Valores Posibles
true
Venta cerrada
false
Venta abierta
closed_reason
motivo de venta cerrada
Tipo
STRING
closed_date
Fecha de cierre de la VENTA
Tipo
Date(ISO_8601)
processed
Procesada
Tipo
BOOLEAN
Valores Posibles
true
Venta procesada
false
Venta sin procesar
processed_date
Fecha de procesamiento de la VENTA
Tipo
Date(ISO_8601)
contact_data_status
new,
order_status
null
},
buyer
{ COMPRADOR
Tipo
OBJETO
id
Id de Usuario en mercadolibre
Tipo
NUMERICO
meli_cust_id
null,
name
nombre y apellido del comprador
Tipo
STRING
nickname
null,
client_id
Id de Usuario en mercadoshops
Tipo
NUMERICO
mail
mail del comprador
Tipo
STRING
mail2
mail2 del comprador
Tipo
STRING
phone
Teléfono del comprador
Tipo
STRING
phone2
Teléfono2 del comprador
Tipo
STRING
doc_number
número de documento
Tipo
NUMERICO
doc_type
tipo de documento
Tipo
STRING
},
billing_data
{ Datos de facturación
Tipo
OBJETO
store_id
Id del sitio
Tipo
NUMERICO
name
nombre y apellido del comprador
Tipo
STRING
email
email del comprador
Tipo
STRING
phone
Teléfono del comprador
Tipo
STRING
zip_code
código postal del comprador
Tipo
STRING
address
{ Direccion
Tipo
OBJETO
additional_info
Información adicional del domicilio del comprador
Tipo
STRING
street
Calle del domicilio del comprador
Tipo
STRING
number
numero del domicilio del comprador
Tipo
STRING
city
ciudad del domicilio del comprador
Tipo
STRING
state
ID del estado/provincia del País
Tipo
STRING
Para obtener el listado de IDs de estados/provincias de cada pais utiliza este recurso :
EJEMPLO:
id
"AR-B",
name
"Buenos Aires"
},
recipient
{
doc_number
Documento de la persona que recibe el producto
Tipo
STRING
type
Tipo de Documento de la persona que recibe el producto
Tipo
STRING
},
id
Id de los datos de facturación
Tipo
NUMERICO
},
payments
[ Datos de PAGOS
Tipo
OBJETO
{
id
Id del PAGO
Tipo
NUMERICO
external_reference
Numero de referencia externa del PAGO
Tipo
NUMERICO
status
Estado del pago
Tipo
STRING
Valores Posibles
pending
El usuario no completo el proceso de pago
approved
El pago fue aprobado y acreditado
in_process
El pago esta siendo revisado
rejected
El pago fue rechazado .El usuario puede reiterar el pago.
cancelled
El pago fue cancelado por una de las partes, o el tiempo de espera de pago expiro.
refunded
El pago fue devuelto al usuario.
charged_back
Se hizo un contracargo a la tarjeta de crédito del usuario.
provider
Empresa que gestiono el pago
Tipo
STRING
method
Método de pago
Tipo
STRING
currency
Moneda del pago
Tipo
STRING
Valores Posibles
ARS
Argentine peso
BRL
Brazilian real
VEF
Venezuelan strong bolivar
CLP
Chilean peso
MXN
Mexican peso
COP
Colombian peso
UYU
Uruguayan peso
amount
Monto del pago
Tipo
NUMERICO
paid
Venta Pagada
Tipo
BOOELAN
Valores Posibles
true
Venta Pagada
false
Venta NO Pagada
paid_date
Fecha de pago de la VENTA
Tipo
Date(ISO_8601)
installments
Cantidad de cuotas del pago
Tipo
NUMERICO
fees
{ Cargos / Comisiones
Tipo
OBJETO
finance_fee
Monto del cargo financiero
Tipo
NUMERICO
}
}
],
shippings
[ Datos de ENVIO
Tipo
OBJETO
{
id
Id de ENVIO
Tipo
NUMERICO
external_reference
Numero de referencia externa de ENVIO
Tipo
NUMERICO
ship_type
Tipo de Envio
Tipo
STRING
Valores Posibles
not specified
Significa que el vendedor no especificó ningún precio del envío de sus artículos y el comprador tiene que ponerse en contacto con el vendedor para acordar una opción de envío y el precio de la compra.
custom
Los vendedores pueden incluir una tabla de hasta 10 costos de envío en un item.
me1
(MercadoEnvios mode 1) Este método ofrece una calculadora de envíos para obtener el coste de envío para todos los items que permite al vendedor elegir.
me2
(MercadoEnvios mode 2) Este método proporciona al vendedor una etiqueta y código deseguimiento pre-pago con la compañía de transporte elegida por MercadoLibre.
channel_status
channel_status
status
status
receiver
{ Datos de la persona que recibe el producto
Tipo
OBJETO
doc_number
Número de documento
Tipo
NUMERICO
doc_type
tipo de documento
Tipo
STRING
name
nombre y apellido
Tipo
STRING
email
email
Tipo
STRING
phone
teléfono
Tipo
STRING
address
Dirección de entrega
Tipo
STRING
zip
Código Postal
Tipo
STRING
neighbourhood
Barrio
Tipo
STRING
municipality
Municipalidad
Tipo
STRING
city
Ciudad
Tipo
STRING
state_id
ID del estado/provincia del País
Tipo
STRING
Para obtener el listado de IDs de estados/provincias de cada país utiliza este recurso:
Ejemplo:
id
AR-B,
name
Buenos Aires
country_id
ID del País
Tipo
STRING
Para obtener el listado de codigos de paises habilitados utiliza este recurso:
Ejemplo:
id
AR,
name
Argentina
locale
es_AR
currency_id
ARS
},
additional_info
Información adicional
Tipo
STRING
method_id
Id del método de entrega
Tipo
NUMERICO
method
Método de entrega
Tipo
STRING
currency
Moneda del pago
Tipo
STRING
Valores Posibles
ARS
Argentine peso
BRL
Brazilian real
VEF
Venezuelan strong bolivar
CLP
Chilean peso
MXN
Mexican peso
COP
Colombian peso
UYU
Uruguayan peso
amount
Importe del envío
Tipo
NUMERICO
tracking_code
Código de seguimiento del envío
Tipo
STRING
observations
Observaciones
Tipo
STRING
date_created
Fecha de alta del envío
Tipo
Date(ISO_8601)
}
],
invoice
{ Datos de la Factura
Tipo
OBJETO
invoiced
Venta Facturada
Tipo
BOOLEAN
Valores Posibles
true
Venta Facturada
False
Venta NO Facturada
type
Tipo de comprobante
Tipo
STRING
number
Numero de comprobante
Tipo
STRING
invoiced_date
Fecha de Facturación de la VENTA
Tipo
Date(ISO_8601)
},
products
[ Productos comprados
Tipo
ARRAYS
{
id
ID de Producto
Tipo
NUMERICO
channel
Canal de venta la publicación
Tipo
STRING
Valores Posibles
mshops
mercadoshops
meli
mercadolibre
external_reference
Referencia externa del id de producto
Tipo
STRING
sku
"UWD5U": SKU del producto.
Código de identificación del producto.
Tipo
STRING
SKU según wikipwedia:
title
Titulo de la publicación.
Tipo
STRING
quantity
Cantidad Vendida
Tipo
NUMERICO
method
Método de entrega
Tipo
STRING
currency
Moneda de la venta
Tipo
STRING
Valores Posibles
ARS
Argentine peso
BRL
Brazilian real
VEF
Venezuelan strong bolivar
CLP
Chilean peso
MXN
Mexican peso
COP
Colombian peso
UYU
Uruguayan peso
unit_price
Precio Unitario del producto
Tipo
NUMERICO
amount
Cantidad Vendida * Precio Unitario. Importe total
Tipo
NUMERICO
free_shipping
Indica si la publicación tiene envío gratis
Tipo
BOOLEAN
Valores Posibles
true
ENVIO GRATIS
false
SIN ENVIO GRATIS
meli_variation_id
Si es un producto de MercadoLibre indica el ID de la variación talle / color del producto
Tipo
NUMERICO
variations
[ Datos de la Variación ( talle y color )
Tipo
OBJETO
{
name
Nombre de la variación
Tipo
STRING
value
Valor de la variación
Tipo
STRING
}
],
promotion
Promoción incluida en el producto
Tipo
STRING
},
PRODUCTO NRO 2
{
PRODUCTO NRO 3
},
{
PRODUCTO NRO 4
},
{
PRODUCTO NRO 5
}
],
notes
[],
feedback
{
buyer
null,
seller
null
},
promotions
[],
free_shipping
false
}
{
id
1999999999999,
store_id
15999999999,
channel
"meli",
external_reference
999999999999,
currency
"ARS",
amount
1405,
products_total
1405,
products_discounts_total
0 ,
products_grand_total
1405 ,
discounts_total
0 ,
shipping_total
57.99 ,
grand_total
1462.99 ,
creation_date
" 2015-09-10T07:31:03.000-04:00 ",
buyer_message
null ,
products_discounts_total
0 ,
products_discounts_total
0 ,
status
{
delivered
false,
paid
true,
closed
false,
closed_reason
null,
closed_date
null,
processed
true,
processed_date
null,
contact_data_status
"new",
order_status
"paid",
},
buyer
{
id
899999999999,
meli_cust_id
15399999999,
name
"Carlos Perez",
nickname
"CARLLLLLLLLLLL",
client_id
379999999999,
mail
carlos.perez@gmail.com,
mail2
null,
phone
"11-4444-5555",
phone2
null,
doc_number
"123456789",
doc_type
"DNI",
},
payments
[
{
id
1199999999,
external_reference
130299999999999,
status
"approved",
provider
"mercadopago",
method
"pagofacil",
currency
"ARS",
amount
1405,
paid
true,
paid_date
"2015-09-16T09:47:28.000-04:00",
installments
null,
fees
{
finance_fee
null
}
}
],
shippings
[
{
id
4699999,
external_reference
21499999,
ship_type
"me2",
channel_status
"on_route",
status
"on_route",
receiver
{
doc_type
null,
doc_number
"9999999999",
name
"Carlos Perez",
email
"carlos.perez@gmail.com",
phone
"0353999999",
address
"Calle 51",
zip
"999",
neighbourhood
null,
municipality
null,
city
"Las 99999",
state_id
"AR-X",
country_id
"AR",
},
additional_info
null,
method_id
152,
method
"Estándar",
currency
"ARS",
amount
57.99,
tracking_code
"3899999999999961",
observations
null,
date_created
"2015-09-16T09:47:31.000-04:00"
}
],
invoice
{
invoiced
false,
type
null,
number
null,
invoiced_date
null,
},
products
[
{
id
879999910,
channel
"meli",
external_reference
"MLA99999999999",
sku
null,
title
"Zapatillas 99999",
sku
null,
quantity
1,
currency
"ARS",
unit_price
1405,
amount
1405,
free_shipping
false,
meli_variation_id
91999949,
variations
[
{
name
"Color Primario",
value
"Negro"
},
{
name
"Talle",
value
"41.5"
},
{
name
"Color Secundario",
value
"Azul"
}
],
promotion
null
}
],
notes
[],
feedback
{
buyer
null,
seller
null
},
promotions
[],
free_shipping
null
}
BUSQUEDA POR FILTROS
GET  /v1/shops/{SHOP_ID}/orders/SEARCH 

Mostrar ejemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/orders/search?status=unanswered&limit=10&orders=question_date_asc&access_token={access_token} 

Parametros

ParametroValoresEjemplo
access_token Codigo de seguridad access_token=APP_USR-4X30-XXXXX-
SHOP_ID Id de usuario de mercadolibre / mercadoshops https://api.mercadoshops.com/v1/shops /15XXXXX24/

FILTROS

NombreValoresEjemplo
status new: Nueva Venta

first_contact: Primer contacto realizado

confirmed_data: Venta con datos de contacto confirmado
status=new
processed true: venta procesada

false: sin procesar
processed=true
paid true: venta pagada

false: no pagada
paid=true
delivered true: venta despachada

false: sin despacahar
delivered=true
closed true: venta cerrada

false: sin cerrar
closed=true
channel mshops: canal de venta mercadoshops

meli: canal de venta mercadolibre
channel=mshops
buyer_feedback true: calificación del comprador realizada

false: calificación del comprador pendiente
buyer_feedback=true
seller_feedback true: calificación del vendedor realizada

false: calificación del vendedor pendiente
seller_feedback=true
feedback true: calificación del comprador y vendedor realizada

false: calificación del comprador y vendedor pendiente
feedback=true
shipping Pending : Envio pendiente

pickup: Envio levantado del vendedor

on_route: Envio en viaje

print_tag: etiqueta impresa

to_be_agreed: envio a convener

in_progress: en progreso

delivered: Entregado
shipping=pending

PAGINADO Y ORDENAMIENTO

NombreValoresEjemplo
limit Limite de registros devueltos limit=10
orders creation_date_asc

Orden por fecha de creacion ascendente

creation_date_desc

Orden por fecha de creacion descendente

client_id_asc

Orden por cliente_id ascendente

client_id_desc

Orden por cliente_id descendente

name_asc

Orden por nombre de l cliente ascendente

name_desc

Orden por nombre del cliente descendente

total_last_updated_asc

Orden total por ultima actualizacion ascendente

total_last_updated_sasc

Orden total por ultima actualizacion de ascendente
orders=creation_date_asc
{
seller_id
Id usuario de mercadolibre / mercadoshops
Tipo
NUMERICO
query
palabra que se utilizó para la búsqueda
Tipo
STRING
paging
{
Descripción
Resumen del Paginado
Tipo
OBJETO
total
Total de resultados devueltos
Tipo
NUMERICO
offset
Offset aplicado
Tipo
NUMERICO
limit
Limite de resultados aplicado
Tipo
NUMERICO
},
results
[
{
Estructura de Respuesta de una VENTA
},
{
Estructura de Respuesta de una VENTA
},
],
orders
[ Ordenamiento APLICADO
Tipo
OBJETO
{
id
"creation_date_desc",
name
"Order by creation date descending"
}
],
filters
[ Filtros APLICADOS
Tipo
OBJETO
{
id
"channel",
name
"Channel",
values
[
{
id
"meli",
name
"Meli orders",
results
707
}
]
}
],
available_orders
[ Ordenamiento Disponibles
Tipo
OBJETO
{
id
"creation_date_asc",
name
"Order by creation date ascending"
},
{
id
"creation_date_desc",
name
"Order by creation date descending"
},
{
id
"client_id_asc",
name
"Order by client id ascending"
},
{
id
"client_id_desc",
name
"Order by client id descending"
},
{
id
"name_asc",
name
"Order by client name ascending"
},
{
id
"name_desc",
name
"Order by client name ascending"
},
{
id
"total_last_updated_asc",
name
"Order by total last updated ascending"
},
{
id
"total_last_updated_desc",
name
"Order by total last updated descending"
}
],
available_filters
[ Filtros Disponibles
Tipo
OBJETO
{
id
"status",
name
"Status",
values
[
{
id
"new",
name
"New orders",
results
0
},
{
id
"first_contact",
name
"Orders with first contact made",
results
0
},
{
id
"confirmed_data",
name
"Orders with confirmed data",
results
0
},
]
},
{
id
"processed",
name
"Processed",
values
[
{
id
"true",
name
"Processed orders",
results
0
},
{
id
"false",
name
"Not processed orders",
results
0
}
]
},
{
id
"paid",
name
"Paid",
values
[
{
id
"true",
name
"Paid orders",
results
0
},
{
id
"false",
name
"Not paid orders",
results
0
}
]
},
{
id
"delivered",
name
"Delivered",
values
[
{
id
"true",
name
"Delivered orders",
results
0
},
{
id
"false",
name
"Not delivered orders",
results
0
}
]
},
{
id
"closed",
name
"Closed",
values
[
{
id
"true",
name
"Closed orders",
results
0
},
{
id
"false",
name
"Not closed orders",
results
0
}
]
},
{
id
"channel",
name
"Channel",
values
[
{
id
"meli",
name
"Meli orders",
results
707
},
{
id
"mshops",
name
"Mshops orders",
results
0
}
]
},
{
id
"buyer_feedback",
name
"Buyer_feedback",
values
[
{
id
"true",
name
"Buyer feedback completed",
results
0
},
{
id
"false",
name
"Buyer feedback not completed",
results
0
}
]
},
{
id
"seller_feedback",
name
"Seller_feedback",
values
[
{
id
"true",
name
"Seller feedback completed",
results
0
},
{
id
"false",
name
"Seller feedback not completed",
results
0
}
]
},
{
id
"feedback",
name
"Feedback (buyer + seller)",
values
[
{
id
"true",
name
"Seller and buyer feedback completed",
results
0
},
{
id
"false",
name
"Seller and buyer feedback not completed",
results
0
}
]
},
{
id
"shipping",
name
"Shipping status",
values
[
{
id
"pending",
name
"Pending",
results
10
},
{
id
"pickup",
name
"Pickup",
results
0
},
{
id
"on_route",
name
"On_route",
results
14
},
{
id
"print_tag",
name
"Print_tag",
results
0
},
{
id
"to_be_agreed",
name
"To be agreed",
results
82
},
{
id
"in_progress",
name
"In progress",
results
82
},
{
id
"delivered",
name
"In progress",
results
579
}
]
},
{
id
"pending_process",
name
"Not processed orders",
values
[ Resumen de VENTAS Pendientes
Tipo
OBJETO
{
id
"pending_process",
name
"Not processed orders",
results
Cantidad de resultados
Tipo
NUMERICO
}
]
},
{
id
"pending_shipment",
name
"Not shipped orders",
values
[ Resumen de VENTAS con ENVIO Pendiente
Tipo
OBJETO
{
id
"pending_shipment",
name
"Not shipped orders",
results
Cantidad de resultados
Tipo
NUMERICO
}
]
},
{
id
"pending_feedback",
name
"Pending feedback orders",
values
[ Resumen de VENTAS con Calificación Pendiente
Tipo
OBJETO
{
id
"pending_feedback",
name
"Pending feedback orders",
results
Cantidad de resultados
Tipo
NUMERICO
}
]
},
{
id
"closed_orders",
name
"Closed orders",
values
[ Resumen de VENTAS con Calificación Pendiente
Tipo
OBJETO
{
id
"closed_orders",
name
"Closed orders",
results
Cantidad de resultados
Tipo
NUMERICO
}
]
}
]
}
ERRORES :
403: Token Invalido
ACTUALIZAR LOS DATOS DE FACTURACIÓN
PUT  /v1/shops/{SHOP_id}/orders/{ORDER_ID} 

Mostrar ejemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/orders/{ORDER_ID}?access_token={token} 

Parametros

ParametroValoresEjemplo
access_token Codigo de seguridad access_token=APP_USR-4X30-XXXXX-
SHOP_ID Id de usuario de mercadolibre / mercadoshops https://api.mercadoshops.com/v1/shops /159999999/
ID ID de venta v1/shops/159999999/orders/999911111
Invoice
{ DATOS DE FACTURACIÓN
Tipo
OBJETO
Invoiced
Indica si esta facturado
Tipo
BOOLEAN
Valores Posibles
true
facturado
false
no facturado
number
número de comprobante
Tipo
STRING
type
tipo de comprobante
Tipo
STRING
}
{
invoice
{
invoiced
true,
number
"060300007620",
type
"FC"
}
}
ACTUALIZAR LOS DATOS DE SHIPPING

Mediante este método podes actualizar el status del shipping y el tracking code.

PUT  /v1/shops/{SHOP_id}/orders/{ORDER_ID}/shippings/{SHIPPING_ID} 

Mostrar ejemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/orders/{ORDER_ID}/shippings/{SHIPPING_ID}?access_token={token} 

Parametros

ParametroValoresEjemplo
access_token Codigo de seguridad access_token=APP_USR-4X30-XXXXX-
SHOP_ID Id de usuario de mercadolibre / mercadoshops https://api.mercadoshops.com/v1/shops /159999999/
ID ID de venta v1/shops/159999999/orders/999911111
SHIPPING_ID ID de ENVIO  
status
estado del envío
Tipo
STRING
Valores posibles
pickup
Lo retira
pending
Pendiente de entrega
in_progress
En preparación
on_route
En camino
delivered
Entregado
tracking_code
código de seguimiento
Tipo
STRING
{
status
"pending",
tracking_code
"111111"
}