Guia de caso de uso da API de restrições de listagens

Como acessar programaticamente as restrições nas listagens do catálogo da Amazon.

Versão da API: 2021-08-01

O que é a API de restrições de listagens (Listings Restrictions)?

A API Listings Restrictions é indicada para verificar se existem restrições que impedem a criação de uma listagem para um item no catálogo da Amazon. Se um item for restrito, você poderá executar etapas adicionais para solicitar aprovação para criar uma listagem. Consulte a Referência da API de restrições de listagens para obter detalhes sobre as operações da API e os tipos de dados e esquemas associados.

Use a API Listings Restrictions em conjunto com a API Listings Items. Por exemplo, você pode primeiro determinar se existem restrições de listagens usando a API Listings Restrictions. Se não houver restrições, você poderá chamar a API Listings Items para criar listagens somente de oferta. Consulte a Referência da API de itens de listagens para obter mais informações sobre a API Listings Items.

Características principais

  • A API Listings Restrictions fornece detalhes sobre restrições de listagens, se houver, em um item de catálogo existente identificado por ASIN.
  • Opcionalmente, você pode filtrar as restrições com base no tipo de condição.
  • A API de Restrições de Listagens oferece suporte à verificação de restrições de listagens em vários mercados em uma única chamada.
  • Quando a aprovação é necessária, a API Listings Restrictions retorna os links da próxima etapa para que você possa buscar a aprovação para criar a listagem.

Terminologia

  • ASIN: Número de identificação padrão da Amazon que identifica um item no catálogo da Amazon.

  • Listing: Uma listagem da Amazon é um item que um parceiro de vendas listou para venda na Amazon e é identificado por uma unidade de manutenção de estoque (SKU). Os fatos do produto incluídos nas listagens da Amazon são reconciliados em itens de catálogo da Amazon, que são identificados pelos números de identificação padrão da Amazon (ASINs)

  • Restriction: Uma restrição é uma condição que impede a criação de uma listagem. Em alguns casos, a restrição se deve a um requisito de aprovação, caso em que etapas adicionais podem estar disponíveis para solicitar a aprovação.

Tutorial: Obter restrições de listagens para um item no catálogo

Use este tutorial para recuperar quaisquer restrições de listagens para um item existente no catálogo da Amazon.

Para concluir este tutorial, você precisará de:

Etapa 1 - Obter restrições de listagens para um item no catálogo da Amazon

Chame a operação getListingsRestrictions para retornar quaisquer restrições de listagens, passando os seguintes parâmetros:

Query Parameters

ParâmetrosExemploDescriçãoTipo
asin

Obrigatório
B0000ASIN1O número de identificação padrão da Amazon (ASIN) do item.string
conditionTypenew_newA condição usada para filtrar restrições.enum(ConditionType
sellerid

Obrigatório
AXXXXXXXXXXXUm identificador de parceiro de vendas, como uma conta de comerciante.string
marketplaceIds

Obrigatório
A2Q3Y263D00KWCLista delimitada por vírgulas de identificadores de mercado da Amazon para a solicitação.< string > array(csv)
reasonLocalept_BRUma localidade para localização de texto de razão. Quando não fornecido, é usado o código de idioma padrão do primeiro marketplace. Exemplos: pt_BR, en_US, fr_CA, fr_FR. As mensagens localizadas assumem como padrão en_US quando uma localização não está disponível na localidade especificada.string

Exemplo de Requisição

https://sellingpartnerapi-na.amazon.com/listings/2021-08-01/restrictions
   ?asin=B08XXLG119
   &conditionType=
   &sellerId=AXXXXXXXXXXX
   &marketplaceIds=A2Q3Y263D00KWC

Resposta

Uma resposta bem-sucedida retorna informações sobre todas as restrições aplicáveis, se houver. Se não houver restrições para o conditionType especificado (quando fornecido) no mercado especificado, a lista de restrições na resposta estará vazia.

Quando existirem restrições para o conditionType especificado (quando fornecido) no mercado especificado, avalie a vetor de motivos (reasons) na resposta para determinar o motivo e identificar as próximas etapas, se houver. Cada motivo tem um reasonCode indicando por que a listagem é restrita.

Quando a aprovação é necessária

A Amazon exige que os parceiros de vendas obtenham aprovação antes de listar determinados itens à venda. O processo de aprovação pode incluir uma variedade de requisitos e qualificações de aprovação. Se o reasonCode na resposta indicar que a aprovação é necessária, o parceiro de vendas poderá solicitar aprovação para listar o item.

Nesse caso, use as informações no vetor de links na resposta para instruir o parceiro de vendas a navegar até o link de URL fornecido e seguir as instruções para solicitar a aprovação da lista.

Uma resposta bem-sucedida inclui o seguinte:

NomeExemploDescrição
restrictionsVeja Exemplo de RespostaUma lista de restrições para o item de catálogo da Amazon especificado.

Tipo: < Restriction > array

Resposta de Exemplo (sem restrições)

{
  "restrictions": [
    {
    }
  ]
}

Resposta de Exemplo (com restrições)

{
  "restrictions": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "conditionType": "collectible_like_new",
      "reasons": [
        {
          "reasonCode": "APPROVAL_REQUIRED",
          "message": "You cannot list the product in this condition.",
          "links": [
            {
              "resource": "https://sellercentral.amazon.com/hz/approvalrequest/restrictions/approve?asin=B08XXLG119",
              "verb": "GET",
              "title": "Request Approval via Seller Central.",
              "type": "text/html"
            }
          ]
        }
      ]
    },
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "conditionType": "new_new",
      "reasons": [
        {
          "reasonCode": "APPROVAL_REQUIRED",
          "message": "You need approval to list.",
          "links": [
            {
              "resource": "https://sellercentral.amazon.com/hz/approvalrequest/restrictions/approve?asin=B08XXLG119",
              "verb": "GET",
              "title": "Request Approval via Seller Central.",
              "type": "text/html"
            }
          ]
        }
      ]
    },
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "conditionType": "used_acceptable",
      "reasons": [
        {
          "reasonCode": "APPROVAL_REQUIRED",
          "message": "You cannot list the product in this condition.",
          "links": [
            {
              "resource": "https://sellercentral.amazon.com/hz/approvalrequest/restrictions/approve?asin=B08XXLG119",
              "verb": "GET",
              "title": "Request Approval via Seller Central.",
              "type": "text/html"
            }
          ]
        }
      ]
    },
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "conditionType": "used_like_new",
      "reasons": [
        {
          "reasonCode": "APPROVAL_REQUIRED",
          "message": "You cannot list the product in this condition.",
          "links": [
            {
              "resource": "https://sellercentral.amazon.com/hz/approvalrequest/restrictions/approve?asin=B08XXLG119",
              "verb": "GET",
              "title": "Request Approval via Seller Central.",
              "type": "text/html"
            }
          ]
        }
      ]
    },
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "conditionType": "collectible_very_good",
      "reasons": [
        {
          "reasonCode": "APPROVAL_REQUIRED",
          "message": "You cannot list the product in this condition.",
          "links": [
            {
              "resource": "https://sellercentral.amazon.com/hz/approvalrequest/restrictions/approve?asin=B08XXLG119",
              "verb": "GET",
              "title": "Request Approval via Seller Central.",
              "type": "text/html"
            }
          ]
        }
      ]
    },
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "conditionType": "used_very_good",
      "reasons": [
        {
          "reasonCode": "APPROVAL_REQUIRED",
          "message": "You cannot list the product in this condition.",
          "links": [
            {
              "resource": "https://sellercentral.amazon.com/hz/approvalrequest/restrictions/approve?asin=B08XXLG119",
              "verb": "GET",
              "title": "Request Approval via Seller Central.",
              "type": "text/html"
            }
          ]
        }
      ]
    },
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "conditionType": "collectible_acceptable",
      "reasons": [
        {
          "reasonCode": "APPROVAL_REQUIRED",
          "message": "You cannot list the product in this condition.",
          "links": [
            {
              "resource": "https://sellercentral.amazon.com/hz/approvalrequest/restrictions/approve?asin=B08XXLG119",
              "verb": "GET",
              "title": "Request Approval via Seller Central.",
              "type": "text/html"
            }
          ]
        }
      ]
    },
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "conditionType": "collectible_good",
      "reasons": [
        {
          "reasonCode": "APPROVAL_REQUIRED",
          "message": "You cannot list the product in this condition.",
          "links": [
            {
              "resource": "https://sellercentral.amazon.com/hz/approvalrequest/restrictions/approve?asin=B08XXLG119",
              "verb": "GET",
              "title": "Request Approval via Seller Central.",
              "type": "text/html"
            }
          ]
        }
      ]
    },
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "conditionType": "used_good",
      "reasons": [
        {
          "reasonCode": "APPROVAL_REQUIRED",
          "message": "You cannot list the product in this condition.",
          "links": [
            {
              "resource": "https://sellercentral.amazon.com/hz/approvalrequest/restrictions/approve?asin=B08XXLG119",
              "verb": "GET",
              "title": "Request Approval via Seller Central.",
              "type": "text/html"
            }
          ]
        }
      ]
    },
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "conditionType": "refurbished_refurbished",
      "reasons": [
        {
          "reasonCode": "APPROVAL_REQUIRED",
          "message": "You cannot list the product in this condition.",
          "links": [
            {
              "resource": "https://sellercentral.amazon.com/hz/approvalrequest/restrictions/approve?asin=B08XXLG119",
              "verb": "GET",
              "title": "Request Approval via Seller Central.",
              "type": "text/html"
            }
          ]
        }
      ]
    }
  ]
}