Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Chilkat.Http http = new Chilkat.Http();
bool success;
http.SetRequestHeader("Accept","application/json");
Chilkat.HttpResponse resp = http.QuickRequest("PUT","https://sellingpartnerapi-na.amazon.com/mfn/v0/shipments/:shipmentId/cancel");
if (http.LastMethodSuccess == false) {
Debug.WriteLine(http.LastErrorText);
return;
}
Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());
int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
Debug.WriteLine("Response Header:");
Debug.WriteLine(resp.Header);
Debug.WriteLine("Failed.");
return;
}
// 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
string OrderItemId;
string Quantity;
string ItemWeightUnit;
string ItemWeightValue;
string ItemDescription;
int j;
int count_j;
string strVal;
string AdditionalInputFieldName;
string DataType;
string ValueAsString;
string ValueAsBoolean;
string ValueAsInteger;
string ValueAsTimestamp;
string ValueAsAddressAddressLine1;
string ValueAsAddressCity;
string ValueAsAddressCountryCode;
string ValueAsAddressEmail;
string ValueAsAddressName;
string ValueAsAddressPhone;
string ValueAsAddressPostalCode;
string ValueAsAddressAddressLine2;
string ValueAsAddressAddressLine3;
string ValueAsAddressDistrictOrCounty;
string ValueAsAddressStateOrProvinceCode;
string ValueAsWeightUnit;
string ValueAsWeightValue;
string ValueAsDimensionValue;
string ValueAsDimensionUnit;
string ValueAsCurrencyAmount;
string ValueAsCurrencyCurrencyCode;
string ChargeAmount;
string ChargeCurrencyCode;
string DeliveryExperienceOption;
string IncludePackingSlipWithLabel;
string code;
string message;
string details;
string AmazonOrderId = jResp.StringOf("payload.AmazonOrderId");
string CreatedDate = jResp.StringOf("payload.CreatedDate");
string Amount = jResp.StringOf("payload.Insurance.Amount");
string CurrencyCode = jResp.StringOf("payload.Insurance.CurrencyCode");
string Length = jResp.StringOf("payload.Label.Dimensions.Length");
string Unit = jResp.StringOf("payload.Label.Dimensions.Unit");
string Width = jResp.StringOf("payload.Label.Dimensions.Width");
string Checksum = jResp.StringOf("payload.Label.FileContents.Checksum");
string Contents = jResp.StringOf("payload.Label.FileContents.Contents");
string FileType = jResp.StringOf("payload.Label.FileContents.FileType");
string CustomTextForLabel = jResp.StringOf("payload.Label.CustomTextForLabel");
string LabelFormat = jResp.StringOf("payload.Label.LabelFormat");
string StandardIdForLabel = jResp.StringOf("payload.Label.StandardIdForLabel");
string PackageDimensionsLength = jResp.StringOf("payload.PackageDimensions.Length");
string PackageDimensionsWidth = jResp.StringOf("payload.PackageDimensions.Width");
string Height = jResp.StringOf("payload.PackageDimensions.Height");
string PackageDimensionsUnit = jResp.StringOf("payload.PackageDimensions.Unit");
string PredefinedPackageDimensions = jResp.StringOf("payload.PackageDimensions.PredefinedPackageDimensions");
string AddressLine1 = jResp.StringOf("payload.ShipFromAddress.AddressLine1");
string City = jResp.StringOf("payload.ShipFromAddress.City");
string CountryCode = jResp.StringOf("payload.ShipFromAddress.CountryCode");
string v_Email = jResp.StringOf("payload.ShipFromAddress.Email");
string Name = jResp.StringOf("payload.ShipFromAddress.Name");
string Phone = jResp.StringOf("payload.ShipFromAddress.Phone");
string PostalCode = jResp.StringOf("payload.ShipFromAddress.PostalCode");
string AddressLine2 = jResp.StringOf("payload.ShipFromAddress.AddressLine2");
string AddressLine3 = jResp.StringOf("payload.ShipFromAddress.AddressLine3");
string DistrictOrCounty = jResp.StringOf("payload.ShipFromAddress.DistrictOrCounty");
string StateOrProvinceCode = jResp.StringOf("payload.ShipFromAddress.StateOrProvinceCode");
string ShipToAddressAddressLine1 = jResp.StringOf("payload.ShipToAddress.AddressLine1");
string ShipToAddressCity = jResp.StringOf("payload.ShipToAddress.City");
string ShipToAddressCountryCode = jResp.StringOf("payload.ShipToAddress.CountryCode");
string ShipToAddressEmail = jResp.StringOf("payload.ShipToAddress.Email");
string ShipToAddressName = jResp.StringOf("payload.ShipToAddress.Name");
string ShipToAddressPhone = jResp.StringOf("payload.ShipToAddress.Phone");
string ShipToAddressPostalCode = jResp.StringOf("payload.ShipToAddress.PostalCode");
string ShipToAddressAddressLine2 = jResp.StringOf("payload.ShipToAddress.AddressLine2");
string ShipToAddressAddressLine3 = jResp.StringOf("payload.ShipToAddress.AddressLine3");
string ShipToAddressDistrictOrCounty = jResp.StringOf("payload.ShipToAddress.DistrictOrCounty");
string ShipToAddressStateOrProvinceCode = jResp.StringOf("payload.ShipToAddress.StateOrProvinceCode");
string ShipmentId = jResp.StringOf("payload.ShipmentId");
string CarrierName = jResp.StringOf("payload.ShippingService.CarrierName");
string RateAmount = jResp.StringOf("payload.ShippingService.Rate.Amount");
string RateCurrencyCode = jResp.StringOf("payload.ShippingService.Rate.CurrencyCode");
string RequiresAdditionalSellerInputs = jResp.StringOf("payload.ShippingService.RequiresAdditionalSellerInputs");
string ShipDate = jResp.StringOf("payload.ShippingService.ShipDate");
string ShippingServiceId = jResp.StringOf("payload.ShippingService.ShippingServiceId");
string ShippingServiceName = jResp.StringOf("payload.ShippingService.ShippingServiceName");
string ShippingServiceOfferId = jResp.StringOf("payload.ShippingService.ShippingServiceOfferId");
string CarrierWillPickUp = jResp.StringOf("payload.ShippingService.ShippingServiceOptions.CarrierWillPickUp");
string DeliveryExperience = jResp.StringOf("payload.ShippingService.ShippingServiceOptions.DeliveryExperience");
string DeclaredValueAmount = jResp.StringOf("payload.ShippingService.ShippingServiceOptions.DeclaredValue.Amount");
string DeclaredValueCurrencyCode = jResp.StringOf("payload.ShippingService.ShippingServiceOptions.DeclaredValue.CurrencyCode");
string CarrierWillPickUpOption = jResp.StringOf("payload.ShippingService.ShippingServiceOptions.CarrierWillPickUpOption");
string ShippingServiceOptionsLabelFormat = jResp.StringOf("payload.ShippingService.ShippingServiceOptions.LabelFormat");
string EarliestEstimatedDeliveryDate = jResp.StringOf("payload.ShippingService.EarliestEstimatedDeliveryDate");
string LatestEstimatedDeliveryDate = jResp.StringOf("payload.ShippingService.LatestEstimatedDeliveryDate");
string Status = jResp.StringOf("payload.Status");
string WeightUnit = jResp.StringOf("payload.Weight.Unit");
string Value = jResp.StringOf("payload.Weight.Value");
string SellerOrderId = jResp.StringOf("payload.SellerOrderId");
string TrackingId = jResp.StringOf("payload.TrackingId");
string LastUpdatedDate = jResp.StringOf("payload.LastUpdatedDate");
int i = 0;
int count_i = jResp.SizeOfArray("payload.ItemList");
while (i < count_i) {
jResp.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.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.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.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.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.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.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.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}"
}
]
}