Seller Assistant API
HomeSeller AssistantHelp CenterAccount
HomeSeller AssistantHelp CenterAccount
Get API Keys
  1. FBA Inbound Shipments
  • Introduction
  • Authentication
  • Throttling
  • Error Handling
  • Swagger Documentation
  • Marketplace IDs and Categories
  • User Info
    • Get current user info
      GET
  • Products
    • Get product info
      GET
    • Get product statistics
      GET
    • Calculate product profit
      POST
  • UPC-EAN-ASIN converters
    • Get product ASINs based on identifiers (UPC or EAN)
      GET
    • Get product identifiers (UPC, EAN, etc.) based on ASIN
      GET
  • Restrictions
    • Check ASIN restrictions
      GET
  • Sales Estimation
    • Estimate sales by ASIN
      GET
    • Estimate sales by BSR and category
      POST
  • Keepa
    • Get Keepa product
      GET
    • Search Keepa products
      GET
  • FBA Inbound Shipments
    • Summary
    • List inbound plans
      GET
    • Get inbound plan
      GET
    • List plan shipments
      GET
    • Get shipment
      GET
    • List shipment items
      GET
    • Get shipment fees
      GET
  • SP-API FBA Shipments
    • Get old shipments
    • Get old shipment items
    • Get old shipment items by old shipment id
    • List inbound plans
    • Get inbound plan
    • List placement options
    • List transportation options
    • Get shipment
    • List shipment items
  1. FBA Inbound Shipments

Get shipment

GET
https://app.sellerassistant.app/api/v1/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}
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.

Request

Authorization
API Key
Add parameter in query
api_key
Example:
api_key: ********************
or
API Key
Add parameter in header
X-Api-Key
Example:
X-Api-Key: ********************
or
Path Params
inboundPlanId
required
Inbound Plan id (Workflow Id).
Example:
wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2
shipmentId
required
Shipment ID, either the old format (FBA...) or the new format (sh...). Requests using the old format may take longer to process.
Example:
sh7059be6b-54b3-4320-8553-f913d3472cc3
Query Params
domain
optional
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.
Example:
amazon.com
marketplaceId
optional
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.
Example:
ATVPDKIKX0DER

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://app.sellerassistant.app/api/v1/fba/inboundPlans/wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2/shipments/sh7059be6b-54b3-4320-8553-f913d3472cc3?api_key'

Responses

🟢200OK
application/json
Successful response
Body
amazonReferenceId
string  | null 
optional
A unique identifier created by Amazon that identifies this Amazon-partnered shipment.
>= 1 characters<= 1024 characters
contactInformation
object  | null 
optional
email
string  | null 
optional
>= 1 characters<= 1024 characters
name
string 
optional
The contact's name.
>= 1 characters<= 50 characters
phoneNumber
string 
optional
The phone number.
>= 1 characters<= 20 characters
dates
object  | null 
optional
readyToShipWindow
object  | null 
optional
destination
object 
optional
address
object (Address) 
optional
destinationType
enum<string> 
optional
The type of destination for this shipment.
>= 1 characters<= 1024 characters
Allowed values:
AMAZON_OPTIMIZEDAMAZON_WAREHOUSE
warehouseId
string  | null 
optional
>= 1 characters<= 1024 characters
freightInformation
object  | null 
optional
declaredValue
optional
freightClass
enum<string>  | enum<null> 
optional
>= 1 characters<= 1024 characters
Allowed values:
NONEFC_50FC_55FC_60FC_65FC_70FC_77_5FC_85FC_92_5FC_100FC_110FC_125FC_150FC_175FC_200FC_250FC_300FC_400FC_500
name
string  | null 
optional
placementOptionId
string 
optional
The identifier of a placement option.
>= 38 characters<= 38 characters
selectedDeliveryWindow
object  | null 
optional
availabilityType
enum<string> 
required
Identifies type of Delivery Window Availability.
Allowed values:
AVAILABLECONGESTED
deliveryWindowOptionId
string 
required
Identifier of a delivery window option.
>= 36 characters<= 38 characters
editableUntil
string <date-time> | null 
optional
endDate
string <date-time>
required
startDate
string <date-time>
required
selectedTransportationOptionId
string  | null 
optional
>= 38 characters<= 38 characters
selfShipAppointmentDetails
array [object {3}]  | null 
optional
appointmentId
number 
optional
Identifier for appointment.
appointmentSlotTime
object 
optional
appointmentStatus
string 
optional
>= 1 characters<= 1024 characters
shipmentConfirmationId
string  | null 
optional
>= 1 characters<= 1024 characters
shipmentId
string 
optional
Identifier of a shipment.
>= 38 characters<= 38 characters
source
object 
optional
address
object (Address) 
optional
sourceType
enum<string> 
optional
The type of source for this shipment.
>= 1 characters<= 1024 characters
Allowed value:
SELLER_FACILITY
status
enum<string>  | enum<null> 
optional
>= 1 characters<= 1024 characters
Allowed values:
ABANDONEDCANCELLEDCHECKED_INCLOSEDDELETEDDELIVEREDIN_TRANSITMIXEDREADY_TO_SHIPRECEIVINGSHIPPEDUNCONFIRMEDWORKING
trackingDetails
object  | null 
optional
ltlTrackingDetail
object  | null 
optional
spdTrackingDetail
object  | null 
optional
Example
{
    "amazonReferenceId": "string",
    "contactInformation": {
        "email": "string",
        "name": "string",
        "phoneNumber": "string"
    },
    "dates": {
        "readyToShipWindow": {
            "editableUntil": "2019-08-24T14:15:22Z",
            "end": "2019-08-24T14:15:22Z",
            "start": "2019-08-24T14:15:22Z"
        }
    },
    "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"
        },
        "destinationType": "AMAZON_OPTIMIZED",
        "warehouseId": "string"
    },
    "freightInformation": {
        "declaredValue": {
            "amount": 10.5,
            "code": "USD"
        },
        "freightClass": "NONE",
        "name": "string"
    },
    "placementOptionId": "stringstringstringstringstringstringst",
    "selectedDeliveryWindow": {
        "availabilityType": "AVAILABLE",
        "deliveryWindowOptionId": "stringstringstringstringstringstring",
        "editableUntil": "2019-08-24T14:15:22Z",
        "endDate": "2019-08-24T14:15:22Z",
        "startDate": "2019-08-24T14:15:22Z"
    },
    "selectedTransportationOptionId": "stringstringstringstringstringstringst",
    "selfShipAppointmentDetails": [
        {
            "appointmentId": 0,
            "appointmentSlotTime": {
                "endTime": "2019-08-24T14:15:22Z",
                "startTime": "2019-08-24T14:15:22Z"
            },
            "appointmentStatus": "string"
        }
    ],
    "shipmentConfirmationId": "string",
    "shipmentId": "stringstringstringstringstringstringst",
    "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"
        },
        "sourceType": "SELLER_FACILITY"
    },
    "status": "ABANDONED",
    "trackingDetails": {
        "ltlTrackingDetail": {
            "billOfLadingNumber": "string",
            "freightBillNumber": [
                "string"
            ]
        },
        "spdTrackingDetail": {
            "spdTrackingItems": [
                {
                    "boxId": "string",
                    "trackingId": "string",
                    "trackingNumberValidationStatus": "VALIDATED"
                }
            ]
        }
    }
}
🟠402402
🟠403Forbidden
🟠422Parameter Error
🟠429429
🔴500Server Error
Modified at 2025-07-24 13:23:09
Previous
List plan shipments
Next
List shipment items
Built with