Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
$http->SetRequestHeader("Accept","application/json");
# resp is a HttpResponse
$resp = $http->QuickRequest("PUT","https://sellingpartnerapi-na.amazon.com/mfn/v0/shipments/:shipmentId/cancel");
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# 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
$AmazonOrderId = $jResp->stringOf("payload.AmazonOrderId");
$CreatedDate = $jResp->stringOf("payload.CreatedDate");
$Amount = $jResp->stringOf("payload.Insurance.Amount");
$CurrencyCode = $jResp->stringOf("payload.Insurance.CurrencyCode");
$Length = $jResp->stringOf("payload.Label.Dimensions.Length");
$Unit = $jResp->stringOf("payload.Label.Dimensions.Unit");
$Width = $jResp->stringOf("payload.Label.Dimensions.Width");
$Checksum = $jResp->stringOf("payload.Label.FileContents.Checksum");
$Contents = $jResp->stringOf("payload.Label.FileContents.Contents");
$FileType = $jResp->stringOf("payload.Label.FileContents.FileType");
$CustomTextForLabel = $jResp->stringOf("payload.Label.CustomTextForLabel");
$LabelFormat = $jResp->stringOf("payload.Label.LabelFormat");
$StandardIdForLabel = $jResp->stringOf("payload.Label.StandardIdForLabel");
$PackageDimensionsLength = $jResp->stringOf("payload.PackageDimensions.Length");
$PackageDimensionsWidth = $jResp->stringOf("payload.PackageDimensions.Width");
$Height = $jResp->stringOf("payload.PackageDimensions.Height");
$PackageDimensionsUnit = $jResp->stringOf("payload.PackageDimensions.Unit");
$PredefinedPackageDimensions = $jResp->stringOf("payload.PackageDimensions.PredefinedPackageDimensions");
$AddressLine1 = $jResp->stringOf("payload.ShipFromAddress.AddressLine1");
$City = $jResp->stringOf("payload.ShipFromAddress.City");
$CountryCode = $jResp->stringOf("payload.ShipFromAddress.CountryCode");
$v_Email = $jResp->stringOf("payload.ShipFromAddress.Email");
$Name = $jResp->stringOf("payload.ShipFromAddress.Name");
$Phone = $jResp->stringOf("payload.ShipFromAddress.Phone");
$PostalCode = $jResp->stringOf("payload.ShipFromAddress.PostalCode");
$AddressLine2 = $jResp->stringOf("payload.ShipFromAddress.AddressLine2");
$AddressLine3 = $jResp->stringOf("payload.ShipFromAddress.AddressLine3");
$DistrictOrCounty = $jResp->stringOf("payload.ShipFromAddress.DistrictOrCounty");
$StateOrProvinceCode = $jResp->stringOf("payload.ShipFromAddress.StateOrProvinceCode");
$ShipToAddressAddressLine1 = $jResp->stringOf("payload.ShipToAddress.AddressLine1");
$ShipToAddressCity = $jResp->stringOf("payload.ShipToAddress.City");
$ShipToAddressCountryCode = $jResp->stringOf("payload.ShipToAddress.CountryCode");
$ShipToAddressEmail = $jResp->stringOf("payload.ShipToAddress.Email");
$ShipToAddressName = $jResp->stringOf("payload.ShipToAddress.Name");
$ShipToAddressPhone = $jResp->stringOf("payload.ShipToAddress.Phone");
$ShipToAddressPostalCode = $jResp->stringOf("payload.ShipToAddress.PostalCode");
$ShipToAddressAddressLine2 = $jResp->stringOf("payload.ShipToAddress.AddressLine2");
$ShipToAddressAddressLine3 = $jResp->stringOf("payload.ShipToAddress.AddressLine3");
$ShipToAddressDistrictOrCounty = $jResp->stringOf("payload.ShipToAddress.DistrictOrCounty");
$ShipToAddressStateOrProvinceCode = $jResp->stringOf("payload.ShipToAddress.StateOrProvinceCode");
$ShipmentId = $jResp->stringOf("payload.ShipmentId");
$CarrierName = $jResp->stringOf("payload.ShippingService.CarrierName");
$RateAmount = $jResp->stringOf("payload.ShippingService.Rate.Amount");
$RateCurrencyCode = $jResp->stringOf("payload.ShippingService.Rate.CurrencyCode");
$RequiresAdditionalSellerInputs = $jResp->stringOf("payload.ShippingService.RequiresAdditionalSellerInputs");
$ShipDate = $jResp->stringOf("payload.ShippingService.ShipDate");
$ShippingServiceId = $jResp->stringOf("payload.ShippingService.ShippingServiceId");
$ShippingServiceName = $jResp->stringOf("payload.ShippingService.ShippingServiceName");
$ShippingServiceOfferId = $jResp->stringOf("payload.ShippingService.ShippingServiceOfferId");
$CarrierWillPickUp = $jResp->stringOf("payload.ShippingService.ShippingServiceOptions.CarrierWillPickUp");
$DeliveryExperience = $jResp->stringOf("payload.ShippingService.ShippingServiceOptions.DeliveryExperience");
$DeclaredValueAmount = $jResp->stringOf("payload.ShippingService.ShippingServiceOptions.DeclaredValue.Amount");
$DeclaredValueCurrencyCode = $jResp->stringOf("payload.ShippingService.ShippingServiceOptions.DeclaredValue.CurrencyCode");
$CarrierWillPickUpOption = $jResp->stringOf("payload.ShippingService.ShippingServiceOptions.CarrierWillPickUpOption");
$ShippingServiceOptionsLabelFormat = $jResp->stringOf("payload.ShippingService.ShippingServiceOptions.LabelFormat");
$EarliestEstimatedDeliveryDate = $jResp->stringOf("payload.ShippingService.EarliestEstimatedDeliveryDate");
$LatestEstimatedDeliveryDate = $jResp->stringOf("payload.ShippingService.LatestEstimatedDeliveryDate");
$Status = $jResp->stringOf("payload.Status");
$WeightUnit = $jResp->stringOf("payload.Weight.Unit");
$Value = $jResp->stringOf("payload.Weight.Value");
$SellerOrderId = $jResp->stringOf("payload.SellerOrderId");
$TrackingId = $jResp->stringOf("payload.TrackingId");
$LastUpdatedDate = $jResp->stringOf("payload.LastUpdatedDate");
$i = 0;
$count_i = $jResp->SizeOfArray("payload.ItemList");
while ($i < $count_i) {
$jResp->put_I($i);
$OrderItemId = $jResp->stringOf("payload.ItemList[i].OrderItemId");
$Quantity = $jResp->stringOf("payload.ItemList[i].Quantity");
$ItemWeightUnit = $jResp->stringOf("payload.ItemList[i].ItemWeight.Unit");
$ItemWeightValue = $jResp->stringOf("payload.ItemList[i].ItemWeight.Value");
$ItemDescription = $jResp->stringOf("payload.ItemList[i].ItemDescription");
$j = 0;
$count_j = $jResp->SizeOfArray("payload.ItemList[i].TransparencyCodeList");
while ($j < $count_j) {
$jResp->put_J($j);
$strVal = $jResp->stringOf("payload.ItemList[i].TransparencyCodeList[j]");
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray("payload.ItemList[i].ItemLevelSellerInputsList");
while ($j < $count_j) {
$jResp->put_J($j);
$AdditionalInputFieldName = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalInputFieldName");
$DataType = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.DataType");
$ValueAsString = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsString");
$ValueAsBoolean = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsBoolean");
$ValueAsInteger = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsInteger");
$ValueAsTimestamp = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsTimestamp");
$ValueAsAddressAddressLine1 = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.AddressLine1");
$ValueAsAddressCity = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.City");
$ValueAsAddressCountryCode = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.CountryCode");
$ValueAsAddressEmail = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.Email");
$ValueAsAddressName = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.Name");
$ValueAsAddressPhone = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.Phone");
$ValueAsAddressPostalCode = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.PostalCode");
$ValueAsAddressAddressLine2 = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.AddressLine2");
$ValueAsAddressAddressLine3 = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.AddressLine3");
$ValueAsAddressDistrictOrCounty = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.DistrictOrCounty");
$ValueAsAddressStateOrProvinceCode = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsAddress.StateOrProvinceCode");
$ValueAsWeightUnit = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsWeight.Unit");
$ValueAsWeightValue = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsWeight.Value");
$ValueAsDimensionValue = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsDimension.value");
$ValueAsDimensionUnit = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsDimension.unit");
$ValueAsCurrencyAmount = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsCurrency.Amount");
$ValueAsCurrencyCurrencyCode = $jResp->stringOf("payload.ItemList[i].ItemLevelSellerInputsList[j].AdditionalSellerInput.ValueAsCurrency.CurrencyCode");
$j = $j + 1;
}
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("payload.ShippingService.AvailableShippingServiceOptions.AvailableCarrierWillPickUpOptions");
while ($i < $count_i) {
$jResp->put_I($i);
$CarrierWillPickUpOption = $jResp->stringOf("payload.ShippingService.AvailableShippingServiceOptions.AvailableCarrierWillPickUpOptions[i].CarrierWillPickUpOption");
$ChargeAmount = $jResp->stringOf("payload.ShippingService.AvailableShippingServiceOptions.AvailableCarrierWillPickUpOptions[i].Charge.Amount");
$ChargeCurrencyCode = $jResp->stringOf("payload.ShippingService.AvailableShippingServiceOptions.AvailableCarrierWillPickUpOptions[i].Charge.CurrencyCode");
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("payload.ShippingService.AvailableShippingServiceOptions.AvailableDeliveryExperienceOptions");
while ($i < $count_i) {
$jResp->put_I($i);
$ChargeAmount = $jResp->stringOf("payload.ShippingService.AvailableShippingServiceOptions.AvailableDeliveryExperienceOptions[i].Charge.Amount");
$ChargeCurrencyCode = $jResp->stringOf("payload.ShippingService.AvailableShippingServiceOptions.AvailableDeliveryExperienceOptions[i].Charge.CurrencyCode");
$DeliveryExperienceOption = $jResp->stringOf("payload.ShippingService.AvailableShippingServiceOptions.AvailableDeliveryExperienceOptions[i].DeliveryExperienceOption");
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("payload.ShippingService.AvailableLabelFormats");
while ($i < $count_i) {
$jResp->put_I($i);
$strVal = $jResp->stringOf("payload.ShippingService.AvailableLabelFormats[i]");
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("payload.ShippingService.AvailableFormatOptionsForLabel");
while ($i < $count_i) {
$jResp->put_I($i);
$IncludePackingSlipWithLabel = $jResp->stringOf("payload.ShippingService.AvailableFormatOptionsForLabel[i].IncludePackingSlipWithLabel");
$LabelFormat = $jResp->stringOf("payload.ShippingService.AvailableFormatOptionsForLabel[i].LabelFormat");
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("errors");
while ($i < $count_i) {
$jResp->put_I($i);
$code = $jResp->stringOf("errors[i].code");
$message = $jResp->stringOf("errors[i].message");
$details = $jResp->stringOf("errors[i].details");
$i = $i + 1;
}
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}"
}
]
}