Informações do comprador nos itens do pedido

Tutorial

Você pode usar um RDT para obter informações do comprador para os itens do pedido em um pedido que você especificar.

Neste fluxo de trabalho, você especifica dataElements = buyerInfo para indicar que o RDT irá autorizar seu aplicativo a acessar as informações do comprador para os itens de pedido especificados.

Pré-requisitos

Para concluir este tutorial, você precisará:

1. Obter um order ID

Você precisa de um ID de pedido para fazer a chamada passando o a informações do item do pedido. Esse ID também será usado para obter um RDT que autoriza seu aplicativo a acessar as informações do comprador para os itens do pedido, pode usar a chamada getOrders da API de pedidos para obter uma lista de pedidos, obtendo assim o ID necessário.

  1. Faça a chamada em getOrders da API de pedidos, especificando os parâmetros apropriados para filtrar o pedido que você deseja.
    A operação retorna pedidos que correspondem à sua solicitação. Cada pedido inclui um ID de pedido

  2. Dos pedidos que são devolvidos, identifique aquele para o qual deseja informações do item do pedido.

  3. Salve a ID do pedido que deseja para usar na Etapa 2. Obtenha um token RDT e a Etapa 3. Inclua o RDT na chamada de getOrderItems.

2. Obter um token RDT

Chame a operação createRestrictedDataToken para obter um RDT.

ValorDescrição
restrictedResources

Obrigatório

Tipo: RestrictedResource
Modelo de recurso restrito. Máximo: 50

Exemplo de chamada

Sem RDT
{
  "restrictedResources": [
    {
      "method": "GET",
      "path": "/orders/v0/orders",
      "dataElements": ["buyerInfo", "shippingAddress"]
    }
  ]
}

Com RDT
{
  "restrictedResources": [
    {
      "method": "GET",
      "path": "/orders/v0/orders/123-1234567-1234567/orderItems",
      "dataElements": ["buyerInfo"]
    }
  ]
}

Resposta

Exemplo de resposta com sucesso:

ValorDescrição
restrictedDataToken

Tipo: String
Um Token de Dados Restritos (RDT).
Este é um token de acesso de curta duração que autoriza você a chamar as operações restritas representadas pelos recursos restritos que você especificou. Passe o valor RDT no cabeçalho x-amz-access-token ao fazer chamadas subsequentes para as operações restritas.
expiresIn

Tipo: Integer
A vida útil do RDT, em segundos.
{
  "payload": {
    "restrictedDataToken": "Atz.sprdt|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSR",
    "expiresIn": 3600
  }
}

Salve o valor do restrictedDataToken (RDT) para usar em 2. Incluir RDT na chamada da getOrders.

3. Inclua o RDT na chamada de getOrderItems

Chame a operação getOrderItems da API de pedidos, especificando o ID do pedido que você identificou na Etapa 1. Obtenha um ID do pedido. Certifique-se de incluir o RDT da Etapa 1 no cabeçalho x-amz-access-token de sua chamada para getOrderItems.