Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'ShipmentStatusList', 'SHIPPED,ERROR'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'ShipmentIdList', '<string>,<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'LastUpdatedAfter', '<dateTime>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'LastUpdatedBefore', '<dateTime>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'QueryType', 'SHIPMENT'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'NextToken', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'MarketplaceId', '<string>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://sellingpartnerapi-na.amazon.com/fba/inbound/v0/shipments', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "payload": {
-- "ShipmentData": [
-- {
-- "AreCasesRequired": "<boolean>",
-- "ShipFromAddress": {
-- "AddressLine1": "<string>",
-- "City": "<string>",
-- "CountryCode": "<string>",
-- "Name": "<string>",
-- "PostalCode": "<string>",
-- "StateOrProvinceCode": "<string>",
-- "AddressLine2": "<string>",
-- "DistrictOrCounty": "<string>"
-- },
-- "ShipmentId": "<string>",
-- "ShipmentName": "<string>",
-- "DestinationFulfillmentCenterId": "<string>",
-- "ShipmentStatus": "CLOSED",
-- "LabelPrepType": "NO_LABEL",
-- "ConfirmedNeedByDate": "<date>",
-- "BoxContentsSource": "FEED",
-- "EstimatedBoxContentsFee": {
-- "TotalUnits": "<integer>",
-- "FeePerUnit": {
-- "CurrencyCode": "GBP",
-- "Value": "<double>"
-- },
-- "TotalFee": {
-- "CurrencyCode": "USD",
-- "Value": "<double>"
-- }
-- }
-- },
-- {
-- "AreCasesRequired": "<boolean>",
-- "ShipFromAddress": {
-- "AddressLine1": "<string>",
-- "City": "<string>",
-- "CountryCode": "<string>",
-- "Name": "<string>",
-- "PostalCode": "<string>",
-- "StateOrProvinceCode": "<string>",
-- "AddressLine2": "<string>",
-- "DistrictOrCounty": "<string>"
-- },
-- "ShipmentId": "<string>",
-- "ShipmentName": "<string>",
-- "DestinationFulfillmentCenterId": "<string>",
-- "ShipmentStatus": "RECEIVING",
-- "LabelPrepType": "NO_LABEL",
-- "ConfirmedNeedByDate": "<date>",
-- "BoxContentsSource": "NONE",
-- "EstimatedBoxContentsFee": {
-- "TotalUnits": "<integer>",
-- "FeePerUnit": {
-- "CurrencyCode": "GBP",
-- "Value": "<double>"
-- },
-- "TotalFee": {
-- "CurrencyCode": "USD",
-- "Value": "<double>"
-- }
-- }
-- }
-- ],
-- "NextToken": "<string>"
-- },
-- "errors": [
-- {
-- "code": "<string>",
-- "message": "<string>",
-- "details": "<string>"
-- },
-- {
-- "code": "<string>",
-- "message": "<string>",
-- "details": "<string>"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @AreCasesRequired nvarchar(4000)
DECLARE @AddressLine1 nvarchar(4000)
DECLARE @City nvarchar(4000)
DECLARE @CountryCode nvarchar(4000)
DECLARE @Name nvarchar(4000)
DECLARE @PostalCode nvarchar(4000)
DECLARE @StateOrProvinceCode nvarchar(4000)
DECLARE @AddressLine2 nvarchar(4000)
DECLARE @DistrictOrCounty nvarchar(4000)
DECLARE @ShipmentId nvarchar(4000)
DECLARE @ShipmentName nvarchar(4000)
DECLARE @DestinationFulfillmentCenterId nvarchar(4000)
DECLARE @ShipmentStatus nvarchar(4000)
DECLARE @LabelPrepType nvarchar(4000)
DECLARE @ConfirmedNeedByDate nvarchar(4000)
DECLARE @BoxContentsSource nvarchar(4000)
DECLARE @TotalUnits nvarchar(4000)
DECLARE @CurrencyCode nvarchar(4000)
DECLARE @Value nvarchar(4000)
DECLARE @TotalFeeCurrencyCode nvarchar(4000)
DECLARE @TotalFeeValue nvarchar(4000)
DECLARE @code nvarchar(4000)
DECLARE @message nvarchar(4000)
DECLARE @details nvarchar(4000)
DECLARE @NextToken nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @NextToken OUT, 'payload.NextToken'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'payload.ShipmentData'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @AreCasesRequired OUT, 'payload.ShipmentData[i].AreCasesRequired'
EXEC sp_OAMethod @jResp, 'StringOf', @AddressLine1 OUT, 'payload.ShipmentData[i].ShipFromAddress.AddressLine1'
EXEC sp_OAMethod @jResp, 'StringOf', @City OUT, 'payload.ShipmentData[i].ShipFromAddress.City'
EXEC sp_OAMethod @jResp, 'StringOf', @CountryCode OUT, 'payload.ShipmentData[i].ShipFromAddress.CountryCode'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'payload.ShipmentData[i].ShipFromAddress.Name'
EXEC sp_OAMethod @jResp, 'StringOf', @PostalCode OUT, 'payload.ShipmentData[i].ShipFromAddress.PostalCode'
EXEC sp_OAMethod @jResp, 'StringOf', @StateOrProvinceCode OUT, 'payload.ShipmentData[i].ShipFromAddress.StateOrProvinceCode'
EXEC sp_OAMethod @jResp, 'StringOf', @AddressLine2 OUT, 'payload.ShipmentData[i].ShipFromAddress.AddressLine2'
EXEC sp_OAMethod @jResp, 'StringOf', @DistrictOrCounty OUT, 'payload.ShipmentData[i].ShipFromAddress.DistrictOrCounty'
EXEC sp_OAMethod @jResp, 'StringOf', @ShipmentId OUT, 'payload.ShipmentData[i].ShipmentId'
EXEC sp_OAMethod @jResp, 'StringOf', @ShipmentName OUT, 'payload.ShipmentData[i].ShipmentName'
EXEC sp_OAMethod @jResp, 'StringOf', @DestinationFulfillmentCenterId OUT, 'payload.ShipmentData[i].DestinationFulfillmentCenterId'
EXEC sp_OAMethod @jResp, 'StringOf', @ShipmentStatus OUT, 'payload.ShipmentData[i].ShipmentStatus'
EXEC sp_OAMethod @jResp, 'StringOf', @LabelPrepType OUT, 'payload.ShipmentData[i].LabelPrepType'
EXEC sp_OAMethod @jResp, 'StringOf', @ConfirmedNeedByDate OUT, 'payload.ShipmentData[i].ConfirmedNeedByDate'
EXEC sp_OAMethod @jResp, 'StringOf', @BoxContentsSource OUT, 'payload.ShipmentData[i].BoxContentsSource'
EXEC sp_OAMethod @jResp, 'StringOf', @TotalUnits OUT, 'payload.ShipmentData[i].EstimatedBoxContentsFee.TotalUnits'
EXEC sp_OAMethod @jResp, 'StringOf', @CurrencyCode OUT, 'payload.ShipmentData[i].EstimatedBoxContentsFee.FeePerUnit.CurrencyCode'
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'payload.ShipmentData[i].EstimatedBoxContentsFee.FeePerUnit.Value'
EXEC sp_OAMethod @jResp, 'StringOf', @TotalFeeCurrencyCode OUT, 'payload.ShipmentData[i].EstimatedBoxContentsFee.TotalFee.CurrencyCode'
EXEC sp_OAMethod @jResp, 'StringOf', @TotalFeeValue OUT, 'payload.ShipmentData[i].EstimatedBoxContentsFee.TotalFee.Value'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'errors'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @code OUT, 'errors[i].code'
EXEC sp_OAMethod @jResp, 'StringOf', @message OUT, 'errors[i].message'
EXEC sp_OAMethod @jResp, 'StringOf', @details OUT, 'errors[i].details'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -G -d "ShipmentStatusList=SHIPPED,ERROR"
-d "ShipmentIdList=%3Cstring%3E,%3Cstring%3E"
-d "LastUpdatedAfter=%3CdateTime%3E"
-d "LastUpdatedBefore=%3CdateTime%3E"
-d "QueryType=SHIPMENT"
-d "NextToken=%3Cstring%3E"
-d "MarketplaceId=%3Cstring%3E"
-H "Accept: application/json"
https://sellingpartnerapi-na.amazon.com/fba/inbound/v0/shipments
Postman Collection Item JSON
{
"name": "get Shipments",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments?ShipmentStatusList=SHIPPED,ERROR&ShipmentIdList=<string>,<string>&LastUpdatedAfter=<dateTime>&LastUpdatedBefore=<dateTime>&QueryType=SHIPMENT&NextToken=<string>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments"
],
"query": [
{
"key": "ShipmentStatusList",
"value": "SHIPPED,ERROR",
"description": "A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify."
},
{
"key": "ShipmentIdList",
"value": "<string>,<string>",
"description": "A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned."
},
{
"key": "LastUpdatedAfter",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "LastUpdatedBefore",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "QueryType",
"value": "SHIPMENT",
"description": "(Required) Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request."
},
{
"key": "NextToken",
"value": "<string>",
"description": "A string token returned in the response to your previous request."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace where the product would be stored."
}
]
},
"description": "Returns a list of inbound shipments based on criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)."
},
"response": [
{
"name": "Success.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments?ShipmentStatusList=SHIPPED,ERROR&ShipmentIdList=<string>,<string>&LastUpdatedAfter=<dateTime>&LastUpdatedBefore=<dateTime>&QueryType=SHIPMENT&NextToken=<string>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments"
],
"query": [
{
"key": "ShipmentStatusList",
"value": "SHIPPED,ERROR",
"description": "A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify."
},
{
"key": "ShipmentIdList",
"value": "<string>,<string>",
"description": "A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned."
},
{
"key": "LastUpdatedAfter",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "LastUpdatedBefore",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "QueryType",
"value": "SHIPMENT",
"description": "(Required) Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request."
},
{
"key": "NextToken",
"value": "<string>",
"description": "A string token returned in the response to your previous request."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace where the product would be stored."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ShipmentData\": [\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"CLOSED\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"FEED\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n },\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"RECEIVING\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"NONE\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n }\n ],\n \"NextToken\": \"<string>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Request has missing or invalid parameters and cannot be parsed.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments?ShipmentStatusList=SHIPPED,ERROR&ShipmentIdList=<string>,<string>&LastUpdatedAfter=<dateTime>&LastUpdatedBefore=<dateTime>&QueryType=SHIPMENT&NextToken=<string>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments"
],
"query": [
{
"key": "ShipmentStatusList",
"value": "SHIPPED,ERROR",
"description": "A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify."
},
{
"key": "ShipmentIdList",
"value": "<string>,<string>",
"description": "A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned."
},
{
"key": "LastUpdatedAfter",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "LastUpdatedBefore",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "QueryType",
"value": "SHIPMENT",
"description": "(Required) Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request."
},
{
"key": "NextToken",
"value": "<string>",
"description": "A string token returned in the response to your previous request."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace where the product would be stored."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ShipmentData\": [\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"CLOSED\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"FEED\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n },\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"RECEIVING\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"NONE\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n }\n ],\n \"NextToken\": \"<string>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments?ShipmentStatusList=SHIPPED,ERROR&ShipmentIdList=<string>,<string>&LastUpdatedAfter=<dateTime>&LastUpdatedBefore=<dateTime>&QueryType=SHIPMENT&NextToken=<string>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments"
],
"query": [
{
"key": "ShipmentStatusList",
"value": "SHIPPED,ERROR",
"description": "A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify."
},
{
"key": "ShipmentIdList",
"value": "<string>,<string>",
"description": "A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned."
},
{
"key": "LastUpdatedAfter",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "LastUpdatedBefore",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "QueryType",
"value": "SHIPMENT",
"description": "(Required) Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request."
},
{
"key": "NextToken",
"value": "<string>",
"description": "A string token returned in the response to your previous request."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace where the product would be stored."
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ShipmentData\": [\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"CLOSED\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"FEED\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n },\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"RECEIVING\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"NONE\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n }\n ],\n \"NextToken\": \"<string>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments?ShipmentStatusList=SHIPPED,ERROR&ShipmentIdList=<string>,<string>&LastUpdatedAfter=<dateTime>&LastUpdatedBefore=<dateTime>&QueryType=SHIPMENT&NextToken=<string>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments"
],
"query": [
{
"key": "ShipmentStatusList",
"value": "SHIPPED,ERROR",
"description": "A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify."
},
{
"key": "ShipmentIdList",
"value": "<string>,<string>",
"description": "A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned."
},
{
"key": "LastUpdatedAfter",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "LastUpdatedBefore",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "QueryType",
"value": "SHIPMENT",
"description": "(Required) Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request."
},
{
"key": "NextToken",
"value": "<string>",
"description": "A string token returned in the response to your previous request."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace where the product would be stored."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ShipmentData\": [\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"CLOSED\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"FEED\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n },\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"RECEIVING\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"NONE\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n }\n ],\n \"NextToken\": \"<string>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The specified resource does not exist.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments?ShipmentStatusList=SHIPPED,ERROR&ShipmentIdList=<string>,<string>&LastUpdatedAfter=<dateTime>&LastUpdatedBefore=<dateTime>&QueryType=SHIPMENT&NextToken=<string>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments"
],
"query": [
{
"key": "ShipmentStatusList",
"value": "SHIPPED,ERROR",
"description": "A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify."
},
{
"key": "ShipmentIdList",
"value": "<string>,<string>",
"description": "A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned."
},
{
"key": "LastUpdatedAfter",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "LastUpdatedBefore",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "QueryType",
"value": "SHIPMENT",
"description": "(Required) Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request."
},
{
"key": "NextToken",
"value": "<string>",
"description": "A string token returned in the response to your previous request."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace where the product would be stored."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ShipmentData\": [\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"CLOSED\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"FEED\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n },\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"RECEIVING\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"NONE\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n }\n ],\n \"NextToken\": \"<string>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The frequency of requests was greater than allowed.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments?ShipmentStatusList=SHIPPED,ERROR&ShipmentIdList=<string>,<string>&LastUpdatedAfter=<dateTime>&LastUpdatedBefore=<dateTime>&QueryType=SHIPMENT&NextToken=<string>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments"
],
"query": [
{
"key": "ShipmentStatusList",
"value": "SHIPPED,ERROR",
"description": "A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify."
},
{
"key": "ShipmentIdList",
"value": "<string>,<string>",
"description": "A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned."
},
{
"key": "LastUpdatedAfter",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "LastUpdatedBefore",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "QueryType",
"value": "SHIPMENT",
"description": "(Required) Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request."
},
{
"key": "NextToken",
"value": "<string>",
"description": "A string token returned in the response to your previous request."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace where the product would be stored."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ShipmentData\": [\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"CLOSED\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"FEED\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n },\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"RECEIVING\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"NONE\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n }\n ],\n \"NextToken\": \"<string>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments?ShipmentStatusList=SHIPPED,ERROR&ShipmentIdList=<string>,<string>&LastUpdatedAfter=<dateTime>&LastUpdatedBefore=<dateTime>&QueryType=SHIPMENT&NextToken=<string>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments"
],
"query": [
{
"key": "ShipmentStatusList",
"value": "SHIPPED,ERROR",
"description": "A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify."
},
{
"key": "ShipmentIdList",
"value": "<string>,<string>",
"description": "A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned."
},
{
"key": "LastUpdatedAfter",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "LastUpdatedBefore",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "QueryType",
"value": "SHIPMENT",
"description": "(Required) Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request."
},
{
"key": "NextToken",
"value": "<string>",
"description": "A string token returned in the response to your previous request."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace where the product would be stored."
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ShipmentData\": [\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"CLOSED\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"FEED\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n },\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"RECEIVING\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"NONE\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n }\n ],\n \"NextToken\": \"<string>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Temporary overloading or maintenance of the server.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/inbound/v0/shipments?ShipmentStatusList=SHIPPED,ERROR&ShipmentIdList=<string>,<string>&LastUpdatedAfter=<dateTime>&LastUpdatedBefore=<dateTime>&QueryType=SHIPMENT&NextToken=<string>&MarketplaceId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"inbound",
"v0",
"shipments"
],
"query": [
{
"key": "ShipmentStatusList",
"value": "SHIPPED,ERROR",
"description": "A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify."
},
{
"key": "ShipmentIdList",
"value": "<string>,<string>",
"description": "A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned."
},
{
"key": "LastUpdatedAfter",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "LastUpdatedBefore",
"value": "<dateTime>",
"description": "A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller."
},
{
"key": "QueryType",
"value": "SHIPMENT",
"description": "(Required) Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request."
},
{
"key": "NextToken",
"value": "<string>",
"description": "A string token returned in the response to your previous request."
},
{
"key": "MarketplaceId",
"value": "<string>",
"description": "(Required) A marketplace identifier. Specifies the marketplace where the product would be stored."
}
]
}
},
"status": "Service Unavailable",
"code": 503,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"ShipmentData\": [\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"CLOSED\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"FEED\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n },\n {\n \"AreCasesRequired\": \"<boolean>\",\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Name\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShipmentName\": \"<string>\",\n \"DestinationFulfillmentCenterId\": \"<string>\",\n \"ShipmentStatus\": \"RECEIVING\",\n \"LabelPrepType\": \"NO_LABEL\",\n \"ConfirmedNeedByDate\": \"<date>\",\n \"BoxContentsSource\": \"NONE\",\n \"EstimatedBoxContentsFee\": {\n \"TotalUnits\": \"<integer>\",\n \"FeePerUnit\": {\n \"CurrencyCode\": \"GBP\",\n \"Value\": \"<double>\"\n },\n \"TotalFee\": {\n \"CurrencyCode\": \"USD\",\n \"Value\": \"<double>\"\n }\n }\n }\n ],\n \"NextToken\": \"<string>\"\n },\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
}
]
}
