Retrieve shipment information

Learn how to use the Shipment Invoicing API to retrieve shipment invoice information for Fulfillment by Amazon (FBA) orders in the Brazil marketplace.

Prerequisites

To complete this tutorial, you need:

• Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
• The Tax Invoicing (Restricted) Role role assigned to your developer profile.
• The Tax Invoicing (Restricted) Role role selected in the app registration page for your application.

Step 1. Subscribe to the FBA_OUTBOUND_SHIPMENT_STATUS notification

The FBA_OUTBOUND_SHIPMENT_STATUS notification is sent whenever Amazon creates or cancels a Fulfillment by Amazon shipment for a seller. This notification is only for FBA onsite shipments. This notification is available only in the Brazil marketplace.

To subscribe to FBA_OUTBOUND_SHIPMENT_STATUS, refer to Set up notifications using the Amazon Simple Queue Service workflow.

When you receive the notification, save the AmazonShipmentId value.

Notification Example

{
  "NotificationVersion": "1.0",
  "NotificationType": "FBA_OUTBOUND_SHIPMENT_STATUS",
  "PayloadVersion": "1.0",
  "EventTime": "2020-01-11T00:09:53.109Z",
  "Payload":
  {
    "FBAOutboundShipmentStatusNotification":
    {
      "SellerId": "merchantId",
      "AmazonOrderId": "113-2646096-4474645",
      "AmazonShipmentId": "DrLqQwqvb",
      "ShipmentStatus": "Created"
    }
  },
  "NotificationMetadata":
  {
    "ApplicationId": "appId",
    "SubscriptionId": "subId",
    "PublishTime": "2020-01-11T00:02:50.501Z",
    "NotificationId": "requestId"
  }
}

Step 2. Retrieve shipment details

📘

Note

This is a restricted operation and requires a Restricted Data Token (RDT) for authorization. Some operations require restrictions because they contain customer PII data. These operations require passing an additional security review. For more information on RDT, refer to the Tokens API guide.

Retrieve shipment details by calling getShipmentDetails. Specify the AmazonShipmentID from step 1 in the shipmentId path parameter.