Guias de uso
Documentação GlobalDeveloper HubSuporteStatus da API

Acknowledgement

Suggest Edits

Order Acknowledgement Feed

Esta API é utilizada para informar à Amazon que o pedido foi importado com sucesso e o vendedor
já está com visibilidade do pedido. Ela também é utilizada para informar o cancelamento de um
pedido.

Se o desenvolvedor precisar informar que o pedido inteiro (com todos os seus itens) foi importado
com sucesso, ou será inteiramente cancelado, não é necessário informar AmazonOrderItemCode e
CancelReason. Para informar sucesso de importação ou cancelamente de ALGUM ITEM ESPECÍFICO
(não para o pedido inteiro), informar AmazonOrderItemCode e CancelReason deste item específico.

📘

Importante

Em se tratando de cancelamento, esta API só pode ser chamada se o pedido
inteiro for cancelado. Esta API não pode ser chamada se algum item do pedido já foi enviado ao comprador.

Para cancelamentos ou atualizações parciais dos items de um pedido, é recomendado utilizar o Feed de Adjustment

Esta API pode ser utilizada para passar informações sobre vários pedidos (OrderIDs) em um único
XML. Mais informações neste link.

Configuração do XML

  • Parâmetros obrigatórios:
    • OrderID e StatusCode
  • Throttling inicial:
    • Rate: 5 requests/segundo
    • Burst: 20 requests
    • Limite por hora: 18.000 requests/hora
  • Método HTTP: GET
  • Path: /Products/2011-10-01 HTTP/1.1
  • EndPoints: https://sellingpartnerapi-na.amazon.com/
  • Headers:
    • Authorization
    • host
    • x-amz-access-token
    • x-amz-date
    • user-agent
  • Parâmetros:
Valor
AmazonOrderIdObrigatório
MerchantOrderIDOpcional
StatusCodeObrigatório
AmazonOrderItemCodeOpcional
MerchantOrderItemIDOpcional
CancelReasonOpcional
QuantityOpcional

Exemplos de Requests

<AmazonEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="amzn-envelope.xsd">
  <Header>
    <DocumentVersion>1.01</DocumentVersion>
    <MerchantIdentifier>AAAAA11A0AA00A</MerchantIdentifier>
  </Header>
  <MessageType>OrderAcknowledgement</MessageType>
  <Message>
    <MessageID>1</MessageID>
    <OrderAcknowledgement>
      <AmazonOrderID>701-1111111-1111111</AmazonOrderID>
      <StatusCode>Success</StatusCode>
    </OrderAcknowledgement>
  </Message>
</AmazonEnvelope>

Confirmar importação de alguns itens para 1 único pedido

<AmazonEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="amzn-envelope.xsd">
  <Header>
    <DocumentVersion>1.01</DocumentVersion>
    <MerchantIdentifier>AAAAA11A0AA00A</MerchantIdentifier>
  </Header>
  <MessageType>OrderAcknowledgement</MessageType>
  <Message>
    <MessageID>1</MessageID>
    <OrderAcknowledgement>
      <AmazonOrderID>701-1111111-1111111</AmazonOrderID>
      <StatusCode>Success</StatusCode>
      <Item>
        <AmazonOrderItemCode>10811208637050</AmazonOrderItemCode>
      </Item>
      <Item>
        <AmazonOrderItemCode>44738064046098</AmazonOrderItemCode>
      </Item>
    </OrderAcknowledgement>
  </Message>
</AmazonEnvelope>

Confirmar importação total de multiplos pedidos distintos

<?xml version="1.0"?>
<AmazonEnvelope
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="amzn-envelope.xsd">
	<Header>
		<DocumentVersion>1.01</DocumentVersion>
		<MerchantIdentifier>A2ZPJ4TLUOSWY8</MerchantIdentifier>
	</Header>
	<MessageType>OrderAcknowledgement</MessageType>
	<Message>
		<MessageID>1</MessageID>
		<OrderAcknowledgement>
			<AmazonOrderID>702-3409898-7751426</AmazonOrderID>
			<StatusCode>Success</StatusCode>
			<Item>
				<AmazonOrderItemCode>22062367203706</AmazonOrderItemCode>
			</Item>
		</OrderAcknowledgement>
	</Message>
	<Message>
		<MessageID>2</MessageID>
		<OrderAcknowledgement>
			<AmazonOrderID>702-0376776-1232218</AmazonOrderID>
			<StatusCode>Success</StatusCode>
			<Item>
				<AmazonOrderItemCode>21566536262762</AmazonOrderItemCode>
			</Item>
		</OrderAcknowledgement>
	</Message>
	<Message>
		<MessageID>3</MessageID>
		<OrderAcknowledgement>
			<AmazonOrderID>702-6549913-9779437</AmazonOrderID>
			<StatusCode>Success</StatusCode>
			<Item>
				<AmazonOrderItemCode>62137479254466</AmazonOrderItemCode>
			</Item>
		</OrderAcknowledgement>
	</Message>
</AmazonEnvelope>

Cancelar todo o pedido

<AmazonEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="amzn-envelope.xsd">
  <Header>
    <DocumentVersion>1.01</DocumentVersion>
    <MerchantIdentifier>AAAAA11A0AA00A</MerchantIdentifier>
  </Header>
  <MessageType>OrderAcknowledgement</MessageType>
  <Message>
    <MessageID>1</MessageID>
    <OrderAcknowledgement>
      <AmazonOrderID>701-1111111-1111111</AmazonOrderID>
      <StatusCode>Failure</StatusCode>
    </OrderAcknowledgement>
  </Message>
</AmazonEnvelope>

🚧

Atualizar múltiplos Itens do mesmo pedido

Para atualizar um pedido com multiplos itens é necessários listar todos os itens deste pedido na chamada, seja ela Sucess ou Failure. Caso contrário ocorrerá um erro de formatação do XML.

	<OrderAcknowledgement>
		<AmazonOrderID>702-3409898-7751426</AmazonOrderID>
		<StatusCode>Failure</StatusCode>
		<Item>
			<AmazonOrderItemCode>22062367203706</AmazonOrderItemCode>
		</Item>
		<Item>
			<AmazonOrderItemCode>22062367203706</AmazonOrderItemCode>
		</Item>
		<Item>
			<AmazonOrderItemCode>22062367203706</AmazonOrderItemCode>
		</Item>
	</OrderAcknowledgement>

.### Cancelar importação de multiplos pedidos distintos

<?xml version="1.0"?>
<AmazonEnvelope
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="amzn-envelope.xsd">
	<Header>
		<DocumentVersion>1.01</DocumentVersion>
		<MerchantIdentifier>A2ZPJ4TLUOSWY8</MerchantIdentifier>
	</Header>
	<MessageType>OrderAcknowledgement</MessageType>
	<Message>
		<MessageID>1</MessageID>
		<OrderAcknowledgement>
			<AmazonOrderID>702-3409898-7751426</AmazonOrderID>
			<StatusCode>Failure</StatusCode>
			<Item>
				<AmazonOrderItemCode>22062367203706</AmazonOrderItemCode>
			</Item>
		</OrderAcknowledgement>
	</Message>
	<Message>
		<MessageID>2</MessageID>
		<OrderAcknowledgement>
			<AmazonOrderID>702-0376776-1232218</AmazonOrderID>
			<StatusCode>Failure</StatusCode>
			<Item>
				<AmazonOrderItemCode>21566536262762</AmazonOrderItemCode>
			</Item>
		</OrderAcknowledgement>
	</Message>
	<Message>
		<MessageID>3</MessageID>
		<OrderAcknowledgement>
			<AmazonOrderID>702-6549913-9779437</AmazonOrderID>
			<StatusCode>Failure</StatusCode>
			<Item>
				<AmazonOrderItemCode>62137479254466</AmazonOrderItemCode>
			</Item>
		</OrderAcknowledgement>
	</Message>
</AmazonEnvelope>

Exemplos de repostas

Relação de códigos

Segue relação de códigos de resposta para um feed em geral. Esses códigos são os mesmos para
todos os feeds de Orders desta seção.

HTTP CodeDescrição
200Sucesso
400Request possui parâmetros inválidos ou faltantes e não pode ser processado
401O Authorization header do request não está formatado corretamente ou o token não é válido.
403Acesso à solicitação é proibído. Possíveis razões para isso são:
- Acesso negado
- Não autorizado
- Token expirado
- Assinatura inválida
404O recurso especificado não existe
415O Content-type header do request é inválido
429Throttling: abuso de limite de throttling
500Algo inesperado aconteceu e não permitiu com que o servidor completasse o request
503Overloading temporário ou manutenção no servidor

Segue abaixo uma resposta para um erro de inconsistência de informação fornecida. A causa do
erro pode ser uma das duas abaixo:

  • (AmazonOrderID, AmazonOrderItemCode,...) que foi enviado não existe na base Amazon
  • Faltou enviar algum parâmetro (StatusCode, CancelReason,...)

Exemplo de XML de resposta

<AmazonEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="amzn-envelope.xsd">
  <Header>
    <DocumentVersion>1.02</DocumentVersion>
    <MerchantIdentifier>A8XQXJT14BDPO</MerchantIdentifier>
  </Header>
  <MessageType>ProcessingReport</MessageType>
  <Message>
    <MessageID>1</MessageID>
    <ProcessingReport>
      <DocumentTransactionID>1308607018675</DocumentTransactionID>
      <StatusCode>Complete</StatusCode>
      <ProcessingSummary>
        <MessagesProcessed>1</MessagesProcessed>
        <MessagesSuccessful>0</MessagesSuccessful>
        <MessagesWithError>1</MessagesWithError>
        <MessagesWithWarning>0</MessagesWithWarning>
      </ProcessingSummary>
      <Result>
        <MessageID>1</MessageID>
        <ResultCode>Error</ResultCode>
        <ResultMessageCode>18028</ResultMessageCode>
        <ResultDescription>The data you submitted is incomplete or invalid. For help fixing this,
          see http://sellercentral.amazon.com/gp/help/30721
          (http://sellercentral.amazon.com/gp/help/30721%3C/ResultDescription)>
          <AdditionalInfo>
            <AmazonOrderID>111-4081867-9346653</AmazonOrderID>
          </AdditionalInfo>
          </Result>
        </ProcessingReport>
      </Message>
    </AmazonEnvelope>

Updated over 2 years ago