Adjustment

Order Adjustments Feed

Esta API é utilizada para informar à Amazon que algum item de um pedido precisa de algum ajuste
(cancelamento, reembolso, cobrança). É necessário fornecer um motivo para o ajuste, informar o
valor a ser devolvido/cobrado do comprador e qual o componente desse crédito/cobrança (no
valor do produto, taxa de armazenagem, frete adicional...). Mais informações neste link.

📘

Importante

Não é possível reembolsar um valor maior do que o custo original do item. A
API irá retornar erro caso o desenvolvedor tentar reembolsar R$ 30,00 para um item que custou
R$ 20,00.

Reembolsos para um mesmo item são cumulativos. Ou seja, se um reembolso de
R$ 15,00 for realizado para um item de um pedido XPTO e, em um segundo momento, outro
reembolso de R$ 5,00 for realizado, o reembolso total daquele item é de R$ 20,00. O cuidado que
se deve ter aqui é não passar do limite máximo de reembolso, ao se executar pequenos reembolsos.

Configuração do XML

Parâmetros obrigatórios:

  • AmazonOrderID (ou MerchantOrderID), ActionType, AmazonOrderItemCode (ou
    MerchantOrderItemID), AdjustmentReason e ItemPriceAdjustments
  • Throttling inicial:
    • Rate: 1 request/121 segundos
    • Burst: 15
  • Método HTTP: POST
  • Product Type: POST_PAYMENT_ADJUSTMENT_DATA
  • Path: /feeds/2020-09-04/feeds
  • EndPoints: https://sellingpartnerapi-na.amazon.com
  • Headers:
    • Authorization
    • host
    • x-amz-access-token
    • x-amz-date
    • user-agent
  • Parâmetros:
ValorDescrição
AmazonOrderId/
MerchantOrderID

Obrigatório

Tipo: String
ID do pedido (pode ser tanto o OrderID fornecido pela Amazon, quanto o ID do vendedor - desde que este último tenha sido informado no OrderAcknowledgement)
ActionType

Obrigatório

Tipo: String
Motivo do ajuste

Válidos:
Cancel
Refund
AmazonOrderItemCode/
MerchantOrderItemID

Obrigatório

Tipo: String
Identificação do item do pedido a ser ajustado (pode ser tanto o ID fornecido pela Amazon, quanto o ID do vendedor - desde que este
último tenha sido informado no OrderAcknowledgement)
AdjustmentReason

Obrigatório

Tipo: Array(String)
Razão do ajuste (cada
AmazonOrderItemCode terá 1
AdjustmentReason)

Válidos: NoInventory, CustomerReturn, GeneralAdjustment, CouldNotShip, DifferentItem, Abandoned, CustomerCancel, PriceError, ProductOutofStock, CustomerAddressIncorrect, Exchange, Other, CarrierCreditDecision, RiskAssessmentInformationNotValid, CarrierCoverageFailure, TransactionRecord, Undeliverable, RefusedDelivery
PromotionClaimCode

Opcional

Tipo: String
Cód. promoção dado pela Amazon
MerchantPromotionID

Opcional

Tipo: String
Cód. promoção dado pela Amazon
Type

Obrigatório

Tipo: Array(String)
Informar o tipo do componente do crédito/débito (cada AmazonOderItemCode pode ter vários Types)

Válidos: rincipal, Shipping, Tax, ShippingTax, RestockingFee, RestockingFeeTax, GiftWrap, GiftWrapTax, Surcharge, ReturnShipping, Goodwill, ExportCharge, COD*CODTax, Other, FreeReplacementReturnShipping
Amount

Obrigatório

Tipo: String. Ex: 'BRL'
Valor ajustado. Se for um crédito na conta do comprador, este número deve ser positivo. Se for
um débito na conta do comprador, o número deve ser negativo (cada type terá o seu amount
correspondente) - é necessário informar a moeda. e.g.
62.07
Quantity

Opcional

Tipo: Integer
Quantidade de itens ajustados
QuantityCancelled

Opcional

Tipo: Integer
Quantidade de itens cancelados

Exemplos de Requests

Ajustes gerais

<AmazonEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="amzn-envelope.xsd">
  <Header>
    <DocumentVersion>1.01</DocumentVersion>
    <MerchantIdentifier>A39BYP53PD01TR</MerchantIdentifier>
  </Header>
  <MessageType>OrderAdjustment</MessageType>
  <Message>
    <MessageID>1</MessageID>
    <OrderAdjustment>
      <AmazonOrderID>114-5689329-6212202</AmazonOrderID>
      <ActionType>Refund</ActionType>
      <AdjustedItem>
        <AmazonOrderItemCode>69976071172506</AmazonOrderItemCode>
        <AdjustmentReason>CustomerReturn</AdjustmentReason>
        <ItemPriceAdjustments>
          <Component>
            <Type>Principal</Type>
            <Amount currency="BRL">62.07</Amount>
          </Component>
        </ItemPriceAdjustments>
        <Quantity>1</Quantity>
      </AdjustedItem>
    </OrderAdjustment>
  </Message>
  <Message>
    <MessageID>2</MessageID>
    <OrderAdjustment>
      <AmazonOrderID>113-9105828-1684240</AmazonOrderID>
      <ActionType>Refund</ActionType>
      <AdjustedItem>
        <AmazonOrderItemCode>09931388139058</AmazonOrderItemCode>
        <AdjustmentReason>CustomerReturn</AdjustmentReason>
        <ItemPriceAdjustments>
          <Component>
            <Type>Principal</Type>
            <Amount currency="BRL">78.85</Amount>
          </Component>
          <Component>
            <Type>RestockingFee</Type>
            <Amount currency="BRL">-10.0</Amount>
          </Component>
        </ItemPriceAdjustments>
        <Quantity>1</Quantity>
      </AdjustedItem>
    </OrderAdjustment>
  </Message>
</AmazonEnvelope>

Cancelamento de algum item de um pedido.

<AmazonEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="amzn-envelope.xsd">
  <Header>
    <DocumentVersion>1.01</DocumentVersion>
    <MerchantIdentifier>A39BYP53PD01TR</MerchantIdentifier>
  </Header>
  <MessageType>OrderAdjustment</MessageType>
  <Message>
    <MessageID>1</MessageID>
    <OrderAdjustment>
      <AmazonOrderID>114-5689329-6212202</AmazonOrderID>
      <ActionType>Cancel</ActionType>
      <AdjustedItem>
        <AmazonOrderItemCode>69976071172506</AmazonOrderItemCode>
        <AdjustmentReason>NoInventory</AdjustmentReason>
        <ItemPriceAdjustments>
          <Component>
            <Type>Principal</Type>
            <Amount currency="BRL">62.07</Amount>
          </Component>
        </ItemPriceAdjustments>
        <QuantityCancelled>1</QuantityCancelled>
      </AdjustedItem>
    </OrderAdjustment>
  </Message>
</AmazonEnvelope>

Exemplos de Respostas

Erro ao enviar reembolso

Maior do que o valor do produto. Neste caso, não é possível enviar o reembolso solicitado.**

<AmazonEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="amzn-envelope.xsd">
  <Header>
    <DocumentVersion>1.02</DocumentVersion>
    <MerchantIdentifier>A28RU8W8BWZUEU</MerchantIdentifier>
  </Header>
  <MessageType>ProcessingReport</MessageType>
  <Message>
    <MessageID>1</MessageID>
    <ProcessingReport>
      <DocumentTransactionID>774282018675</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>18010</ResultMessageCode>
        <ResultDescription>The requested refund amount for the item price is not eligible. For
          help on how to proceed, see http://sellercentral.amazon.com/gp/help/25161
          (http://sellercentral.amazon.com/gp/help/25161%3C/ResultDescription)>
          <AdditionalInfo>
            <AmazonOrderID>114-7531551-0774613</AmazonOrderID>
          </AdditionalInfo>
          </Result>
        </ProcessingReport>
      </Message>
    </AmazonEnvelope>

Erro na construção do request

Desenvolvedor enviou um pedido sem os parâmetros obrigatórios para este Product Type.

<AmazonEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="amzn-envelope.xsd">
  <Header>
    <DocumentVersion>1.02</DocumentVersion>
    <MerchantIdentifier>A28RU8W8BWZUEU</MerchantIdentifier>
  </Header>
  <MessageType>ProcessingReport</MessageType>
  <Message>
    <MessageID>1</MessageID>
    <ProcessingReport>
      <DocumentTransactionID>774282018675</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>5000</ResultMessageCode>
        <ResultDescription>This is a malformed or invalid XML document. For more details,
          please see http://sellercentral.amazon.com/gp/help/22971>
          <AdditionalInfo>
            <AmazonOrderID>114-7531551-0774613</AmazonOrderID>
          </AdditionalInfo>
          </Result>
        </ProcessingReport>
      </Message>
    </AmazonEnvelope>