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:

  1. Authorization from the selling partner for whom you are making calls. Refer to Authorizing Selling Partner API applications for more information.
  2. The Pricing role assigned to your developer profile.
  3. 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, ATVPDKIKX0DER indica el sitio web estadounidense.

Tipo: matriz < cadena >

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: 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 solicita métricas de pedidos para los días 1, 2 y 3 de septiembre en la zona horaria -07:00.

Tipo: cadena

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 granularityTimeZone debe estar alineado con el desfase del valor de intervalo especificado. Por ejemplo, si el valor de intervalo utiliza notación Z, entonces granularityTimeZone debe ser UTC. Si el valor de intervalo utiliza un desfase, entonces granularityTimeZone debe ser una zona horaria conforme con IANA que se corresponda con el desfase.

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 granularity de la agrupación de métricas de pedidos, basado en una unidad de tiempo. Si se especifica granularity=Hour, la solicitud solo tendrá éxito si el intervalo especificado es menor o igual a 30 días a partir de ahora. Para todas las demás granularidades, el intervalo especificado debe ser menor o igual a 2 años a partir de ahora. Si se especifica granularity=Total, las métricas de pedidos se agregarán a lo largo de todo el intervalo especificado. Si las fechas de inicio y fin del intervalo no coinciden con el granularity especificado, el inicio y el fin del intervalo de respuesta contendrán datos parciales.

Ejemplo: Day para obtener un desglose diario del intervalo de solicitudes, donde el límite del día está definido por granularityTimeZone.

Type: enum (Granularity)

buyerType

Filtra los resultados por el tipo de comprador especificado, B2B (empresa a empresa) o B2C (empresa a cliente).

Ejemplo: B2B, si quieres que la respuesta incluya métricas de pedidos solo para compradores B2B.

Type: enum (BuyerType)

No
fulfillmentNetwork

Filtra los resultados por la red de gestión logística especificada, MFN (red de gestión logística del vendedor) o AFN (red de gestión logística de Amazon). No incluyas este filtro si deseas que la respuesta incluya métricas de pedidos para todas las redes de gestión logística.

Ejemplo: AFN, si quieres que la respuesta incluya métricas de pedidos solo para la red logística de Amazon.

Tipo: cadena

No
firstDayOfWeek

Especifica el día en que comienza la semana cuando granularity=Week, que puede ser Monday o Sunday. Valor predeterminado: Monday.

Ejemplo: Sunday, si quieres que la semana comience en domingo.

Type: enum (FirstDayOfWeek)

No
asin

Filtra los resultados por el ASIN especificado. Si se especifica asin y sku se produce un error. No incluyas este filtro si quieres que la respuesta incluya métricas de pedidos para todos los ASIN.

Ejemplo: B0792R1RSN, si quieres que la respuesta incluya métricas de pedidos únicamente para asin B0792R1RSN.

Tipo: cadena

No
sku

Filtra los resultados por el SKU especificado. Si se especifica asin y sku se produce un error. No incluyas este filtro si quieres que la respuesta incluya métricas de pedidos para todos los SKU.

Ejemplo: TestSKU, si quieres que la respuesta incluya métricas de pedidos solo para el SKU TestSKU.

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, 2018-09-01T02:00:00Z--2018-09-04T19:00:00Z y el día de la granularidad del intervalo solicitado dará como resultado datos parciales para el 1 de septiembre UTC y el 4 de septiembre UTC).

Tipo: cadena

unitCount

El número de unidades de los pedidos en función de los filtros especificados.

Tipo: entero

orderItemCount

El número de artículos del pedido en función de los filtros especificados.

Tipo: entero

orderCount El número de pedidos en función de los filtros especificados.

Tipo: entero

averageUnitPrice El precio medio de un artículo basado en los filtros especificados. La fórmula es totalSales/unitCount.

Type: Money

totalSales El total de ventas de productos encargados para todos los pedidos basados en los filtros especificados.

Type: Money

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

¿Te ha ayudado esta página?