Amazon Marketplace

Informações

Schemes: https

Base URL: https://sellingpartnerapi-na.amazon.com

Documentation Reference

Authentication: Header x-amz-access-token

Pedidos

Consulta pedidos

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
marketplaceId	ID do marketplace	Sim
createdBefore	Data de criação antes	Opcional
createdAfter	Data de criação depois	Opcional
lastUpdatedBefore	Última atualização antes	Opcional
lastUpdatedAfter	Última atualização depois	Opcional
EasyShipShipmentStatuses	Usado para selecionar pedidos DBA com status que correspondam aos valores especificados.	Opcional
AmazonOrderIds	Uma lista de valores AmazonOrderId.	Opcional

Opções EasyShipShipmentStatuses:

• PendingSchedule: O pacote está aguardando o agendamento da coleta.
• PendingPickUp: A Amazon ainda não coletou o pacote do seller.
• LabelCanceled: O seller cancelou o agendamento.
• PickedUp: A Amazon já coletou o pacote do seller.
• Delivered: O pacote foi entregue ao comprador.
• RejectedByBuyer: O pacote foi rejeitado pelo comprador.
• Undeliverable: O pacote não pode ser entregue.
• ReturningToSeller: O pacote não foi entregue ao comprador e está sendo devolvido ao seller.
• ReturnedToSeller: O pacote não foi entregue ao comprador e foi devolvido ao seller.
• Lost: O pacote está perdido.
• OutForDelivery: O pacote está fora para entrega.
• Damaged: O pacote foi danificado pela transportadora

Exemplo de código

const response = await devapi.CONNECTOR.AMAZON.ORDERS.findOrders({});

Consulta dados de pedido

Retorna as informações do pedido que você especificar.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
orderId	ID do pedido	Sim

Exemplo de código

const response = await devapi.CONNECTOR.AMAZON.ORDERS.findOrder({

orderId: "_YOUR_ORDER_ID_",

});

Consulta dados comprador do pedido

Retorna as informações do comprador para o pedido que você especificar.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
orderId	ID do pedido	Sim

Exemplo de código

const response = await devapi.CONNECTOR.AMAZON.ORDERS.findOrdersBuyerInfo({

orderId: "_YOUR_ORDER_ID_",

});

Consulta endereço de entrega do pedido

Retorna o endereço de entrega do pedido que você especificar.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
orderId	ID do pedido	Sim

Exemplo de código

const response = await devapi.CONNECTOR.AMAZON.ORDERS.findOrdersAddress({

orderId: "_YOUR_ORDER_ID_",

});

Consulta items do pedido

Retorna informações detalhadas do item do pedido para o pedido que você especificar. Se NextToken for fornecido, ele será usado para recuperar a próxima página de itens do pedido.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
orderId	ID do pedido	Sim
AmazonOrderIds	Uma lista de valores AmazonOrderId.	Opcional
nextToken	ID do pedido	Sim

Exemplo de código

const response = await devapi.CONNECTOR.AMAZON.ORDERS.findOrdersOrderItems({

orderId: "_YOUR_ORDER_ID_",

nextToken: "_NEXT_TOKEN_",

});

Criar shipping do pedido

Criar nova remessa do pedido.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
marketplaceId	ID do marketplace	Sim
orderId	ID do pedido	Sim
shipmentStatus	Status da remessa	Sim

Exemplo de código

const response = await devapi.CONNECTOR.AMAZON.ORDERS.createOrderShipment({

orderId: "_YOUR_ORDER_ID_",

marketplaceId: "_MARKETPLACE_ID_",

shipmentStatus: "_SHIPMENT_STATUS_",

});

Confirmar Pedido

Atualiza o status de confirmação de remessa para um pedido especificado.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
orderId	ID do pedido	Sim
confirmShipment	Corpo da solicitação de confirmShipment.	Sim

Exemplo de código

const confirmShipmentData = {

packageDetail: {

packageReferenceId: "string",

carrierCode: "string",

carrierName: "string",

shippingMethod: "string",

trackingNumber: "string",

shipDate: "2023-08-01T14:52:16.965Z",

shipFromSupplySourceId: "string",

orderItems: [

{

orderItemId: "string",

quantity: 0,

transparencyCodes: ["string"],

},

],

},

codCollectionMethod: "DirectPayment",

marketplaceId: "string",

};

const response =

await devapi.CONNECTOR.AMAZON.ORDERS.createOrderShipmentConfirmation({

orderId: "_YOUR_ORDER_ID_",

confirmShipment: confirmShipmentData,

});

Shipment Invoicing (FBA)

Recupere informações de fatura de remessa no marketplace do Brasil para pedidos de Fulfillment by Amazon (FBA) de um parceiro de vendas.

Consultar Shipment Invoicing

Retorna os detalhes da remessa necessários para emitir uma fatura para a remessa especificada.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
shipmentId	O identificador da remessa	Sim

Exemplo de código

const response = await devapi.CONNECTOR.AMAZON.FBA.findFbaShipments({

shipmentId: "_YOUR_SHIPMENT_ID_",

});

Consulta Status da Fatura

Retorna o status da fatura para a remessa especificada.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
shipmentId	O identificador da remessa	Sim

Exemplo de código

const response =

await devapi.CONNECTOR.AMAZON.FBA.createFbaShipmentsInvoiceStatus({

shipmentId: "_YOUR_SHIPMENT_ID_",

});

Enviar documento de fatura

Envia um documento de fatura de remessa para uma determinada remessa.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
shipmentId	ID da remessa	Sim
marketplaceId	ID do marketplace	Opcional
InvoiceContent	Conteúdo do documento da fatura de remessa	Sim

O campo InvoiceContent deverá ser enviado tipo Blob.

Exemplo de código

const response =

await devapi.CONNECTOR.AMAZON.FBA.findFbaShipmentsInvoiceStatus({

shipmentId: "_YOUR_SHIPMENT_ID_",

marketplaceId: "_YOUR_MARKETPLACE_ID_",

InvoiceContent: "_YOUR_INVOICE_CONTENT_",

});

Shipment Invoicing (DBA)

Após importar os pedidos para a sua plataforma é necessário validar se o pedido precisa que a nota fiscal seja enviada para a Amazon e, se sim, que você envie e consulte o status de processamento.

Consultar Status de Processamento Envio da Nota Fiscal

Após envio da nota fiscal, é necessário saber se ela foi processada corretamente.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
marketplaceId	ID do marketplace	Sim
orderId	ID do pedido	Sim

Exemplo de código

const response = await devapi.CONNECTOR.AMAZON.DBA.findDbaDeliveryInvoiceStatus(

{

marketplaceId: "_YOUR_MARKETPLACE_ID_",

orderId: "_YOUR_ORDER_ID_",

}

);

Exemplo do retorno

{

"payload": {

"amazonOrderId": "string",

"invoiceStatus": " Accepted"

}

}

O status do campo invoiceStatus retorna as seguinte opções:

• Processing: Validação da Nota Fiscal está em processamento.

• Accepted: O processo de validação da nota fiscal foi bem-sucedido e a nota fiscal foi aceita pela Amazon. Para casos de pedidos que não precisam de nota fiscal (orders que estiverem como ElectronicInvoiceStatus = “NotRequired” na API de Orders) sempre será retornado como NotFound aqui nesse campo.

• Errored: Houve um erro com a validação da nota (provavelmente algo com InvalidDigestValue ou InvalidSignature). Tentar novamente.

• NotFound: Não foi encontrado uma submissão com sucesso para os dados solicitados.

Enviar Shipment Invoicing

Enviar o XML da nota fiscal em base 64 para a Amazon.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
marketplaceId	ID do marketplace	Sim
orderId	ID do pedido	Sim
invoiceContent	Base64 encode do XML da nota	Sim

Exemplo de código

const deliveryInvoiceData = {

marketplaceId: "_YOUR_MARKETPLACE_ID_",

orderId: "_YOUR_ORDER_ID_",

invoiceContent: "_YOUR_XML_BASE64_",

};

const response = await devapi.CONNECTOR.AMAZON.DBA.createDbaDeliveryInvoice(

deliveryInvoiceData

);

Agendar de Coleta de Pedidos

Essa operação agenda automaticamente um horário de coleta para todos os amazonOrderIds informados como parâmetros, gerando as etiquetas de envio associadas, juntamente com outros documentos de conformidade de acordo com o marketplace (consulte a tabela de suporte de documentos do marketplace).

Em relação ao formato do arquivo da etiqueta de envio, os desenvolvedores externos podem escolher entre PDF ou ZPL, e a Amazon criará a etiqueta de acordo.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
marketplaceId	ID do marketplace	Sim
orderScheduleDetailsList	Um identificador de pedido definido pela Amazon	Sim
labelFormat	O formato de arquivo no qual a etiqueta de envio será criada. Opções possíveis “PDF” ou “ZPL”.	Sim

Exemplo de código

const packagesData = {

marketplaceId: "_YOUR_MARKETPLACE_ID_",

orderScheduleDetailsList: [

{

amazonOrderId: "_YOUR_AMAZON_ORDER_ID_"

}

],

labelFormat: "PDF OR ZPL",

};

const response = await devapi.CONNECTOR.AMAZON.DBA.createDbaEasyShipPackagesBulk(

packagesData

);

## Fulfillment Inbound

Como criar e atualizar remessas de estoque de entrada para a rede de atendimento da Amazon.

### Consultar itens orientação

Retorna informações que permitem ao vendedor saber se a Amazon recomenda o envio

de um item para um determinado mercado. Em alguns casos, a Amazon fornece orientação

sobre por que um determinado SellerSKU ou ASIN não é recomendado para envio à rede

de atendimento da Amazon. Os vendedores ainda podem enviar itens não recomendados, a seu critério.

**Dados de entrada**

| CAMPO | DESCRIÇÃO | OBRIGATÓRIO |

| ------------- | ------------------------------ | ----------- |

| marketplaceId | ID do marketplace | Sim |

| sellerSKUList | Uma lista de valores SellerSKU | Opcional |

| asinList | Uma lista de valores ASIN | Opcional |

**Exemplo de código**

```javascript

const response =

await devapi.CONNECTOR.AMAZON.FBA_INBOUND.findFbaInboundItemsGuidance({

marketplaceId: "_YOUR_MARKETPLACE_ID_",

SellerSKUList: ["_YOUR_SELLER_ID_"],

asinList: ["_ASIN_"],

});

Fulfillment outbound

Recupere informações sobre pedidos de atendimento multicanal (MCF) na rede de atendimento da Amazon.

Consultar Pedidos Atendimentos

Retorna uma lista de pedidos de atendimento atendidos após (ou em) uma data/hora especificada ou indicada pelo próximo parâmetro de token.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
queryStartDate	Data e hora	Opcional
pageToken	Um token de string retornado na resposta à sua solicitação anterior.	Opcional

Exemplo de código

const response =

await devapi.CONNECTOR.AMAZON.FBA_OUTBOUND.findFbaOutboundFulfillmentOrders();

Consulta Rastreamento de Entrega

Retorna informações de rastreamento de entrega para um pacote em uma remessa de saída para um pedido de atendimento multicanal.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
packageNumber	O identificador de pacote não criptografado retornado pela operação getFulfillmentOrder.	Sim

Exemplo de código

const response =

await devapi.CONNECTOR.AMAZON.FBA_OUTBOUND.findFbaOutboundTracking({

packageNumber: "_YOUR_PACKAGE_NUMBER_",

});

Criar Pedido Fulfillment

Solicita que a Amazon envie itens do estoque do vendedor na rede de atendimento da Amazon para um endereço de destino.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
fulfillmentOrderData	Dados do corpo da solicitação para a operação createFulfillmentOrder.	Sim

Exemplo de código

const fulfillmentOrderData = {

marketplaceId: "string",

sellerFulfillmentOrderId: "string",

displayableOrderId: "string",

displayableOrderDate: "2023-08-01T14:02:17.907Z",

displayableOrderComment: "string",

shippingSpeedCategory: "Standard",

deliveryWindow: {

startDate: "2023-08-01T14:02:17.907Z",

endDate: "2023-08-01T14:02:17.907Z",

},

destinationAddress: {

name: "string",

addressLine1: "string",

addressLine2: "string",

addressLine3: "string",

city: "string",

districtOrCounty: "string",

stateOrRegion: "string",

postalCode: "string",

countryCode: "string",

phone: "string",

},

fulfillmentAction: "Ship",

fulfillmentPolicy: "FillOrKill",

codSettings: {

isCodRequired: true,

codCharge: {

currencyCode: "string",

value: "string",

},

codChargeTax: {

currencyCode: "string",

value: "string",

},

shippingCharge: {

currencyCode: "string",

value: "string",

},

shippingChargeTax: {

currencyCode: "string",

value: "string",

},

},

shipFromCountryCode: "string",

notificationEmails: ["string"],

featureConstraints: [

{

featureName: "string",

featureFulfillmentPolicy: "Required",

},

],

items: [

{

sellerSku: "string",

sellerFulfillmentOrderItemId: "string",

quantity: 0,

giftMessage: "string",

displayableComment: "string",

fulfillmentNetworkSku: "string",

perUnitDeclaredValue: {

currencyCode: "string",

value: "string",

},

perUnitPrice: {

currencyCode: "string",

value: "string",

},

perUnitTax: {

currencyCode: "string",

value: "string",

},

},

],

};

const response =

await devapi.CONNECTOR.AMAZON.FBA_OUTBOUND.createFbaOutboundFulfillmentOrder(

fulfillmentOrderData

);

Vendor Direct Fulfillment

Acesso programático aos dados de um fornecedor de atendimento direto.

Consulta Pedidos

Retorna uma lista de ordens de compra criadas durante o período especificado. Você define o período de tempo usando os parâmetros createdAfter e createdBefore. Você deve usar ambos os parâmetros. Você pode optar por obter apenas os números da ordem de compra definindo o parâmetro includeDetails como false. Nesse caso, a operação retorna uma lista de números de ordem de compra. Você pode chamar a operação getOrder para retornar os detalhes de um pedido específico.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
createdAfter	Data e hora de criação	Sim
createdBefore	Data e hora de criação	Sim
status	Data e hora de criação	Sim
sortOrder	Opção de ordenação	Opcional
pageSize	Número de resultados a serem retornados por página. Máximo : 20	Opcional
pageToken	Token é retornado na chamada de API anterior.	Opcional

Exemplo de código

const response =

await devapi.CONNECTOR.AMAZON.VENDOR.findVendorDirectFulfillmentPurchaseOrders(

{

createdAfter: "_YOUR_CREATED_AFTER_",

createdBefore: "_YOUR_CREATED_BEFORE_",

}

);

Consulta Dados do Pedido

Retorna as informações do pedido de compra para o purchaseOrderNumber especificado.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
purchaseOrderNumber	Número do pedido de compra	Sim

Exemplo de código

const response =

await devapi.CONNECTOR.AMAZON.VENDOR.findVendorDirectFulfillmentPurchaseOrder(

{

purchaseOrderNumber: "_YOUR_PURCHASE_ORDER_NUMBER_",

}

);

Confirmar Pedidos de Compra

Envia confirmações para um ou mais pedidos de compra.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
purchaseOrderNumber	Número do pedido de compra	Sim

Exemplo de código

const orderAcknowledgementsData = [

{

purchaseOrderNumber: "string",

vendorOrderNumber: "string",

acknowledgementDate: "2023-08-01T14:48:44.985Z",

acknowledgementStatus: {

code: "string",

description: "string",

},

sellingParty: {

partyId: "string",

address: {

name: "string",

attention: "string",

addressLine1: "string",

addressLine2: "string",

addressLine3: "string",

city: "string",

county: "string",

district: "string",

stateOrRegion: "string",

postalCode: "string",

countryCode: "string",

phone: "string",

},

taxInfo: {

taxRegistrationType: "VAT",

taxRegistrationNumber: "string",

taxRegistrationAddress: {

name: "string",

attention: "string",

addressLine1: "string",

addressLine2: "string",

addressLine3: "string",

city: "string",

county: "string",

district: "string",

stateOrRegion: "string",

postalCode: "string",

countryCode: "string",

phone: "string",

},

taxRegistrationMessages: "string",

},

},

shipFromParty: {

partyId: "string",

address: {

name: "string",

attention: "string",

addressLine1: "string",

addressLine2: "string",

addressLine3: "string",

city: "string",

county: "string",

district: "string",

stateOrRegion: "string",

postalCode: "string",

countryCode: "string",

phone: "string",

},

taxInfo: {

taxRegistrationType: "VAT",

taxRegistrationNumber: "string",

taxRegistrationAddress: {

name: "string",

attention: "string",

addressLine1: "string",

addressLine2: "string",

addressLine3: "string",

city: "string",

county: "string",

district: "string",

stateOrRegion: "string",

postalCode: "string",

countryCode: "string",

phone: "string",

},

taxRegistrationMessages: "string",

},

},

itemAcknowledgements: [

{

itemSequenceNumber: "string",

buyerProductIdentifier: "string",

vendorProductIdentifier: "string",

acknowledgedQuantity: {

amount: 0,

unitOfMeasure: "Each",

},

},

],

},

];

const response =

await devapi.CONNECTOR.AMAZON.VENDOR.createVendorDirectFulfillmentAcknowledgements(

{

orderAcknowledgements: orderAcknowledgementsData,

}

);

Estoque

Atualizar Estoque

Atualiza as quantidades de estoque (níveis de estoque) para itens.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
marketplaceIds	ID(s) do marketplace	Sim
inventories	Lista de produtos para atualizar estoque	Sim

Exemplo de código

const marketplaceIds = ["_YOUR_MARKETPLACE_ID_"],

const feedInventoriesData = [

{

sellerSku: "_YOUR_SELLER_SKU_",

available: 100,

},

{

sellerSku: "_YOUR_SELLER_SKU_",

available: 1,

}

]

const response = await devapi.CONNECTOR.AMAZON.FEEDS.createFeedsInventories({

marketplaceIds,

inventories: feedInventoriesData,

});

Preço

Atualizar Preço

Atribui o preço atual e o preço de venda (quando aplicável) de um item.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
marketplaceIds	ID(s) do marketplace	Sim
pricing	Lista de produtos com seus preços para atualizar.	Sim

Exemplo de código

const marketplaceIds = ["_YOUR_MARKETPLACE_ID_"],

const feedPrincigData = [

{

"sellerSku": "_YOUR_SELLER_SKU_",

"price": {

"standardPrice": {

"currencyCode": "BRL",

"amount": 0.0

}

}

},

{

"sellerSku": "_YOUR_SELLER_SKU_",

"price": {

"standardPrice": {

"currencyCode": "BRL",

"amount": 0.0

}

}

}

]

const response = await devapi.CONNECTOR.AMAZON.FEEDS.createFeedsPricing({

marketplaceIds,

inventories: feedPrincigData,

});

Produtos

Consulta Itens do catálogo da Amazon

Pesquise e retorne uma lista de itens do catálogo da Amazon e informações associadas por identificador ou por palavras-chave.

Dados de entrada

CAMPO	DESCRIÇÃO	Obrigatório
marketplaceId	ID do marketplace	Sim
version	Versão da API. Usar o valor "2022-04-01"	Sim
keywords	Uma lista de palavras delimitadas por vírgulas para pesquisar no catálogo da Amazon. Nota: Não pode ser usado com . Contagem máxima : 20identifiers	Sim
sellerId	ID do vendedor	Opcional
pageSize	Número de resultados a serem retornados por página. Máximo : 20
pageToken	Um token para buscar uma determinada página quando há várias páginas de resultados.	Sim	Sim

Exemplo de código

const response = await devapi.CONNECTOR.AMAZON.CATALOG.findCatalogItems({

version: "2022-04-01",

sellerId: "_YOUR_SELLER_ID_",

marketplaceId: "_YOUR_MARKETPLACE_ID_",

keywords: ".",

pageSize: 100,

pageToken: "_NEXT_TOKEN_",

});

Criar produto(s)

Anúnciar produto na Amazon.

Dados de entrada

CAMPO	DESCRIÇÃO	OBRIGATÓRIO
marketplaceId	ID(s) do marketplace em que você deseja adicionar os produtos	Sim
feedType	Tipo de feed para adicionar produtos	Sim
products	Lista de produtos que será anúnciado na Amazon	Sim

Exemplo de código

const marketplaceId = "_YOUR_MARKETPLACE_ID_";

const feedProductsData = [

{

sku: "YOUR_PRODUCT_SKU",

title: "Product Title",

description: "Product Description",

brand: "Product Brand",

price: 19.99,

quantity: 10,

images: [

"https://example.com/image1.jpg",

"https://example.com/image2.jpg",

],

classification: {

classificationType: "ASIN",

classificationValue: "B123456789",

},

variations: [

{

sku: "YOUR_VARIATION_SKU",

title: "Variation Title",

price: 24.99,

quantity: 5,

images: [

"https://example.com/variation-image1.jpg",

"https://example.com/variation-image2.jpg",

],

color: "Red",

size: "Large",

material: "Cotton",

},

],

},

];

const response = await devapi.CONNECTOR.AMAZON.FEEDS.createFeedsProducts({

marketplaceId,

feedType: "POST_PRODUCT_DATA",

products: feedProductsData,

});