SP-API FBA Shipments

Get inbound plan

Proxy to https://developer-docs.amazon.com/sp-api/reference/getinboundplan. 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/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}

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/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}
  • Auth: one of:
    • API key in query parameter api_key
    • API key in header X-Api-Key

Path parameters

Inbound Plan id (Workflow Id).

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

createdAtstring date-time required

The time at which the inbound plan was created. In ISO 8601 datetime with pattern yyyy-MM-ddTHH:mm:ssZ.

inboundPlanIdstring required

Identifier of an inbound plan.

lastUpdatedAtstring date-time required

The time at which the inbound plan was last updated. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.

marketplaceIdsstring[] required

A list of marketplace IDs.

namestring required

Human-readable name of the inbound plan.

status'ACTIVE' | 'VOIDED' | 'SHIPPED' | 'ERRORED' required

Current status of the inbound plan.

Example response

{
  "createdAt": "2025-05-26T09:36:00Z",
  "inboundPlanId": "ABCDEFGH1234567890ABCDEFGH1234567890",
  "lastUpdatedAt": "2025-05-26T10:36:00Z",
  "marketplaceIds": [
    "ATVPDKIKX0DER"
  ],
  "name": "Summer 2025 Inventory Shipment",
  "packingOptions": [
    {
      "packingOptionId": "pof3a5b9e4-6aa4-45f8-bf96-6603da02e3a0",
      "status": "OFFERED"
    }
  ],
  "placementOptions": [
    {
      "placementOptionId": "PLACE1234567890ABCDEFGH1234567890ABCD",
      "status": "OFFERED"
    }
  ],
  "shipments": [
    {
      "shipmentId": "SHIP1234567890ABCDEFGH1234567890ABCDEF",
      "status": "UNCONFIRMED"
    }
  ],
  "sourceAddress": {
    "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"
  },
  "status": "ACTIVE"
}

Changes

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