Hub per sviluppatoriStato dell'APISupporto

Guida ai casi d'uso dell'API Vendite v1

Casi d'uso per l'API di vendita.

Versione API: v1

Cos'è l'API Vendite?

L'API per i partner di vendita per le vendite (API Vendite) fornisce ai venditori informazioni sull'andamento delle vendite. Tale andamento si ottiene restituendo metriche aggregate degli ordini per un determinato periodo di tempo, suddivise per granularità e tipo di acquirente. Fai riferimento a Riferimento API Vendite per informazioni dettagliate sulle operazioni dell'API Vendite e sui tipi di dati e schemi associati.

Prerequisiti

Per completare correttamente questo tutorial, devi disporre di quanto segue:

  1. Autorizzazione dal partner di vendita per il quale stai effettuando chiamate. Per ulteriori informazioni, vedi Autorizzazione delle applicazioni API per i partner di vendita.
  2. Il ruolo Prezzi assegnato al tuo profilo sviluppatore.
  3. Il ruolo Prezzi selezionato nella pagina di registrazione dell'app per la tua applicazione.

Tutorial: Ricevere informazioni sulle prestazioni di vendita

Questa sezione ti guiderà attraverso la procedura per ricevere informazioni sulle prestazioni di vendita utilizzando l'API Vendite.

Ottieni informazioni sulle prestazioni di vendita

Chiama l'operazione getOrderMetrics con i seguenti parametri per ricevere metriche aggregate degli ordini per un determinato intervallo:

Parametro di query:

Parametro Descrizione Obbligatorio
marketplaceIds

Un identificativo del marketplace. Specifica il marketplace in cui è stato effettuato l'ordine. È possibile specificare un solo marketplace.

Ad esempio ATVPDKIKX0DER indica il marketplace statunitense.

Type: < stringa > array

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).

Esempio: 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 richiede le metriche degli ordini per il 1°, il 2 e il 3 settembre nella zona -07:00.

Tipo: stringa

granularityTimeZone

Un fuso orario compatibile con IANA per determinare il limite del giorno. Obbligatorio quando si specifica un valore di granularità superiore a Ora. Il valore granularityTimeZone deve essere allineato con l'offset del valore dell'intervallo specificato. Ad esempio, se il valore dell'intervallo utilizza la notazione Z, granularityTimeZone deve essere UTC. Se il valore dell'intervallo utilizza un offset, allora granularityTimeZone deve essere un fuso orario compatibile con IANA che corrisponda all'offset.

Esempio: Stati Uniti/Pacifico per calcolare i limiti del giorno, tenendo conto dell'ora legale, per la zona Stati Uniti/Pacifico.

Tipo: stringa

No
granularity

Il valore granularity del raggruppamento delle metriche degli ordini, in base a un'unità di tempo. Specificando granularity=Hour, si ottiene una richiesta riuscita solo se l'intervallo specificato è inferiore o uguale a 30 giorni a partire da oggi. Per tutte le altre granularità, l'intervallo specificato deve essere inferiore o uguale a 2 anni a partire da oggi. Specificando granularity=Total, si ottengono metriche degli ordini aggregate nell'intero intervallo specificato. Se la data di inizio e di fine dell'intervallo non è in linea con il valore granularity specificato, l'inizio e la fine dell'intervallo di risposta conterranno dati parziali.

Esempio: giorno per ottenere una ripartizione giornaliera dell'intervallo di richiesta, in cui il limite del giorno è definito dal valore granularityTimeZone.

Type: enum (Granularity)

buyerType

Filtra i risultati in base al tipo di acquirente specificato, B2B (da azienda a azienda) o B2C (da azienda a cliente).

Esempio: B2B, se desideri che la risposta includa le metriche degli ordini solo per gli acquirenti B2B.

Type: enum (BuyerType)

No
fulfillmentNetwork

Filtra i risultati in base alla rete logistica specificata, MFN (rete logistica del venditore) o AFN (rete logistica di Amazon). Non includere questo filtro se desideri che la risposta includa le metriche degli ordini per tutte le reti logistiche.

Esempio: AFN, se desideri che la risposta includa le metriche degli ordini solo per la rete logistica di Amazon.

Tipo: stringa

No
firstDayOfWeek

Specifica il giorno in cui inizia la settimana quando granularity=Week o Monday o Sunday. Valore predefinito: Monday.

Esempio: Sunday, se desideri che la settimana inizi di domenica.

Type: enum (FirstDayOfWeek)

No
asin

Filtra i risultati in base all'ASIN specificato. Se si specificano asin e sku, viene restituito un errore. Non includere questo filtro se desideri che la risposta includa le metriche degli ordini per tutti gli ASIN.

Esempio: B0792R1RSN, se desideri che la risposta includa le metriche degli ordini solo per asin B0792R1RSN.

Tipo: stringa

No
sku

Filtra i risultati in base all'o SKU specificato. Se si specificano asin e sku, viene restituito un errore. Non includere questo filtro se desideri che la risposta includa le metriche degli ordini per tutti gli SKU.

Esempio: TestSKU, se desideri che la risposta includa le metriche degli ordini solo per lo SKU TestSKU.

Tipo: stringa

No

Esempio di richiesta

GET https://sellingpartnerapi-na.amazon.com/sales/v1/orderMetrics?marketplaceIds=&interval=&granularityTimeZone=&granularity=&buyerType=&fulfillmentNetwork=&firstDayOfWeek=&asin=&sku="

Risposta

Parametro Descrizione Obbligatorio
interval

L'intervallo di tempo in base alla granularità richiesta (esempio, Ora, Giorno, ecc.) Se questo è il primo o l'ultimo intervallo dell'elenco, potrebbe contenere dati incompleti, se l'intervallo richiesto non è in linea con la granularità richiesta

(ad esempio con l'intervallo di richiesta 2018-09-01T02:00:00Z--2018-09-04T19:00:00Z e il giorno di granularità, i giorni 1° settembre UTC e 4 settembre UTC avranno dati parziali).

Tipo: stringa

unitCount

Il numero di unità negli ordini in base ai filtri specificati.

Tipo: intero

orderItemCount

Il numero di articoli dell'ordine in base ai filtri specificati.

Tipo: intero

orderCount Il numero di ordini in base ai filtri specificati.

Tipo: intero

averageUnitPrice Il prezzo medio di un articolo in base ai filtri specificati. La formula è totalSales/unitCount.

Type: Money

totalSales Il totale delle vendite di prodotti ordinati per tutti gli ordini in base ai filtri specificati.

Type: Money

Esempio di risposta

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

Questa pagina ti è stata utile?