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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequest', @resp OUT, 'PUT', 'https://sellingpartnerapi-na.amazon.com/mfn/v0/shipments/:shipmentId/cancel'
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
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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 @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": {
-- "AmazonOrderId": "<string>",
-- "CreatedDate": "<dateTime>",
-- "Insurance": {
-- "Amount": "<double>",
-- "CurrencyCode": "<string>"
-- },
-- "ItemList": [
-- {
-- "OrderItemId": "<string>",
-- "Quantity": "<integer>",
-- "ItemWeight": {
-- "Unit": "oz",
-- "Value": "<double>"
-- },
-- "ItemDescription": "<string>",
-- "TransparencyCodeList": [
-- "<string>",
-- "<string>"
-- ],
-- "ItemLevelSellerInputsList": [
-- {
-- "AdditionalInputFieldName": "<string>",
-- "AdditionalSellerInput": {
-- "DataType": "<string>",
-- "ValueAsString": "<string>",
-- "ValueAsBoolean": "<boolean>",
-- "ValueAsInteger": "<integer>",
-- "ValueAsTimestamp": "<dateTime>",
-- "ValueAsAddress": {
-- "AddressLine1": "<string>",
-- "City": "<string>",
-- "CountryCode": "<string>",
-- "Email": "<string>",
-- "Name": "<string>",
-- "Phone": "<string>",
-- "PostalCode": "<string>",
-- "AddressLine2": "<string>",
-- "AddressLine3": "<string>",
-- "DistrictOrCounty": "<string>",
-- "StateOrProvinceCode": "<string>"
-- },
-- "ValueAsWeight": {
-- "Unit": "oz",
-- "Value": "<double>"
-- },
-- "ValueAsDimension": {
-- "value": "<number>",
-- "unit": "centimeters"
-- },
-- "ValueAsCurrency": {
-- "Amount": "<double>",
-- "CurrencyCode": "<string>"
-- }
-- }
-- },
-- {
-- "AdditionalInputFieldName": "<string>",
-- "AdditionalSellerInput": {
-- "DataType": "<string>",
-- "ValueAsString": "<string>",
-- "ValueAsBoolean": "<boolean>",
-- "ValueAsInteger": "<integer>",
-- "ValueAsTimestamp": "<dateTime>",
-- "ValueAsAddress": {
-- "AddressLine1": "<string>",
-- "City": "<string>",
-- "CountryCode": "<string>",
-- "Email": "<string>",
-- "Name": "<string>",
-- "Phone": "<string>",
-- "PostalCode": "<string>",
-- "AddressLine2": "<string>",
-- "AddressLine3": "<string>",
-- "DistrictOrCounty": "<string>",
-- "StateOrProvinceCode": "<string>"
-- },
-- "ValueAsWeight": {
-- "Unit": "g",
-- "Value": "<double>"
-- },
-- "ValueAsDimension": {
-- "value": "<number>",
-- "unit": "inches"
-- },
-- "ValueAsCurrency": {
-- "Amount": "<double>",
-- "CurrencyCode": "<string>"
-- }
-- }
-- }
-- ]
-- },
-- {
-- "OrderItemId": "<string>",
-- "Quantity": "<integer>",
-- "ItemWeight": {
-- "Unit": "g",
-- "Value": "<double>"
-- },
-- "ItemDescription": "<string>",
-- "TransparencyCodeList": [
-- "<string>",
-- "<string>"
-- ],
-- "ItemLevelSellerInputsList": [
-- {
-- "AdditionalInputFieldName": "<string>",
-- "AdditionalSellerInput": {
-- "DataType": "<string>",
-- "ValueAsString": "<string>",
-- "ValueAsBoolean": "<boolean>",
-- "ValueAsInteger": "<integer>",
-- "ValueAsTimestamp": "<dateTime>",
-- "ValueAsAddress": {
-- "AddressLine1": "<string>",
-- "City": "<string>",
-- "CountryCode": "<string>",
-- "Email": "<string>",
-- "Name": "<string>",
-- "Phone": "<string>",
-- "PostalCode": "<string>",
-- "AddressLine2": "<string>",
-- "AddressLine3": "<string>",
-- "DistrictOrCounty": "<string>",
-- "StateOrProvinceCode": "<string>"
-- },
-- "ValueAsWeight": {
-- "Unit": "oz",
-- "Value": "<double>"
-- },
-- "ValueAsDimension": {
-- "value": "<number>",
-- "unit": "inches"
-- },
-- "ValueAsCurrency": {
-- "Amount": "<double>",
-- "CurrencyCode": "<string>"
-- }
-- }
-- },
-- {
-- "AdditionalInputFieldName": "<string>",
-- "AdditionalSellerInput": {
-- "DataType": "<string>",
-- "ValueAsString": "<string>",
-- "ValueAsBoolean": "<boolean>",
-- "ValueAsInteger": "<integer>",
-- "ValueAsTimestamp": "<dateTime>",
-- "ValueAsAddress": {
-- "AddressLine1": "<string>",
-- "City": "<string>",
-- "CountryCode": "<string>",
-- "Email": "<string>",
-- "Name": "<string>",
-- "Phone": "<string>",
-- "PostalCode": "<string>",
-- "AddressLine2": "<string>",
-- "AddressLine3": "<string>",
-- "DistrictOrCounty": "<string>",
-- "StateOrProvinceCode": "<string>"
-- },
-- "ValueAsWeight": {
-- "Unit": "oz",
-- "Value": "<double>"
-- },
-- "ValueAsDimension": {
-- "value": "<number>",
-- "unit": "centimeters"
-- },
-- "ValueAsCurrency": {
-- "Amount": "<double>",
-- "CurrencyCode": "<string>"
-- }
-- }
-- }
-- ]
-- }
-- ],
-- "Label": {
-- "Dimensions": {
-- "Length": "<number>",
-- "Unit": "inches",
-- "Width": "<number>"
-- },
-- "FileContents": {
-- "Checksum": "<string>",
-- "Contents": "<string>",
-- "FileType": "image/png"
-- },
-- "CustomTextForLabel": "<string>",
-- "LabelFormat": "PDF",
-- "StandardIdForLabel": "AmazonOrderId"
-- },
-- "PackageDimensions": {
-- "Length": "<double>",
-- "Width": "<double>",
-- "Height": "<double>",
-- "Unit": "centimeters",
-- "PredefinedPackageDimensions": "USPS_Flat"
-- },
-- "ShipFromAddress": {
-- "AddressLine1": "<string>",
-- "City": "<string>",
-- "CountryCode": "<string>",
-- "Email": "<string>",
-- "Name": "<string>",
-- "Phone": "<string>",
-- "PostalCode": "<string>",
-- "AddressLine2": "<string>",
-- "AddressLine3": "<string>",
-- "DistrictOrCounty": "<string>",
-- "StateOrProvinceCode": "<string>"
-- },
-- "ShipToAddress": {
-- "AddressLine1": "<string>",
-- "City": "<string>",
-- "CountryCode": "<string>",
-- "Email": "<string>",
-- "Name": "<string>",
-- "Phone": "<string>",
-- "PostalCode": "<string>",
-- "AddressLine2": "<string>",
-- "AddressLine3": "<string>",
-- "DistrictOrCounty": "<string>",
-- "StateOrProvinceCode": "<string>"
-- },
-- "ShipmentId": "<string>",
-- "ShippingService": {
-- "CarrierName": "<string>",
-- "Rate": {
-- "Amount": "<double>",
-- "CurrencyCode": "<string>"
-- },
-- "RequiresAdditionalSellerInputs": "<boolean>",
-- "ShipDate": "<dateTime>",
-- "ShippingServiceId": "<string>",
-- "ShippingServiceName": "<string>",
-- "ShippingServiceOfferId": "<string>",
-- "ShippingServiceOptions": {
-- "CarrierWillPickUp": "<boolean>",
-- "DeliveryExperience": "NoTracking",
-- "DeclaredValue": {
-- "Amount": "<double>",
-- "CurrencyCode": "<string>"
-- },
-- "CarrierWillPickUpOption": "CarrierWillPickUp",
-- "LabelFormat": "PDF"
-- },
-- "EarliestEstimatedDeliveryDate": "<dateTime>",
-- "LatestEstimatedDeliveryDate": "<dateTime>",
-- "AvailableShippingServiceOptions": {
-- "AvailableCarrierWillPickUpOptions": [
-- {
-- "CarrierWillPickUpOption": "ShipperWillDropOff",
-- "Charge": {
-- "Amount": "<double>",
-- "CurrencyCode": "<string>"
-- }
-- },
-- {
-- "CarrierWillPickUpOption": "NoPreference",
-- "Charge": {
-- "Amount": "<double>",
-- "CurrencyCode": "<string>"
-- }
-- }
-- ],
-- "AvailableDeliveryExperienceOptions": [
-- {
-- "Charge": {
-- "Amount": "<double>",
-- "CurrencyCode": "<string>"
-- },
-- "DeliveryExperienceOption": "DeliveryConfirmationWithSignature"
-- },
-- {
-- "Charge": {
-- "Amount": "<double>",
-- "CurrencyCode": "<string>"
-- },
-- "DeliveryExperienceOption": "DeliveryConfirmationWithoutSignature"
-- }
-- ]
-- },
-- "AvailableLabelFormats": [
-- "ZPL300",
-- "ShippingServiceDefault"
-- ],
-- "AvailableFormatOptionsForLabel": [
-- {
-- "IncludePackingSlipWithLabel": "<boolean>",
-- "LabelFormat": "ZPL203"
-- },
-- {
-- "IncludePackingSlipWithLabel": "<boolean>",
-- "LabelFormat": "PDF"
-- }
-- ]
-- },
-- "Status": "RefundApplied",
-- "Weight": {
-- "Unit": "g",
-- "Value": "<double>"
-- },
-- "SellerOrderId": "<string>",
-- "TrackingId": "<string>",
-- "LastUpdatedDate": "<dateTime>"
-- },
-- "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 @OrderItemId nvarchar(4000)
DECLARE @Quantity nvarchar(4000)
DECLARE @ItemWeightUnit nvarchar(4000)
DECLARE @ItemWeightValue nvarchar(4000)
DECLARE @ItemDescription nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @strVal nvarchar(4000)
DECLARE @AdditionalInputFieldName nvarchar(4000)
DECLARE @DataType nvarchar(4000)
DECLARE @ValueAsString nvarchar(4000)
DECLARE @ValueAsBoolean nvarchar(4000)
DECLARE @ValueAsInteger nvarchar(4000)
DECLARE @ValueAsTimestamp nvarchar(4000)
DECLARE @ValueAsAddressAddressLine1 nvarchar(4000)
DECLARE @ValueAsAddressCity nvarchar(4000)
DECLARE @ValueAsAddressCountryCode nvarchar(4000)
DECLARE @ValueAsAddressEmail nvarchar(4000)
DECLARE @ValueAsAddressName nvarchar(4000)
DECLARE @ValueAsAddressPhone nvarchar(4000)
DECLARE @ValueAsAddressPostalCode nvarchar(4000)
DECLARE @ValueAsAddressAddressLine2 nvarchar(4000)
DECLARE @ValueAsAddressAddressLine3 nvarchar(4000)
DECLARE @ValueAsAddressDistrictOrCounty nvarchar(4000)
DECLARE @ValueAsAddressStateOrProvinceCode nvarchar(4000)
DECLARE @ValueAsWeightUnit nvarchar(4000)
DECLARE @ValueAsWeightValue nvarchar(4000)
DECLARE @ValueAsDimensionValue nvarchar(4000)
DECLARE @ValueAsDimensionUnit nvarchar(4000)
DECLARE @ValueAsCurrencyAmount nvarchar(4000)
DECLARE @ValueAsCurrencyCurrencyCode nvarchar(4000)
DECLARE @ChargeAmount nvarchar(4000)
DECLARE @ChargeCurrencyCode nvarchar(4000)
DECLARE @DeliveryExperienceOption nvarchar(4000)
DECLARE @IncludePackingSlipWithLabel nvarchar(4000)
DECLARE @code nvarchar(4000)
DECLARE @message nvarchar(4000)
DECLARE @details nvarchar(4000)
DECLARE @AmazonOrderId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @AmazonOrderId OUT, 'payload.AmazonOrderId'
DECLARE @CreatedDate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CreatedDate OUT, 'payload.CreatedDate'
DECLARE @Amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Amount OUT, 'payload.Insurance.Amount'
DECLARE @CurrencyCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CurrencyCode OUT, 'payload.Insurance.CurrencyCode'
DECLARE @Length nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Length OUT, 'payload.Label.Dimensions.Length'
DECLARE @Unit nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Unit OUT, 'payload.Label.Dimensions.Unit'
DECLARE @Width nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Width OUT, 'payload.Label.Dimensions.Width'
DECLARE @Checksum nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Checksum OUT, 'payload.Label.FileContents.Checksum'
DECLARE @Contents nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Contents OUT, 'payload.Label.FileContents.Contents'
DECLARE @FileType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @FileType OUT, 'payload.Label.FileContents.FileType'
DECLARE @CustomTextForLabel nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CustomTextForLabel OUT, 'payload.Label.CustomTextForLabel'
DECLARE @LabelFormat nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LabelFormat OUT, 'payload.Label.LabelFormat'
DECLARE @StandardIdForLabel nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @StandardIdForLabel OUT, 'payload.Label.StandardIdForLabel'
DECLARE @PackageDimensionsLength nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @PackageDimensionsLength OUT, 'payload.PackageDimensions.Length'
DECLARE @PackageDimensionsWidth nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @PackageDimensionsWidth OUT, 'payload.PackageDimensions.Width'
DECLARE @Height nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Height OUT, 'payload.PackageDimensions.Height'
DECLARE @PackageDimensionsUnit nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @PackageDimensionsUnit OUT, 'payload.PackageDimensions.Unit'
DECLARE @PredefinedPackageDimensions nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @PredefinedPackageDimensions OUT, 'payload.PackageDimensions.PredefinedPackageDimensions'
DECLARE @AddressLine1 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @AddressLine1 OUT, 'payload.ShipFromAddress.AddressLine1'
DECLARE @City nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @City OUT, 'payload.ShipFromAddress.City'
DECLARE @CountryCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CountryCode OUT, 'payload.ShipFromAddress.CountryCode'
DECLARE @v_Email nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Email OUT, 'payload.ShipFromAddress.Email'
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'payload.ShipFromAddress.Name'
DECLARE @Phone nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Phone OUT, 'payload.ShipFromAddress.Phone'
DECLARE @PostalCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @PostalCode OUT, 'payload.ShipFromAddress.PostalCode'
DECLARE @AddressLine2 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @AddressLine2 OUT, 'payload.ShipFromAddress.AddressLine2'
DECLARE @AddressLine3 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @AddressLine3 OUT, 'payload.ShipFromAddress.AddressLine3'
DECLARE @DistrictOrCounty nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @DistrictOrCounty OUT, 'payload.ShipFromAddress.DistrictOrCounty'
DECLARE @StateOrProvinceCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @StateOrProvinceCode OUT, 'payload.ShipFromAddress.StateOrProvinceCode'
DECLARE @ShipToAddressAddressLine1 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShipToAddressAddressLine1 OUT, 'payload.ShipToAddress.AddressLine1'
DECLARE @ShipToAddressCity nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShipToAddressCity OUT, 'payload.ShipToAddress.City'
DECLARE @ShipToAddressCountryCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShipToAddressCountryCode OUT, 'payload.ShipToAddress.CountryCode'
DECLARE @ShipToAddressEmail nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShipToAddressEmail OUT, 'payload.ShipToAddress.Email'
DECLARE @ShipToAddressName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShipToAddressName OUT, 'payload.ShipToAddress.Name'
DECLARE @ShipToAddressPhone nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShipToAddressPhone OUT, 'payload.ShipToAddress.Phone'
DECLARE @ShipToAddressPostalCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShipToAddressPostalCode OUT, 'payload.ShipToAddress.PostalCode'
DECLARE @ShipToAddressAddressLine2 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShipToAddressAddressLine2 OUT, 'payload.ShipToAddress.AddressLine2'
DECLARE @ShipToAddressAddressLine3 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShipToAddressAddressLine3 OUT, 'payload.ShipToAddress.AddressLine3'
DECLARE @ShipToAddressDistrictOrCounty nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShipToAddressDistrictOrCounty OUT, 'payload.ShipToAddress.DistrictOrCounty'
DECLARE @ShipToAddressStateOrProvinceCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShipToAddressStateOrProvinceCode OUT, 'payload.ShipToAddress.StateOrProvinceCode'
DECLARE @ShipmentId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShipmentId OUT, 'payload.ShipmentId'
DECLARE @CarrierName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CarrierName OUT, 'payload.ShippingService.CarrierName'
DECLARE @RateAmount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @RateAmount OUT, 'payload.ShippingService.Rate.Amount'
DECLARE @RateCurrencyCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @RateCurrencyCode OUT, 'payload.ShippingService.Rate.CurrencyCode'
DECLARE @RequiresAdditionalSellerInputs nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @RequiresAdditionalSellerInputs OUT, 'payload.ShippingService.RequiresAdditionalSellerInputs'
DECLARE @ShipDate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShipDate OUT, 'payload.ShippingService.ShipDate'
DECLARE @ShippingServiceId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShippingServiceId OUT, 'payload.ShippingService.ShippingServiceId'
DECLARE @ShippingServiceName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShippingServiceName OUT, 'payload.ShippingService.ShippingServiceName'
DECLARE @ShippingServiceOfferId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShippingServiceOfferId OUT, 'payload.ShippingService.ShippingServiceOfferId'
DECLARE @CarrierWillPickUp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CarrierWillPickUp OUT, 'payload.ShippingService.ShippingServiceOptions.CarrierWillPickUp'
DECLARE @DeliveryExperience nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @DeliveryExperience OUT, 'payload.ShippingService.ShippingServiceOptions.DeliveryExperience'
DECLARE @DeclaredValueAmount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @DeclaredValueAmount OUT, 'payload.ShippingService.ShippingServiceOptions.DeclaredValue.Amount'
DECLARE @DeclaredValueCurrencyCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @DeclaredValueCurrencyCode OUT, 'payload.ShippingService.ShippingServiceOptions.DeclaredValue.CurrencyCode'
DECLARE @CarrierWillPickUpOption nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CarrierWillPickUpOption OUT, 'payload.ShippingService.ShippingServiceOptions.CarrierWillPickUpOption'
DECLARE @ShippingServiceOptionsLabelFormat nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ShippingServiceOptionsLabelFormat OUT, 'payload.ShippingService.ShippingServiceOptions.LabelFormat'
DECLARE @EarliestEstimatedDeliveryDate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @EarliestEstimatedDeliveryDate OUT, 'payload.ShippingService.EarliestEstimatedDeliveryDate'
DECLARE @LatestEstimatedDeliveryDate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LatestEstimatedDeliveryDate OUT, 'payload.ShippingService.LatestEstimatedDeliveryDate'
DECLARE @Status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Status OUT, 'payload.Status'
DECLARE @WeightUnit nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @WeightUnit OUT, 'payload.Weight.Unit'
DECLARE @Value nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'payload.Weight.Value'
DECLARE @SellerOrderId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SellerOrderId OUT, 'payload.SellerOrderId'
DECLARE @TrackingId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TrackingId OUT, 'payload.TrackingId'
DECLARE @LastUpdatedDate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LastUpdatedDate OUT, 'payload.LastUpdatedDate'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'payload.ItemList'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @OrderItemId OUT, 'payload.ItemList[i].OrderItemId'
EXEC sp_OAMethod @jResp, 'StringOf', @Quantity OUT, 'payload.ItemList[i].Quantity'
EXEC sp_OAMethod @jResp, 'StringOf', @ItemWeightUnit OUT, 'payload.ItemList[i].ItemWeight.Unit'
EXEC sp_OAMethod @jResp, 'StringOf', @ItemWeightValue OUT, 'payload.ItemList[i].ItemWeight.Value'
EXEC sp_OAMethod @jResp, 'StringOf', @ItemDescription OUT, 'payload.ItemList[i].ItemDescription'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'payload.ItemList[i].TransparencyCodeList'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'payload.ItemList[i].TransparencyCodeList[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'payload.ItemList[i].ItemLevelSellerInputsList'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @AdditionalInputFieldName OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalInputFieldName'
EXEC sp_OAMethod @jResp, 'StringOf', @DataType OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.DataType'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsString OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsString'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsBoolean OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsBoolean'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsInteger OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsInteger'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsTimestamp OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsTimestamp'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsAddressAddressLine1 OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.AddressLine1'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsAddressCity OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.City'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsAddressCountryCode OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.CountryCode'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsAddressEmail OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.Email'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsAddressName OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.Name'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsAddressPhone OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.Phone'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsAddressPostalCode OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.PostalCode'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsAddressAddressLine2 OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.AddressLine2'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsAddressAddressLine3 OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.AddressLine3'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsAddressDistrictOrCounty OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.DistrictOrCounty'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsAddressStateOrProvinceCode OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.StateOrProvinceCode'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsWeightUnit OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsWeight.Unit'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsWeightValue OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsWeight.Value'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsDimensionValue OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsDimension.value'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsDimensionUnit OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsDimension.unit'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsCurrencyAmount OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsCurrency.Amount'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueAsCurrencyCurrencyCode OUT, 'payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsCurrency.CurrencyCode'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'payload.ShippingService.AvailableShippingServiceOptions.AvailableCarrierWillPickUpOptions'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @CarrierWillPickUpOption OUT, 'payload.ShippingService.AvailableShippingServiceOptions.AvailableCarrierWillPickUpOptions[i].CarrierWillPickUpOption'
EXEC sp_OAMethod @jResp, 'StringOf', @ChargeAmount OUT, 'payload.ShippingService.AvailableShippingServiceOptions.AvailableCarrierWillPickUpOptions[i].Charge.Amount'
EXEC sp_OAMethod @jResp, 'StringOf', @ChargeCurrencyCode OUT, 'payload.ShippingService.AvailableShippingServiceOptions.AvailableCarrierWillPickUpOptions[i].Charge.CurrencyCode'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'payload.ShippingService.AvailableShippingServiceOptions.AvailableDeliveryExperienceOptions'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @ChargeAmount OUT, 'payload.ShippingService.AvailableShippingServiceOptions.AvailableDeliveryExperienceOptions[i].Charge.Amount'
EXEC sp_OAMethod @jResp, 'StringOf', @ChargeCurrencyCode OUT, 'payload.ShippingService.AvailableShippingServiceOptions.AvailableDeliveryExperienceOptions[i].Charge.CurrencyCode'
EXEC sp_OAMethod @jResp, 'StringOf', @DeliveryExperienceOption OUT, 'payload.ShippingService.AvailableShippingServiceOptions.AvailableDeliveryExperienceOptions[i].DeliveryExperienceOption'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'payload.ShippingService.AvailableLabelFormats'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'payload.ShippingService.AvailableLabelFormats[i]'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'payload.ShippingService.AvailableFormatOptionsForLabel'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @IncludePackingSlipWithLabel OUT, 'payload.ShippingService.AvailableFormatOptionsForLabel[i].IncludePackingSlipWithLabel'
EXEC sp_OAMethod @jResp, 'StringOf', @LabelFormat OUT, 'payload.ShippingService.AvailableFormatOptionsForLabel[i].LabelFormat'
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 @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X PUT
-H "Accept: application/json"
https://sellingpartnerapi-na.amazon.com/mfn/v0/shipments/:shipmentId/cancel
Postman Collection Item JSON
{
"name": "cancel Shipment Old",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/mfn/v0/shipments/:shipmentId/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"mfn",
"v0",
"shipments",
":shipmentId",
"cancel"
],
"variable": [
{
"key": "shipmentId",
"value": "dDf7AbAd-e041-Ee39-1AEE-cdAAF50beA10"
}
]
},
"description": "Cancel the shipment indicated by the specified shipment identifer.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/mfn/v0/shipments/:shipmentId/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"mfn",
"v0",
"shipments",
":shipmentId",
"cancel"
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"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 \"AmazonOrderId\": \"<string>\",\n \"CreatedDate\": \"<dateTime>\",\n \"Insurance\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"ItemList\": [\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n },\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n }\n ],\n \"Label\": {\n \"Dimensions\": {\n \"Length\": \"<number>\",\n \"Unit\": \"inches\",\n \"Width\": \"<number>\"\n },\n \"FileContents\": {\n \"Checksum\": \"<string>\",\n \"Contents\": \"<string>\",\n \"FileType\": \"image/png\"\n },\n \"CustomTextForLabel\": \"<string>\",\n \"LabelFormat\": \"PDF\",\n \"StandardIdForLabel\": \"AmazonOrderId\"\n },\n \"PackageDimensions\": {\n \"Length\": \"<double>\",\n \"Width\": \"<double>\",\n \"Height\": \"<double>\",\n \"Unit\": \"centimeters\",\n \"PredefinedPackageDimensions\": \"USPS_Flat\"\n },\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipToAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShippingService\": {\n \"CarrierName\": \"<string>\",\n \"Rate\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"RequiresAdditionalSellerInputs\": \"<boolean>\",\n \"ShipDate\": \"<dateTime>\",\n \"ShippingServiceId\": \"<string>\",\n \"ShippingServiceName\": \"<string>\",\n \"ShippingServiceOfferId\": \"<string>\",\n \"ShippingServiceOptions\": {\n \"CarrierWillPickUp\": \"<boolean>\",\n \"DeliveryExperience\": \"NoTracking\",\n \"DeclaredValue\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"CarrierWillPickUpOption\": \"CarrierWillPickUp\",\n \"LabelFormat\": \"PDF\"\n },\n \"EarliestEstimatedDeliveryDate\": \"<dateTime>\",\n \"LatestEstimatedDeliveryDate\": \"<dateTime>\",\n \"AvailableShippingServiceOptions\": {\n \"AvailableCarrierWillPickUpOptions\": [\n {\n \"CarrierWillPickUpOption\": \"ShipperWillDropOff\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n },\n {\n \"CarrierWillPickUpOption\": \"NoPreference\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n ],\n \"AvailableDeliveryExperienceOptions\": [\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithSignature\"\n },\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithoutSignature\"\n }\n ]\n },\n \"AvailableLabelFormats\": [\n \"ZPL300\",\n \"ShippingServiceDefault\"\n ],\n \"AvailableFormatOptionsForLabel\": [\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"ZPL203\"\n },\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"PDF\"\n }\n ]\n },\n \"Status\": \"RefundApplied\",\n \"Weight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"SellerOrderId\": \"<string>\",\n \"TrackingId\": \"<string>\",\n \"LastUpdatedDate\": \"<dateTime>\"\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": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/mfn/v0/shipments/:shipmentId/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"mfn",
"v0",
"shipments",
":shipmentId",
"cancel"
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"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 \"AmazonOrderId\": \"<string>\",\n \"CreatedDate\": \"<dateTime>\",\n \"Insurance\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"ItemList\": [\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n },\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n }\n ],\n \"Label\": {\n \"Dimensions\": {\n \"Length\": \"<number>\",\n \"Unit\": \"inches\",\n \"Width\": \"<number>\"\n },\n \"FileContents\": {\n \"Checksum\": \"<string>\",\n \"Contents\": \"<string>\",\n \"FileType\": \"image/png\"\n },\n \"CustomTextForLabel\": \"<string>\",\n \"LabelFormat\": \"PDF\",\n \"StandardIdForLabel\": \"AmazonOrderId\"\n },\n \"PackageDimensions\": {\n \"Length\": \"<double>\",\n \"Width\": \"<double>\",\n \"Height\": \"<double>\",\n \"Unit\": \"centimeters\",\n \"PredefinedPackageDimensions\": \"USPS_Flat\"\n },\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipToAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShippingService\": {\n \"CarrierName\": \"<string>\",\n \"Rate\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"RequiresAdditionalSellerInputs\": \"<boolean>\",\n \"ShipDate\": \"<dateTime>\",\n \"ShippingServiceId\": \"<string>\",\n \"ShippingServiceName\": \"<string>\",\n \"ShippingServiceOfferId\": \"<string>\",\n \"ShippingServiceOptions\": {\n \"CarrierWillPickUp\": \"<boolean>\",\n \"DeliveryExperience\": \"NoTracking\",\n \"DeclaredValue\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"CarrierWillPickUpOption\": \"CarrierWillPickUp\",\n \"LabelFormat\": \"PDF\"\n },\n \"EarliestEstimatedDeliveryDate\": \"<dateTime>\",\n \"LatestEstimatedDeliveryDate\": \"<dateTime>\",\n \"AvailableShippingServiceOptions\": {\n \"AvailableCarrierWillPickUpOptions\": [\n {\n \"CarrierWillPickUpOption\": \"ShipperWillDropOff\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n },\n {\n \"CarrierWillPickUpOption\": \"NoPreference\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n ],\n \"AvailableDeliveryExperienceOptions\": [\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithSignature\"\n },\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithoutSignature\"\n }\n ]\n },\n \"AvailableLabelFormats\": [\n \"ZPL300\",\n \"ShippingServiceDefault\"\n ],\n \"AvailableFormatOptionsForLabel\": [\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"ZPL203\"\n },\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"PDF\"\n }\n ]\n },\n \"Status\": \"RefundApplied\",\n \"Weight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"SellerOrderId\": \"<string>\",\n \"TrackingId\": \"<string>\",\n \"LastUpdatedDate\": \"<dateTime>\"\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": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/mfn/v0/shipments/:shipmentId/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"mfn",
"v0",
"shipments",
":shipmentId",
"cancel"
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"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 \"AmazonOrderId\": \"<string>\",\n \"CreatedDate\": \"<dateTime>\",\n \"Insurance\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"ItemList\": [\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n },\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n }\n ],\n \"Label\": {\n \"Dimensions\": {\n \"Length\": \"<number>\",\n \"Unit\": \"inches\",\n \"Width\": \"<number>\"\n },\n \"FileContents\": {\n \"Checksum\": \"<string>\",\n \"Contents\": \"<string>\",\n \"FileType\": \"image/png\"\n },\n \"CustomTextForLabel\": \"<string>\",\n \"LabelFormat\": \"PDF\",\n \"StandardIdForLabel\": \"AmazonOrderId\"\n },\n \"PackageDimensions\": {\n \"Length\": \"<double>\",\n \"Width\": \"<double>\",\n \"Height\": \"<double>\",\n \"Unit\": \"centimeters\",\n \"PredefinedPackageDimensions\": \"USPS_Flat\"\n },\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipToAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShippingService\": {\n \"CarrierName\": \"<string>\",\n \"Rate\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"RequiresAdditionalSellerInputs\": \"<boolean>\",\n \"ShipDate\": \"<dateTime>\",\n \"ShippingServiceId\": \"<string>\",\n \"ShippingServiceName\": \"<string>\",\n \"ShippingServiceOfferId\": \"<string>\",\n \"ShippingServiceOptions\": {\n \"CarrierWillPickUp\": \"<boolean>\",\n \"DeliveryExperience\": \"NoTracking\",\n \"DeclaredValue\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"CarrierWillPickUpOption\": \"CarrierWillPickUp\",\n \"LabelFormat\": \"PDF\"\n },\n \"EarliestEstimatedDeliveryDate\": \"<dateTime>\",\n \"LatestEstimatedDeliveryDate\": \"<dateTime>\",\n \"AvailableShippingServiceOptions\": {\n \"AvailableCarrierWillPickUpOptions\": [\n {\n \"CarrierWillPickUpOption\": \"ShipperWillDropOff\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n },\n {\n \"CarrierWillPickUpOption\": \"NoPreference\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n ],\n \"AvailableDeliveryExperienceOptions\": [\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithSignature\"\n },\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithoutSignature\"\n }\n ]\n },\n \"AvailableLabelFormats\": [\n \"ZPL300\",\n \"ShippingServiceDefault\"\n ],\n \"AvailableFormatOptionsForLabel\": [\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"ZPL203\"\n },\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"PDF\"\n }\n ]\n },\n \"Status\": \"RefundApplied\",\n \"Weight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"SellerOrderId\": \"<string>\",\n \"TrackingId\": \"<string>\",\n \"LastUpdatedDate\": \"<dateTime>\"\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": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/mfn/v0/shipments/:shipmentId/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"mfn",
"v0",
"shipments",
":shipmentId",
"cancel"
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"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 \"AmazonOrderId\": \"<string>\",\n \"CreatedDate\": \"<dateTime>\",\n \"Insurance\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"ItemList\": [\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n },\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n }\n ],\n \"Label\": {\n \"Dimensions\": {\n \"Length\": \"<number>\",\n \"Unit\": \"inches\",\n \"Width\": \"<number>\"\n },\n \"FileContents\": {\n \"Checksum\": \"<string>\",\n \"Contents\": \"<string>\",\n \"FileType\": \"image/png\"\n },\n \"CustomTextForLabel\": \"<string>\",\n \"LabelFormat\": \"PDF\",\n \"StandardIdForLabel\": \"AmazonOrderId\"\n },\n \"PackageDimensions\": {\n \"Length\": \"<double>\",\n \"Width\": \"<double>\",\n \"Height\": \"<double>\",\n \"Unit\": \"centimeters\",\n \"PredefinedPackageDimensions\": \"USPS_Flat\"\n },\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipToAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShippingService\": {\n \"CarrierName\": \"<string>\",\n \"Rate\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"RequiresAdditionalSellerInputs\": \"<boolean>\",\n \"ShipDate\": \"<dateTime>\",\n \"ShippingServiceId\": \"<string>\",\n \"ShippingServiceName\": \"<string>\",\n \"ShippingServiceOfferId\": \"<string>\",\n \"ShippingServiceOptions\": {\n \"CarrierWillPickUp\": \"<boolean>\",\n \"DeliveryExperience\": \"NoTracking\",\n \"DeclaredValue\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"CarrierWillPickUpOption\": \"CarrierWillPickUp\",\n \"LabelFormat\": \"PDF\"\n },\n \"EarliestEstimatedDeliveryDate\": \"<dateTime>\",\n \"LatestEstimatedDeliveryDate\": \"<dateTime>\",\n \"AvailableShippingServiceOptions\": {\n \"AvailableCarrierWillPickUpOptions\": [\n {\n \"CarrierWillPickUpOption\": \"ShipperWillDropOff\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n },\n {\n \"CarrierWillPickUpOption\": \"NoPreference\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n ],\n \"AvailableDeliveryExperienceOptions\": [\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithSignature\"\n },\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithoutSignature\"\n }\n ]\n },\n \"AvailableLabelFormats\": [\n \"ZPL300\",\n \"ShippingServiceDefault\"\n ],\n \"AvailableFormatOptionsForLabel\": [\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"ZPL203\"\n },\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"PDF\"\n }\n ]\n },\n \"Status\": \"RefundApplied\",\n \"Weight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"SellerOrderId\": \"<string>\",\n \"TrackingId\": \"<string>\",\n \"LastUpdatedDate\": \"<dateTime>\"\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": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/mfn/v0/shipments/:shipmentId/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"mfn",
"v0",
"shipments",
":shipmentId",
"cancel"
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"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 \"AmazonOrderId\": \"<string>\",\n \"CreatedDate\": \"<dateTime>\",\n \"Insurance\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"ItemList\": [\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n },\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n }\n ],\n \"Label\": {\n \"Dimensions\": {\n \"Length\": \"<number>\",\n \"Unit\": \"inches\",\n \"Width\": \"<number>\"\n },\n \"FileContents\": {\n \"Checksum\": \"<string>\",\n \"Contents\": \"<string>\",\n \"FileType\": \"image/png\"\n },\n \"CustomTextForLabel\": \"<string>\",\n \"LabelFormat\": \"PDF\",\n \"StandardIdForLabel\": \"AmazonOrderId\"\n },\n \"PackageDimensions\": {\n \"Length\": \"<double>\",\n \"Width\": \"<double>\",\n \"Height\": \"<double>\",\n \"Unit\": \"centimeters\",\n \"PredefinedPackageDimensions\": \"USPS_Flat\"\n },\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipToAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShippingService\": {\n \"CarrierName\": \"<string>\",\n \"Rate\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"RequiresAdditionalSellerInputs\": \"<boolean>\",\n \"ShipDate\": \"<dateTime>\",\n \"ShippingServiceId\": \"<string>\",\n \"ShippingServiceName\": \"<string>\",\n \"ShippingServiceOfferId\": \"<string>\",\n \"ShippingServiceOptions\": {\n \"CarrierWillPickUp\": \"<boolean>\",\n \"DeliveryExperience\": \"NoTracking\",\n \"DeclaredValue\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"CarrierWillPickUpOption\": \"CarrierWillPickUp\",\n \"LabelFormat\": \"PDF\"\n },\n \"EarliestEstimatedDeliveryDate\": \"<dateTime>\",\n \"LatestEstimatedDeliveryDate\": \"<dateTime>\",\n \"AvailableShippingServiceOptions\": {\n \"AvailableCarrierWillPickUpOptions\": [\n {\n \"CarrierWillPickUpOption\": \"ShipperWillDropOff\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n },\n {\n \"CarrierWillPickUpOption\": \"NoPreference\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n ],\n \"AvailableDeliveryExperienceOptions\": [\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithSignature\"\n },\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithoutSignature\"\n }\n ]\n },\n \"AvailableLabelFormats\": [\n \"ZPL300\",\n \"ShippingServiceDefault\"\n ],\n \"AvailableFormatOptionsForLabel\": [\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"ZPL203\"\n },\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"PDF\"\n }\n ]\n },\n \"Status\": \"RefundApplied\",\n \"Weight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"SellerOrderId\": \"<string>\",\n \"TrackingId\": \"<string>\",\n \"LastUpdatedDate\": \"<dateTime>\"\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": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/mfn/v0/shipments/:shipmentId/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"mfn",
"v0",
"shipments",
":shipmentId",
"cancel"
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"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 \"AmazonOrderId\": \"<string>\",\n \"CreatedDate\": \"<dateTime>\",\n \"Insurance\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"ItemList\": [\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n },\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n }\n ],\n \"Label\": {\n \"Dimensions\": {\n \"Length\": \"<number>\",\n \"Unit\": \"inches\",\n \"Width\": \"<number>\"\n },\n \"FileContents\": {\n \"Checksum\": \"<string>\",\n \"Contents\": \"<string>\",\n \"FileType\": \"image/png\"\n },\n \"CustomTextForLabel\": \"<string>\",\n \"LabelFormat\": \"PDF\",\n \"StandardIdForLabel\": \"AmazonOrderId\"\n },\n \"PackageDimensions\": {\n \"Length\": \"<double>\",\n \"Width\": \"<double>\",\n \"Height\": \"<double>\",\n \"Unit\": \"centimeters\",\n \"PredefinedPackageDimensions\": \"USPS_Flat\"\n },\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipToAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShippingService\": {\n \"CarrierName\": \"<string>\",\n \"Rate\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"RequiresAdditionalSellerInputs\": \"<boolean>\",\n \"ShipDate\": \"<dateTime>\",\n \"ShippingServiceId\": \"<string>\",\n \"ShippingServiceName\": \"<string>\",\n \"ShippingServiceOfferId\": \"<string>\",\n \"ShippingServiceOptions\": {\n \"CarrierWillPickUp\": \"<boolean>\",\n \"DeliveryExperience\": \"NoTracking\",\n \"DeclaredValue\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"CarrierWillPickUpOption\": \"CarrierWillPickUp\",\n \"LabelFormat\": \"PDF\"\n },\n \"EarliestEstimatedDeliveryDate\": \"<dateTime>\",\n \"LatestEstimatedDeliveryDate\": \"<dateTime>\",\n \"AvailableShippingServiceOptions\": {\n \"AvailableCarrierWillPickUpOptions\": [\n {\n \"CarrierWillPickUpOption\": \"ShipperWillDropOff\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n },\n {\n \"CarrierWillPickUpOption\": \"NoPreference\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n ],\n \"AvailableDeliveryExperienceOptions\": [\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithSignature\"\n },\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithoutSignature\"\n }\n ]\n },\n \"AvailableLabelFormats\": [\n \"ZPL300\",\n \"ShippingServiceDefault\"\n ],\n \"AvailableFormatOptionsForLabel\": [\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"ZPL203\"\n },\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"PDF\"\n }\n ]\n },\n \"Status\": \"RefundApplied\",\n \"Weight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"SellerOrderId\": \"<string>\",\n \"TrackingId\": \"<string>\",\n \"LastUpdatedDate\": \"<dateTime>\"\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": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/mfn/v0/shipments/:shipmentId/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"mfn",
"v0",
"shipments",
":shipmentId",
"cancel"
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"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 \"AmazonOrderId\": \"<string>\",\n \"CreatedDate\": \"<dateTime>\",\n \"Insurance\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"ItemList\": [\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n },\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n }\n ],\n \"Label\": {\n \"Dimensions\": {\n \"Length\": \"<number>\",\n \"Unit\": \"inches\",\n \"Width\": \"<number>\"\n },\n \"FileContents\": {\n \"Checksum\": \"<string>\",\n \"Contents\": \"<string>\",\n \"FileType\": \"image/png\"\n },\n \"CustomTextForLabel\": \"<string>\",\n \"LabelFormat\": \"PDF\",\n \"StandardIdForLabel\": \"AmazonOrderId\"\n },\n \"PackageDimensions\": {\n \"Length\": \"<double>\",\n \"Width\": \"<double>\",\n \"Height\": \"<double>\",\n \"Unit\": \"centimeters\",\n \"PredefinedPackageDimensions\": \"USPS_Flat\"\n },\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipToAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShippingService\": {\n \"CarrierName\": \"<string>\",\n \"Rate\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"RequiresAdditionalSellerInputs\": \"<boolean>\",\n \"ShipDate\": \"<dateTime>\",\n \"ShippingServiceId\": \"<string>\",\n \"ShippingServiceName\": \"<string>\",\n \"ShippingServiceOfferId\": \"<string>\",\n \"ShippingServiceOptions\": {\n \"CarrierWillPickUp\": \"<boolean>\",\n \"DeliveryExperience\": \"NoTracking\",\n \"DeclaredValue\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"CarrierWillPickUpOption\": \"CarrierWillPickUp\",\n \"LabelFormat\": \"PDF\"\n },\n \"EarliestEstimatedDeliveryDate\": \"<dateTime>\",\n \"LatestEstimatedDeliveryDate\": \"<dateTime>\",\n \"AvailableShippingServiceOptions\": {\n \"AvailableCarrierWillPickUpOptions\": [\n {\n \"CarrierWillPickUpOption\": \"ShipperWillDropOff\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n },\n {\n \"CarrierWillPickUpOption\": \"NoPreference\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n ],\n \"AvailableDeliveryExperienceOptions\": [\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithSignature\"\n },\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithoutSignature\"\n }\n ]\n },\n \"AvailableLabelFormats\": [\n \"ZPL300\",\n \"ShippingServiceDefault\"\n ],\n \"AvailableFormatOptionsForLabel\": [\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"ZPL203\"\n },\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"PDF\"\n }\n ]\n },\n \"Status\": \"RefundApplied\",\n \"Weight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"SellerOrderId\": \"<string>\",\n \"TrackingId\": \"<string>\",\n \"LastUpdatedDate\": \"<dateTime>\"\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": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/mfn/v0/shipments/:shipmentId/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"mfn",
"v0",
"shipments",
":shipmentId",
"cancel"
],
"variable": [
{
"key": "shipmentId"
}
]
}
},
"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 \"AmazonOrderId\": \"<string>\",\n \"CreatedDate\": \"<dateTime>\",\n \"Insurance\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"ItemList\": [\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n },\n {\n \"OrderItemId\": \"<string>\",\n \"Quantity\": \"<integer>\",\n \"ItemWeight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"ItemDescription\": \"<string>\",\n \"TransparencyCodeList\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ItemLevelSellerInputsList\": [\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"inches\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n },\n {\n \"AdditionalInputFieldName\": \"<string>\",\n \"AdditionalSellerInput\": {\n \"DataType\": \"<string>\",\n \"ValueAsString\": \"<string>\",\n \"ValueAsBoolean\": \"<boolean>\",\n \"ValueAsInteger\": \"<integer>\",\n \"ValueAsTimestamp\": \"<dateTime>\",\n \"ValueAsAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ValueAsWeight\": {\n \"Unit\": \"oz\",\n \"Value\": \"<double>\"\n },\n \"ValueAsDimension\": {\n \"value\": \"<number>\",\n \"unit\": \"centimeters\"\n },\n \"ValueAsCurrency\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n }\n ]\n }\n ],\n \"Label\": {\n \"Dimensions\": {\n \"Length\": \"<number>\",\n \"Unit\": \"inches\",\n \"Width\": \"<number>\"\n },\n \"FileContents\": {\n \"Checksum\": \"<string>\",\n \"Contents\": \"<string>\",\n \"FileType\": \"image/png\"\n },\n \"CustomTextForLabel\": \"<string>\",\n \"LabelFormat\": \"PDF\",\n \"StandardIdForLabel\": \"AmazonOrderId\"\n },\n \"PackageDimensions\": {\n \"Length\": \"<double>\",\n \"Width\": \"<double>\",\n \"Height\": \"<double>\",\n \"Unit\": \"centimeters\",\n \"PredefinedPackageDimensions\": \"USPS_Flat\"\n },\n \"ShipFromAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipToAddress\": {\n \"AddressLine1\": \"<string>\",\n \"City\": \"<string>\",\n \"CountryCode\": \"<string>\",\n \"Email\": \"<string>\",\n \"Name\": \"<string>\",\n \"Phone\": \"<string>\",\n \"PostalCode\": \"<string>\",\n \"AddressLine2\": \"<string>\",\n \"AddressLine3\": \"<string>\",\n \"DistrictOrCounty\": \"<string>\",\n \"StateOrProvinceCode\": \"<string>\"\n },\n \"ShipmentId\": \"<string>\",\n \"ShippingService\": {\n \"CarrierName\": \"<string>\",\n \"Rate\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"RequiresAdditionalSellerInputs\": \"<boolean>\",\n \"ShipDate\": \"<dateTime>\",\n \"ShippingServiceId\": \"<string>\",\n \"ShippingServiceName\": \"<string>\",\n \"ShippingServiceOfferId\": \"<string>\",\n \"ShippingServiceOptions\": {\n \"CarrierWillPickUp\": \"<boolean>\",\n \"DeliveryExperience\": \"NoTracking\",\n \"DeclaredValue\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"CarrierWillPickUpOption\": \"CarrierWillPickUp\",\n \"LabelFormat\": \"PDF\"\n },\n \"EarliestEstimatedDeliveryDate\": \"<dateTime>\",\n \"LatestEstimatedDeliveryDate\": \"<dateTime>\",\n \"AvailableShippingServiceOptions\": {\n \"AvailableCarrierWillPickUpOptions\": [\n {\n \"CarrierWillPickUpOption\": \"ShipperWillDropOff\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n },\n {\n \"CarrierWillPickUpOption\": \"NoPreference\",\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n }\n }\n ],\n \"AvailableDeliveryExperienceOptions\": [\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithSignature\"\n },\n {\n \"Charge\": {\n \"Amount\": \"<double>\",\n \"CurrencyCode\": \"<string>\"\n },\n \"DeliveryExperienceOption\": \"DeliveryConfirmationWithoutSignature\"\n }\n ]\n },\n \"AvailableLabelFormats\": [\n \"ZPL300\",\n \"ShippingServiceDefault\"\n ],\n \"AvailableFormatOptionsForLabel\": [\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"ZPL203\"\n },\n {\n \"IncludePackingSlipWithLabel\": \"<boolean>\",\n \"LabelFormat\": \"PDF\"\n }\n ]\n },\n \"Status\": \"RefundApplied\",\n \"Weight\": {\n \"Unit\": \"g\",\n \"Value\": \"<double>\"\n },\n \"SellerOrderId\": \"<string>\",\n \"TrackingId\": \"<string>\",\n \"LastUpdatedDate\": \"<dateTime>\"\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}"
}
]
}
