Guía de casos de uso de la API de ventas v1
Casos de uso de la API de ventas.
Versión de API: v1
¿Qué es la API de ventas?
The Selling Partner API for Sales (Sales API) provides sellers with sales performance information. This is achieved through returning aggregated order metrics for a given period of time, broken down by granularity, and buyer type. Refer to the Sales API Reference for details about Sales API operations and associated data types and schemas.
Requisitos
Para completar con éxito este tutorial necesitarás lo siguiente:
- Authorization from the selling partner for whom you are making calls. Refer to Authorizing Selling Partner API applications for more information.
- The Pricing role assigned to your developer profile.
- The Pricing role selected in the App registration page for your application.
Tutorial: Recibir información sobre el rendimiento de ventas
En esta sección se te guiará a través del proceso de recepción de información sobre el rendimiento de las ventas utilizando la API de ventas.
Obtener información sobre el rendimiento de las ventas
Call the getOrderMetrics
operation with the following parameters to receive aggregated order metrics for a given interval:
Parámetro de consulta:
Parámetro | Descripción | Obligatorio |
marketplaceIds |
Un identificador de sitio web. Especifica el sitio web en el que se realizó el pedido. Solo se puede especificar un sitio web. Por ejemplo, Tipo: matriz < cadena > |
Sí |
interval |
A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO 8601 format and must represent absolute time (either Z notation or offset notation). Ejemplo: Tipo: cadena |
Sí |
granularityTimeZone |
Una zona horaria conforme con IANA para determinar el límite de días. Obligatorio cuando se especifica un valor de granularidad superior a Hora. El valor de Ejemplo: EE. UU./Pacífico para calcular los límites de días, teniendo en cuenta el horario de verano, para la zona EE. UU./Pacífico. Tipo: cadena |
No |
granularity |
El Ejemplo: Day para obtener un desglose diario del intervalo de solicitudes, donde el límite del día está definido por Type: enum (Granularity) |
Sí |
buyerType |
Filtra los resultados por el tipo de comprador especificado, Ejemplo: Type: enum (BuyerType) |
No |
fulfillmentNetwork |
Filtra los resultados por la red de gestión logística especificada, Ejemplo: Tipo: cadena |
No |
firstDayOfWeek |
Especifica el día en que comienza la semana cuando Ejemplo: Type: enum (FirstDayOfWeek) |
No |
asin |
Filtra los resultados por el ASIN especificado. Si se especifica Ejemplo: Tipo: cadena |
No |
sku |
Filtra los resultados por el SKU especificado. Si se especifica Ejemplo: Tipo: cadena |
No |
Ejemplo de solicitud
GET https://sellingpartnerapi-na.amazon.com/sales/v1/orderMetrics?marketplaceIds=&interval=&granularityTimeZone=&granularity=&buyerType=&fulfillmentNetwork=&firstDayOfWeek=&asin=&sku="
Respuesta
Parámetro | Descripción | Obligatorio |
interval |
El intervalo de tiempo basado en la granularidad solicitada (por ejemplo, Hour, Day, etc.). Si es el primero o el último intervalo de la lista, puede contener datos incompletos si el intervalo solicitado no coincide con la granularidad solicitada. (por ejemplo, Tipo: cadena |
Sí |
unitCount |
El número de unidades de los pedidos en función de los filtros especificados. Tipo: entero |
Sí |
orderItemCount |
El número de artículos del pedido en función de los filtros especificados. Tipo: entero |
Sí |
orderCount |
El número de pedidos en función de los filtros especificados. Tipo: entero |
Sí |
averageUnitPrice |
El precio medio de un artículo basado en los filtros especificados. La fórmula es totalSales/unitCount. Type: Money |
Sí |
totalSales |
El total de ventas de productos encargados para todos los pedidos basados en los filtros especificados. Type: Money |
Sí |
Ejemplo de respuesta
{
"request": {
"parameters": {
"granularity": {
"value": "Day"
}
}
},
"response": {
"payload": [
{
"interval": "2019-08-01T00:00-07:00--2018-08-02T00:00-07:00",
"unitCount": 1,
"orderItemCount": 1,
"orderCount": 1,
"averageUnitPrice": {
"amount": "22.95",
"currencyCode": "USD"
},
"totalSales": {
"amount": "22.95",
"currencyCode": "USD"
}
},
{
"interval": "2019-08-02T00:00-07:00--2018-08-03T00:00-07:00",
"unitCount": 1,
"orderItemCount": 1,
"orderCount": 1,
"averageUnitPrice": {
"amount": "2.05",
"currencyCode": "USD"
},
"totalSales": {
"amount": "2.05",
"currencyCode": "USD"
}
}
]
}
}
Updated 5 months ago