FBA Inbound Shipments

Get shipment

Get shipment summary. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it here.

get/api/v1/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}

Request

  • Base URL: https://app.sellerassistant.app (the document declares no server; this is the origin it was published from)
  • URL: https://app.sellerassistant.app/api/v1/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}
  • Auth: one of:
    • API key in query parameter api_key
    • API key in header X-Api-Key

Path parameters

Inbound Plan id (Workflow Id).

Shipment ID, either the old format (FBA...) or the new format (sh...). Requests using the old format may take longer to process.

Query parameters

Amazon marketplace domain. Domain amazon.com is used by default if domain and marketplaceId are not provided. If both domain and marketplaceId are chosen, domain has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.

Amazon marketplace id. Domain amazon.com is used by default if domain and marketplaceId are not provided. If both domain and marketplaceId are chosen, domain has bigger priority. See all options here.

Response

Successful response

amazonReferenceIdstring nullable

A unique identifier created by Amazon that identifies this Amazon-partnered shipment.

placementOptionIdstring

The identifier of a placement option.

selectedTransportationOptionIdstring nullable
shipmentConfirmationIdstring nullable
shipmentIdstring

Identifier of a shipment.

status'ABANDONED' | 'CANCELLED' | 'CHECKED_IN' | 'CLOSED' | 'DELETED' | 'DELIVERED' | 'IN_TRANSIT' | 'MIXED' | 'READY_TO_SHIP' | 'RECEIVING' | 'SHIPPED' | 'UNCONFIRMED' | 'WORKING' nullable

Example response

{
  "destination": {
    "address": {
      "addressLine1": "123 Main St",
      "addressLine2": "Suite 100",
      "city": "Seattle",
      "companyName": "Acme Inc",
      "countryCode": "US",
      "email": "contact@example.com",
      "name": "John Doe",
      "phoneNumber": "+12065551234",
      "postalCode": "98109",
      "stateOrProvinceCode": "WA"
    }
  },
  "freightInformation": {
    "declaredValue": {
      "amount": 10.5,
      "code": "USD"
    }
  },
  "source": {
    "address": {
      "addressLine1": "123 Main St",
      "addressLine2": "Suite 100",
      "city": "Seattle",
      "companyName": "Acme Inc",
      "countryCode": "US",
      "email": "contact@example.com",
      "name": "John Doe",
      "phoneNumber": "+12065551234",
      "postalCode": "98109",
      "stateOrProvinceCode": "WA"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.