Guia de casos de uso da API de veículos v2024-11-01

Como usar a API Vehicles.

Versão da API: 2020-11-01

O que é a API Vehicles?

Com a API Selling Partner for Vehicles (API Vehicles), você pode recuperar informações sobre veículos, incluindo seus identificadores exclusivos. Você pode usar essas informações para fornecer informações de compatibilidade para os ASINs listados com a API Listings.

Os itens que exigem informações de instalação do veículo exigem uma lista de tipos de veículos. Essa API fornece uma lista de veículos e seu KTYPE, que você pode usar para mapear de forma independente cada item em seu catálogo para uma lista de KTypes. Esse mapeamento pode então ser fornecido à Amazon usando a API Listings.

O que há neste guia?

Este guia descreve como:

Use a API Vehicles para obter a lista mais recente de veículos.
Atualize as informações de ajuste de um ASIN usando a API Listings.

Terminologia

Código ASIN: número de identificação padrão da Amazon que identifica um item no catálogo da Amazon.
KTYPE: Um identificador numérico associado à definição de um veículo (marca, modelo, tipo, ano) e usado por várias marcas para vincular seus produtos.

Tutorial 1: Forneça informações de ajuste em ASINs

Forneça informações de compatibilidade para itens em seu catálogo.

Pré-requisitos

Para concluir este tutorial, você deve ter:

Autorização do parceiro de vendas para quem você está fazendo chamadas. Consulte Como autorizar aplicativos da API do parceiro de vendas para obter mais informações.
Aprovação para o Lista de produtos função em seu perfil de desenvolvedor.
A função Oferta de produtos selecionada na página de registro do seu aplicativo.

Etapa 1. Recupere uma lista de veículos e seus KTypes

Para obter uma lista de veículos, ligue para getVehicles operação.

Parâmetros de consulta

Nome	Descrição	Obrigatório
`marketplaceId`	Um identificador para o mercado no qual o recurso opera. Para encontrar a ID de um mercado, consulte IDs de mercado. Tipo: fio	Sim
`vehicleType`	O tipo de veículo. Os valores possíveis são `CAR` e `MOTORBIKE`. Tipo: enumeração (`VehicleType`)	Sim
`pageToken`	Um token que você pode usar para recuperar a próxima página ou a página anterior de resultados. A resposta inclui `pagination` quando o número de resultados excede o tamanho da página. Para obter a próxima página de resultados, chame a operação com o `nextToken` e inclua os mesmos argumentos da chamada que produziu o token. Para obter uma lista completa, chame esta operação até que não haja `nextToken` na resposta. Observe que essa operação pode retornar páginas vazias. Tipo: fio	Não
`updatedAfter`	Inclua esse campo para recuperar somente veículos que foram modificados ou adicionados ao catálogo da Amazon após a data que você forneceu. Deve estar em ISO 8601 formato de data e hora. Tipo: fio	Não

Exemplo de solicitação

GET https://sellingpartnerapi-eu.amazon.com/catalog/2024-11-01/automotive/vehicles?marketplaceId=A1F83G8C2ARO7P&updatedAfter=2024-11-01T01:00:00+01:00&vehicleType=CAR

Resposta

Uma resposta bem-sucedida inclui as seguintes propriedades:

Nome	Descrição
`pagination`	O `nextToken` e `previousToken` valores necessários para recuperar a próxima página ou a anterior de resultados, se disponíveis. Tipo: `Pagination`
`vehicles`	Uma lista de veículos do catálogo da Amazon. Tipo: < `Vehicle` > matriz

Exemplo de resposta

{
  "pagination": {
    "nextToken": "AQICAHhviiXpt-KG7DcOWDoXPW4_B4xAKk9r-8oi43dEh_cI4QF"
  },
  "vehicles": [
    {
      "bodyStyle": "MPV",
      "driveType": "Front-Wheel Drive",
      "energy": "Petrol/Liquified Petroleum Gas (LPG)",
      "engineOutput": [
        {
          "unit": "KILOWATT",
          "value": 61.0
        },
        {
          "unit": "HORSEPOWER",
          "value": 83.0
        }
      ],
      "identifiers": [
        {
          "standard": "KTYPE",
          "value": "100408"
        }
      ],
      "lastProcessedDate": "2024-11-01T01:00:00+01:00",
      "make": "Dacia",
      "manufacturingStartDate": {
        "month": 11,
        "year": 2013
      },
      "manufacturingStopDate": {
        "month": 12,
        "year": 2015
      },
      "model": "Dokker",
      "status": "ACTIVE",
      "variantName": "1.6 LPG"
    },
    {
      "bodyStyle": "Closed Off-Road Vehicle",
      "driveType": "All-wheel Drive",
      "energy": "Petrol",
      "engineOutput": [
        {
          "unit": "KILOWATT",
          "value": 100.0
        },
        {
          "unit": "HORSEPOWER",
          "value": 136.0
        }
      ],
      "identifiers": [
        {
          "standard": "KTYPE",
          "value": "10232"
        }
      ],
      "lastProcessedDate": "2024-11-01T01:00:00+01:00",
      "make": "Vauxhall",
      "manufacturingStartDate": {
        "month": 10,
        "year": 1998
      },
      "manufacturingStopDate": {
        "month": 10,
        "year": 2004
      },
      "model": "Frontera",
      "status": "ACTIVE",
      "variantName": "2.2 I"
    },
    {
      "bodyStyle": "Closed Off-Road Vehicle",
      "driveType": "All-wheel Drive",
      "energy": "Petrol",
      "engineOutput": [
        {
          "unit": "KILOWATT",
          "value": 151.0
        },
        {
          "unit": "HORSEPOWER",
          "value": 205.0
        }
      ],
      "identifiers": [
        {
          "standard": "KTYPE",
          "value": "10233"
        }
      ],
      "lastProcessedDate": "2024-11-01T01:00:00+01:00",
      "make": "Vauxhall",
      "manufacturingStartDate": {
        "month": 10,
        "year": 1998
      },
      "manufacturingStopDate": {
        "month": 10,
        "year": 2004
      },
      "model": "Frontera",
      "status": "ACTIVE",
      "variantName": "3.2 I"
    },
    {
      "bodyStyle": "Closed Off-Road Vehicle",
      "driveType": "All-wheel Drive",
      "energy": "Diesel",
      "engineOutput": [
        {
          "unit": "KILOWATT",
          "value": 85.0
        },
        {
          "unit": "HORSEPOWER",
          "value": 116.0
        }
      ],
      "identifiers": [
        {
          "standard": "KTYPE",
          "value": "10234"
        }
      ],
      "lastProcessedDate": "2024-11-01T01:00:00+01:00",
      "make": "Vauxhall",
      "manufacturingStartDate": {
        "month": 10,
        "year": 1998
      },
      "manufacturingStopDate": {
        "month": 9,
        "year": 2004
      },
      "model": "Frontera",
      "status": "ACTIVE",
      "variantName": "2.2 DTI"
    }
  ]
}

Etapa 2. Mapeie seus itens para KTypes

Use a resposta da etapa anterior para selecionar veículos nos quais seus itens se encaixam. Para cada item, registre o KTYPE dos veículos que se encaixam nele. Você fornece essa lista de KTypes na próxima etapa.

Etapa 3. Atualize o ajuste com a API Listings

Para atualizar as informações de ajuste em um ASIN, ligue para patchListingsItem operação. O patches o parâmetro no corpo da solicitação deve ter o path igual a /attributes/vehicle_fitment e contém a lista de KTypes em value.

Parâmetros do caminho

Nome	Descrição	Obrigatório
`sellerId`	Um identificador de parceiro de vendas, como uma conta de comerciante ou um código de fornecedor. Tipo: fio	Sim
`sku`	Um parceiro de vendas forneceu o identificador para uma listagem da Amazon. Tipo: fio	Sim

Parâmetros de consulta

Nome	Descrição	Obrigatório
`marketplaceIds`	Uma lista delimitada por vírgulas dos identificadores do Amazon Marketplace para a solicitação. Tipo: matriz	Sim
`includedData`	Uma lista delimitada por vírgulas de conjuntos de dados a serem incluídos na resposta. Tipo: < enumeração (`IncludedData`) > matriz	Não
`mode`	O modo de operação da solicitação. Tipo: enumeração (`Mode`)	Não
`issueLocale`	Um local para localização de problemas. Quando não é fornecido, o código de idioma padrão do primeiro mercado é usado. Tipo: fio	Não

Parâmetros do corpo

Nome	Descrição	Obrigatório
`productType`	O tipo de produto da Amazon do item do anúncio. Tipo: fio	Sim
`patches`	Uma ou mais operações de patch JSON a serem executadas no item da lista. Tipo: < `PatchOperation` > matriz	Sim

Exemplo de solicitação

PATCH https://sellingpartnerapi-eu.amazon.com/listings/2021-08-01/items/XXXXXXXXXX/SKU_XXXXXX?includedData=issues&marketplaceIds=A1PA6795UKMFR9
{
  "productType": "AUTO_OIL",
  "patches": [
    {
      "op": "replace",
      "path": "/attributes/vehicle_fitment",
      "value": [
        {
          "standard": [
            {
              "value": "ktype",
              "language_tag": "de_DE"
            }
          ],
          "code": [
            {
              "value": "10232, 10234, 10233",
              "language_tag": "de_DE"
            }
          ],
          "note": [
            {
              "value": "{\"10232,10234\":[[[\"Fahrwerk\",\"für Fahrzeuge mit M-Technik\"]]],\"10233\":[[[\"Fahrwerk\",\"für Fahrzeuge mit M-Technik\"],[\"Motorcode\",\"N47 D20 C\"]]]}",
              "language_tag": "de_DE"
            }
          ],
          "marketplace_id": "A1PA6795UKMFR9"
        }
      ]
    }
  ]
}

Resposta

Uma resposta bem-sucedida inclui as seguintes propriedades:

Nome	Descrição
`sku`	Um parceiro de vendas forneceu o identificador para uma listagem da Amazon. Tipo: fio
`status`	O status do envio do item do anúncio. Tipo: enumeração (`Status`)
`submissionId`	O identificador exclusivo do envio do item do anúncio. Tipo: fio
`issues`	Problemas com itens de ofertas relacionados ao envio de itens de anúncios. Tipo: < `Issue` > matriz
`identifiers`	Atributos de identidade associados ao item no catálogo da Amazon, como o ASIN. Tipo: `ItemIdentifiers`

Exemplo de resposta

{
  "sku": "SKU-XXXX-XXXX",
  "status": "ACCEPTED",
  "submissionId": "xxxxxxxxxxxxxxxxx",
  "issues": []
}

❗️
Termos de uso
Ao baixar e usar os dados fornecidos por essa API, os termos de uso encontrados aqui se inscrevem e são aceitos pelos usuários.

Updated 5 days ago

Esta página ajudou você?

O que é a API Vehicles?

O que há neste guia?

Terminologia

Tutorial 1: Forneça informações de ajuste em ASINs

Pré-requisitos

Etapa 1. Recupere uma lista de veículos e seus KTypes

Parâmetros de consulta

Exemplo de solicitação

Resposta

Exemplo de resposta

Etapa 2. Mapeie seus itens para KTypes

Etapa 3. Atualize o ajuste com a API Listings

Parâmetros do caminho

Parâmetros de consulta

Parâmetros do corpo

Exemplo de solicitação

Resposta

Exemplo de resposta

❗️Termos de uso

❗️
Termos de uso