Seller Assistant API
Home
Seller AssistantHelp CenterAccount
Home
Seller AssistantHelp CenterAccount
Get API Keys
  1. SP-API FBA Shipments
  • Introduction
  • Authentication
  • Throttling
  • Error Handling
  • Swagger Documentation
  • Amazon SP-API Marketplace IDs
  • Amazon Marketplace Categories
  • 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
    • Estimate sales by BSR and category
  • Keepa
    • Get Keepa product
    • Search Keepa products
    • Keepa Product Finder
  • FBA Inbound Shipments
    • Summary
    • List inbound plans
    • Get inbound plan
    • List inbound plan boxes
    • List plan shipments
    • Get shipment
    • List shipment items
    • Get shipment fees
    • List shipment boxes
  • Listings Items
    • Search listings items
    • Get listings item
    • Create or update listing from ASIN
    • Delete listings item
  • SP-API FBA Shipments
    • Get old shipments
      GET
    • Get old shipment items
      GET
    • Get old shipment items by old shipment id
      GET
    • List inbound plans
      GET
    • Get inbound plan
      GET
    • List inbound plan boxes
      GET
    • List placement options
      GET
    • List transportation options
      GET
    • Get shipment
      GET
    • List shipment items
      GET
    • List shipment boxes
      GET
    • List packing options
      GET
    • List packing group boxes
      GET
    • List packing group items
      GET
  • SP-API FBA Inventory
    • Get inventory summaries
  • SP-API Catalog Items
    • Search catalog items
    • Get catalog item
  • SP-API Listings Items
    • Search listings items
    • Get listings item
    • Put listings item
    • Delete listings item
    • Patch listings item
  • SP-API Product Type Definitions
    • Search definitions product types
    • Get a product type definition
  • SP-API Product Pricing
    • Get competitive pricing
    • Get competitive summary for ASINs
  • Price List Analyzer
    • Start a price list analysis, from a file or from already-mapped JSON items
    • Get price list processing status
    • Get price list results (paginated)
    • Update calculations for a single price list item
    • Update expenses configuration for a price list
  • Documents (Beta)
    • List documents
    • Upload a document
    • Delete documents
    • Get a document
    • Delete a document
    • Update a document
    • Get a download link
    • Preview an invoice import
    • Import an invoice
  • Account (Beta)
    • Get account
    • Get current user
  • Notes (Beta)
    • List notes
    • Create a note
    • Delete notes
    • Delete a note
    • Update a note
  • Product History (Beta)
    • List product history
  • Inventory Products (Beta)
    • List filter values
    • List products
    • Create products
    • Archive products
    • Get a product
    • Archive a product
    • Update a product
    • Set product matches
    • Remove product matches
  • Listings (Beta)
    • List listings
    • Create listing drafts
    • Delete listings
    • Get a listing
    • Delete a listing draft
  • Purchase Orders (Beta)
    • List purchase orders
    • Create purchase orders
    • Delete purchase orders
    • Get a purchase order
    • Delete a purchase order
    • Update a purchase order
    • List order items
    • Delete order items
    • Add order items
    • Delete an order item
    • Update an order item
  • SKUs (Beta)
    • List SKUs
    • Delete SKUs
    • Get a SKU
    • Delete a SKU
    • Update a SKU
  • Supplier Offers (Beta)
    • List supplier offers
    • Create supplier offers
    • Get a supplier offer
    • Delete a supplier offer
    • Update a supplier offer
  • Suppliers (Beta)
    • List suppliers
    • Create suppliers
    • Delete suppliers
    • Get a supplier
    • Delete a supplier
    • Update a supplier
  • Warehouses (Beta)
    • List warehouses
    • Create warehouses
    • Delete warehouses
    • Get a warehouse
    • Delete a warehouse
    • Update a warehouse
    • List prep providers
  • Repricer (Beta)
    • List repricing history
    • Get history statistics
    • Get repricer overview
    • Get repricer settings
    • Reset repricer settings
    • Update repricer settings
    • List repricer products
    • Create repricer products
    • Delete repricer products
    • Update repricer products
    • Get a repricer product
    • Delete a repricer product
    • Update a repricer product
    • Reprice a product
    • List strategies
    • Create a strategy
    • Delete strategies
    • Get a strategy
    • Delete a strategy
    • Update a strategy
    • Assign a strategy
  • Tags (Beta)
    • List tags
    • Create tags
    • Delete tags
    • Delete a tag
    • Update a tag
    • Tag products
  • Seller Spy (Beta)
    • List tracked sellers
    • Track sellers
    • Untrack sellers
    • Get a tracked seller
    • Untrack a seller
    • List seller products
    • List seller changes
    • List seller brands
    • Get the overview
    • List brand opportunities
    • Get the activity
  • IP-Alert (Beta)
    • Get IP-Alert warnings of a product
    • Get IP-Alert warnings of a brand
    • List seller IP-Alerts
  • Schemas
    • Schemas
      • ApiError
      • CheckAsinRestrictionsRequest
      • EstimateSalesRequest
      • AmazonSellerAccountRequiredApiError
      • InternalApiError
      • EstimateSalesByAsinRequest
      • ProductResponse
      • DangerBrand
      • ProductDefect
      • Category
      • Variation
      • Marketplace
      • Urls
      • Price
      • Size
      • ProductPriceCurrency
      • Risks
      • Offers
      • FbaDetails
    • BadRequestApiError
    • ConvertToASINResponseItem
    • AccessDeniedApiError
    • PaymentRequiredApiError
    • ConvertToASINResponse
    • ResourceNotFoundApiError
    • ConvertToASINInternalApiError
    • TooManyRequestsApiError
    • GetProductIdentifiersResponseItem
    • GetProductIdentifiersResponse
    • GetProductIdentifiersInternalApiError
    • ListPlanShipmentsResponse
    • Document
    • ListPlanShipmentsInternalApiError
    • ProductNotFoundApiError
    • GetShipmentFeesResponse
    • GetShipmentFeesInternalApiError
    • KeepaProductStats
    • KeepaProductCsv
    • IpAlertSellerProduct
    • KeepaProductOffer
    • IpAlertWarning
    • KeepaProduct
    • IpAlertReport
    • GetKeepaProductInternalApiError
    • SearchKeepaProductsResponse
    • SearchKeepaProductsInternalApiError
    • QueryKeepaProductsResponse
    • SearchInsightsObject
    • QueryKeepaProductsInternalApiError
    • PutListingsItemRequest
    • PutListingsItemInternalApiError
    • Currency
    • Quota
    • ProductBsr
    • FeatureFlag
    • ProductCategory
    • Note
    • ProductVariations
    • NoteForm
    • ProductVariation
    • PriceListAnalyzerUploadResponse
    • ProductMarketplace
    • PriceListAnalyzerJsonItem
    • ProductUrls
    • PriceListAnalyzerStatusResponse
    • ProductPrices
    • Product
    • ProductSize
    • ProductOffers
    • GetProductInternalApiError
    • BusinessLogicApiError
    • CalculateProductProfitInternalApiError
    • ProductStats
    • ProductRisks
    • GetProductStatsInternalApiError
    • CheckRestrictionsInternalApiError
    • ProductFees
    • CalculateProductProfitRequest
    • ProductProfit
    • CheckAsinRestrictionsResponse
    • InternalProduct
    • ProductMatch
    • ProductMatchItem
    • InternalProductForm
    • ListingForm
    • Listing
    • PurchaseOrder
    • PurchaseOrderForm
    • PurchaseOrderCreateForm
    • PurchaseOrderItemForm
    • CurrentUserInfoResponse
    • Sku
    • EstimateSalesInternalApiError
    • PurchaseOrderItem
    • SupplierOffer
    • EstimateSalesResponse
    • SupplierOfferFields
    • EstimateSalesByBsrRequest
    • Supplier
    • SupplierOfferCreate
    • SearchCatalogItemsResponse
    • CatalogItemsPagination
    • CreateSupplierForm
    • Refinements
    • UpdateSupplierForm
    • BrandRefinement
    • WarehouseForm
    • ClassificationRefinement
    • Warehouse
    • CatalogItem
    • WarehouseProvider
    • CatalogItemBrowseClassificationsByMarketplace
    • RepricerProductHistoryItem
    • CatalogItemBrowseClassification
    • HistorySearchResponse
    • CatalogItemDimensionsByMarketplace
    • HistoryStats
    • Dimensions
    • RepricerDefaultSettings
    • Dimension
    • RepricerInfo
    • CatalogItemIdentifiersByMarketplace
    • RepricerSettings
    • CatalogItemIdentifier
    • UpdateRepricerSettings
    • CatalogItemImagesByMarketplace
    • RepricerProduct
    • CatalogItemImage
    • RepricerProductListResponse
    • CatalogItemProductTypeByMarketplace
    • CreateRepricerProductForm
    • CatalogItemRelationshipsByMarketplace
    • UpdateRepricerProductForm
    • CatalogItemRelationship
    • RepricerStrategy
    • CatalogItemVariationTheme
    • RepricerStrategyForm
    • CatalogItemSalesRanksByMarketplace
    • Tag
    • SellerSpySeller
    • CatalogItemClassificationSalesRank
    • TagForm
    • SellerSpySellerType
    • CatalogItemDisplayGroupSalesRank
    • SellerSpySellerDetails
    • GetCurrentUserInfoInternalApiError
    • CatalogItemSummaryByMarketplace
    • SellerSpyInsights
    • CatalogItemContributor
    • ApiV1Pagination
    • SellerSpyProduct
    • CatalogItemContributorRole
    • ApiV1BatchMeta
    • ApiV1TrialLimit
    • SellerSpyBrand
    • CatalogItemVendorDetailsByMarketplace
    • ApiV1BatchError
    • SellerSpyOverview
    • CatalogItemVendorDetailsCategory
    • SellerSpyBrandSignal
    • SearchCatalogItemsInternalApiError
    • SellerSpyActivity
    • GetCatalogItemInternalApiError
    • SellerSpyTrackForm
    • GetInventorySummariesResponse
    • GetInventorySummariesResult
    • InventoryPagination
    • Granularity
    • InventorySummary
    • InventoryDetails
    • ReservedQuantity
    • ResearchingQuantity
    • ResearchingQuantityEntry
    • UnfulfillableQuantity
    • GetInventorySummariesInternalApiError
    • SpApiMoney
    • ShipmentAddress
    • OldShipment
    • GetShipmentsResponse
    • GetShipmentsInternalApiError
    • OldShipmentItem
    • GetShipmentItemsResponse
    • GetShipmentItemsInternalApiError
    • GetShipmentItemsByShipmentIdResponse
    • GetShipmentItemsByShipmentIdInternalApiError
    • ListInboundPlansResponse
    • InboundPlanSummary
    • Address
    • ListInboundPlansInternalApiError
    • GetInboundPlanResponse
    • GetInboundPlanInternalApiError
    • ListPlacementOptionsResponse
    • PlacementOption
    • Incentive
    • CurrencyValue
    • ListPlacementOptionsInternalApiError
    • TransportationOption
    • ListTransportationOptionsResponse
    • ListTransportationOptionsInternalApiError
    • ShipmentSummary
    • GetShipmentInternalApiError
    • ShipmentItem
    • PrepInstruction
    • ListShipmentItemsResponse
    • ListShipmentItemsInternalApiError
    • ListInboundPlanBoxesResponse
    • Box
    • Region
    • BoxDimensions
    • BoxWeight
    • ListInboundPlanBoxesInternalApiError
    • ListShipmentBoxesResponse
    • ListShipmentBoxesInternalApiError
    • ListPackingOptionsResponse
    • PackingOption
    • PackingConfiguration
    • BoxRequirements
    • WeightRange
    • ShippingRequirements
    • ShippingConfiguration
    • ListPackingOptionsInternalApiError
    • ListPackingGroupBoxesResponse
    • ListPackingGroupBoxesInternalApiError
    • ListPackingGroupItemsResponse
    • ListPackingGroupItemsInternalApiError
    • SearchListingsItemsResponse
    • Pagination
    • CurrencyAmount
    • Points
    • Image
    • VariationTheme
    • ListingsItemSummary
    • ListingsItemIssue
    • Enforcements
    • EnforcementAction
    • Exemption
    • ListingsItemIdentifier
    • ListingOfferPrice
    • OfferAudience
    • FulfillmentAvailability
    • Procurement
    • ProductRelationship
    • MarketplaceRelationship
    • ProductTypeDefinition
    • ListingsItem
    • SearchListingsItemsInternalApiError
    • GetListingsItemInternalApiError
    • ListingsItemPutRequest
    • ListingsItemSubmissionResponse
    • ListingsItemPatchRequest
    • PatchListingsItemInternalApiError
    • DeleteListingsItemInternalApiError
    • ProductType
    • ProductTypeListResponse
    • SearchProductTypeDefinitionsInternalApiError
    • ProductTypeDefinitionResponse
    • ProductTypeVersion
    • Link
    • SchemaLink
    • PropertyGroup
    • ProductTypeDefinitionsInternalApiError
    • CompetitivePricingError
    • CompetitivePricingProduct
    • CompetitivePricingItem
    • CompetitivePricingResponse
    • CompetitiveSummaryError
    • CompetitiveSummaryResponse
  1. SP-API FBA Shipments

Get shipment

GET
https://app.sellerassistant.app/api/v1/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}
Proxy to https://developer-docs.amazon.com/sp-api/reference/getshipment. 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 header
X-Api-Key
Example:
X-Api-Key: ********************
or
Path Params

Query Params

Request Code 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 'https://app.sellerassistant.app/api/v1/sp-api/inbound/fba/2024-03-20/inboundPlans/wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2/shipments/sh7059be6b-54b3-4320-8553-f913d3472cc3?domain=amazon.com&marketplaceId=ATVPDKIKX0DER' \
--header 'X-Api-Key: <api-key>'

Responses

🟢200OK
application/json
Successful response
Bodyapplication/json

Example
{
    "amazonReferenceId": "string",
    "contactInformation": {
        "email": "string",
        "name": "string",
        "phoneNumber": "string"
    },
    "dates": {
        "readyToShipWindow": {
            "editableUntil": "2019-08-24T14:15:22.123Z",
            "end": "2019-08-24T14:15:22.123Z",
            "start": "2019-08-24T14:15:22.123Z"
        }
    },
    "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:22.123Z",
        "endDate": "2019-08-24T14:15:22.123Z",
        "startDate": "2019-08-24T14:15:22.123Z"
    },
    "selectedTransportationOptionId": "stringstringstringstringstringstringst",
    "selfShipAppointmentDetails": [
        {
            "appointmentId": 0,
            "appointmentSlotTime": {
                "endTime": "2019-08-24T14:15:22.123Z",
                "startTime": "2019-08-24T14:15:22.123Z"
            },
            "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"
                }
            ]
        }
    }
}
🔴500Payment Required
🟠402Forbidden
🟠403Unprocessable Entity
🟠422Too Many Requests
🟠429Internal Server Error
Modified at 2026-11-11 14:11:07
Previous
List transportation options
Next
List shipment items
Built with