Tutorial: Retrieve shipment information

This tutorial describes how to retrieve information for an FBA Onsite shipment in the Brazil marketplace.

Prerequisites

To successfully complete this tutorial, you must have:

• Authorization from the selling partner for whom you are making calls. See the Authorizing Selling Partner API applications for more information.
• Approval for the Tax Invoicing (Restricted) Role role in your developer profile and 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, follow 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

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

getShipmentDetails is a restricted operation. You must use an RDT token for the x-amz-access-token header. For more information on creating a restricted data token, refer to createRestrictedDataToken.