- Overview
- Authorization Workflow
- Permissions
- Sandbox
- API Models
- Available API Models
- Request Apidog Access
- OPENAPI SPECIFICATION
- Research Docs
- Amazon Warehousing and Distribution
- Authorization
- Catalog Items
- Catalog [Deprecated]
- Definitions
- Easy Ship
- FBAInbound
- listInboundPlans
- createInboundPlan
- getInboundPlan
- listInboundPlanBoxes
- cancelInboundPlan
- listInboundPlanItems
- updateInboundPlanName
- listPackingGroupBoxes
- listPackingGroupItems
- setPackingInformation
- listPackingOptions
- generatePackingOptions
- confirmPackingOption
- listInboundPlanPallets
- listPlacementOptions
- generatePlacementOptions
- confirmPlacementOption
- getShipment
- listShipmentBoxes
- listShipmentContentUpdatePreviews
- generateShipmentContentUpdatePreviews
- getShipmentContentUpdatePreview
- confirmShipmentContentUpdatePreview
- getDeliveryChallanDocument
- listDeliveryWindowOptions
- generateDeliveryWindowOptions
- confirmDeliveryWindowOptions
- listShipmentItems
- updateShipmentName
- listShipmentPallets
- cancelSelfShipAppointment
- getSelfShipAppointmentSlots
- generateSelfShipAppointmentSlots
- scheduleSelfShipAppointment
- updateShipmentSourceAddress
- updateShipmentTrackingDetails
- listTransportationOptions
- generateTransportationOptions
- confirmTransportationOptions
- listItemComplianceDetails
- updateItemComplianceDetails
- createMarketplaceItemLabels
- listPrepDetails
- setPrepDetails
- getInboundOperationStatus
- getItemEligibilityPreview
- FBAInventory
- FBAOutbound
- Feeds
- Fees
- Finance
- Invoices [Brazil]
- Listings Items
- Merchant Fulfillment
- Orders
- ProductPricing
- Reports
- Sales
- Sellers
- Service
- getServiceJobByServiceJobId
- cancelServiceJobByServiceJobId
- completeServiceJobByServiceJobId
- getServiceJobs
- addAppointmentForServiceJobByServiceJobId
- rescheduleAppointmentForServiceJobByServiceJobId
- assignAppointmentResources
- setAppointmentFulfillmentData
- getRangeSlotCapacity
- getFixedSlotCapacity
- updateSchedule
- createReservation
- updateReservation
- cancelReservation
- getAppointmmentSlotsByJobId
- getAppointmentSlots
- createServiceDocumentUploadDestination
- ShipmentInvoice[Brazil]
- Shipping
- getRates
- createShipment
- directPurchaseShipment
- getShipment
- purchaseShipment
- cancelShipment
- oneClickShipment
- purchaseLabels
- getTracking
- retrieveShippingLabel
- getShipmentDocuments
- purchaseShipment
- cancelShipment
- getRates
- getAdditionalInputs
- getAccount
- getCarrierAccountFormInputs
- getTrackingInformation
- getCarrierAccounts
- linkCarrierAccount
- unlinkCarrierAccount
- generateCollectionForm
- getCollectionFormHistory
- getUnmanifestedShipments
- getCollectionForm
- getAccessPoints
- Supply Sources
- Tokens
- Uploads
- Notifications
createShipment
POST
/mfn/v0/shipments
Last modified:2024-12-05 08:36:30
Maintainer:Not configured
| Rate (requests per second) | Burst |
|---|---|
| 2 | 2 |
x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the SP-API.Request
Body Params application/json
Example
{
"ShipmentRequestDetails": {
"AmazonOrderId": "string",
"SellerOrderId": "string",
"ItemList": [
{
"sku": "string",
"summaries": [
{
"marketplaceId": "string",
"asin": "string",
"productType": "string",
"conditionType": "new_new",
"status": [
"BUYABLE"
],
"fnSku": "string",
"itemName": "string",
"createdDate": "2019-08-24T14:15:22Z",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"mainImage": {
"link": "string",
"height": 0,
"width": 0
}
}
],
"attributes": {},
"issues": [
{
"code": "string",
"message": "string",
"severity": "ERROR",
"attributeNames": [
"string"
],
"categories": [
"INVALID_ATTRIBUTE"
],
"enforcements": {
"actions": [
{
"action": "LISTING_SUPPRESSED"
}
],
"exemption": {
"status": "EXEMPT",
"expiryDate": "2023-10-28T00:36:48.914Z"
}
}
}
],
"offers": [
{
"marketplaceId": "string",
"offerType": "B2C",
"price": {
"currencyCode": "string",
"amount": "string"
},
"points": {
"pointsNumber": 0,
"pointsMonetaryValue": {
"currencyCode": "string",
"amount": 0
}
},
"audience": {
"value": "ALL",
"displayName": "string"
}
}
],
"fulfillmentAvailability": [
{
"fulfillmentChannelCode": "string",
"quantity": 0
}
],
"procurement": [
{
"costPrice": {
"currencyCode": "string",
"amount": "string"
}
}
]
}
],
"ShipFromAddress": {
"addressLine1": "address_1",
"addressLine2": "address_2",
"addressLine3": "address_3",
"city": "Seattle",
"countryCode": "US",
"county": "Washington",
"district": "District1",
"name": "address_name",
"phoneNumber": "+14155552671",
"postalCode": "123456",
"stateOrRegion": "Washington"
},
"PackageDimensions": {
"height": 0,
"length": 0,
"unitOfMeasurement": "INCHES",
"width": 0
},
"Weight": {
"value": 11,
"unit": "Grams"
},
"MustArriveByDate": "2019-08-24T14:15:22Z",
"ShipDate": "2019-08-24T14:15:22Z",
"ShippingServiceOptions": {
"DeliveryExperience": "DeliveryConfirmationWithAdultSignature",
"DeclaredValue": {
"CurrencyCode": "str",
"Amount": 0
},
"CarrierWillPickUp": true,
"CarrierWillPickUpOption": "CarrierWillPickUp",
"LabelFormat": "PDF"
},
"LabelCustomization": {
"CustomTextForLabel": "string",
"StandardIdForLabel": "AmazonOrderId"
}
},
"ShippingServiceId": "string",
"ShippingServiceOfferId": "string",
"HazmatType": "None",
"LabelFormatOption": {
"IncludePackingSlipWithLabel": true
},
"ShipmentLevelSellerInputsList": [
{
"AdditionalInputFieldName": "string",
"AdditionalSellerInput": {
"DataType": "string",
"ValueAsString": "string",
"ValueAsBoolean": true,
"ValueAsInteger": 0,
"ValueAsTimestamp": "2019-08-24T14:15:22Z",
"ValueAsAddress": {
"addressLine1": "address_1",
"addressLine2": "address_2",
"addressLine3": "address_3",
"city": "Seattle",
"countryCode": "US",
"county": "Washington",
"district": "District1",
"name": "address_name",
"phoneNumber": "+14155552671",
"postalCode": "123456",
"stateOrRegion": "Washington"
},
"ValueAsWeight": {
"value": 11,
"unit": "Grams"
},
"ValueAsDimension": {
"value": 0,
"unit": "Cm"
},
"ValueAsCurrency": {
"CurrencyCode": "str",
"Amount": 0
}
}
}
]
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://sandbox.sellingpartnerapi-na.amazon.com/mfn/v0/shipments' \
--header 'Content-Type: application/json' \
--data-raw '{
"ShipmentRequestDetails": {
"AmazonOrderId": "string",
"SellerOrderId": "string",
"ItemList": [
{
"sku": "string",
"summaries": [
{
"marketplaceId": "string",
"asin": "string",
"productType": "string",
"conditionType": "new_new",
"status": [
"BUYABLE"
],
"fnSku": "string",
"itemName": "string",
"createdDate": "2019-08-24T14:15:22Z",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"mainImage": {
"link": "string",
"height": 0,
"width": 0
}
}
],
"attributes": {},
"issues": [
{
"code": "string",
"message": "string",
"severity": "ERROR",
"attributeNames": [
"string"
],
"categories": [
"INVALID_ATTRIBUTE"
],
"enforcements": {
"actions": [
{
"action": "LISTING_SUPPRESSED"
}
],
"exemption": {
"status": "EXEMPT",
"expiryDate": "2023-10-28T00:36:48.914Z"
}
}
}
],
"offers": [
{
"marketplaceId": "string",
"offerType": "B2C",
"price": {
"currencyCode": "string",
"amount": "string"
},
"points": {
"pointsNumber": 0,
"pointsMonetaryValue": {
"currencyCode": "string",
"amount": 0
}
},
"audience": {
"value": "ALL",
"displayName": "string"
}
}
],
"fulfillmentAvailability": [
{
"fulfillmentChannelCode": "string",
"quantity": 0
}
],
"procurement": [
{
"costPrice": {
"currencyCode": "string",
"amount": "string"
}
}
]
}
],
"ShipFromAddress": {
"addressLine1": "address_1",
"addressLine2": "address_2",
"addressLine3": "address_3",
"city": "Seattle",
"countryCode": "US",
"county": "Washington",
"district": "District1",
"name": "address_name",
"phoneNumber": "+14155552671",
"postalCode": "123456",
"stateOrRegion": "Washington"
},
"PackageDimensions": {
"height": 0,
"length": 0,
"unitOfMeasurement": "INCHES",
"width": 0
},
"Weight": {
"value": 11,
"unit": "Grams"
},
"MustArriveByDate": "2019-08-24T14:15:22Z",
"ShipDate": "2019-08-24T14:15:22Z",
"ShippingServiceOptions": {
"DeliveryExperience": "DeliveryConfirmationWithAdultSignature",
"DeclaredValue": {
"CurrencyCode": "str",
"Amount": 0
},
"CarrierWillPickUp": true,
"CarrierWillPickUpOption": "CarrierWillPickUp",
"LabelFormat": "PDF"
},
"LabelCustomization": {
"CustomTextForLabel": "string",
"StandardIdForLabel": "AmazonOrderId"
}
},
"ShippingServiceId": "string",
"ShippingServiceOfferId": "string",
"HazmatType": "None",
"LabelFormatOption": {
"IncludePackingSlipWithLabel": true
},
"ShipmentLevelSellerInputsList": [
{
"AdditionalInputFieldName": "string",
"AdditionalSellerInput": {
"DataType": "string",
"ValueAsString": "string",
"ValueAsBoolean": true,
"ValueAsInteger": 0,
"ValueAsTimestamp": "2019-08-24T14:15:22Z",
"ValueAsAddress": {
"addressLine1": "address_1",
"addressLine2": "address_2",
"addressLine3": "address_3",
"city": "Seattle",
"countryCode": "US",
"county": "Washington",
"district": "District1",
"name": "address_name",
"phoneNumber": "+14155552671",
"postalCode": "123456",
"stateOrRegion": "Washington"
},
"ValueAsWeight": {
"value": 11,
"unit": "Grams"
},
"ValueAsDimension": {
"value": 0,
"unit": "Cm"
},
"ValueAsCurrency": {
"CurrencyCode": "str",
"Amount": 0
}
}
}
]
}'Responses
🟢200OK
application/json
Headers
Body
Example
{
"payload": {
"destination": {
"destinationType": "AMAZON_OPTIMIZED"
},
"freightInformation": {
"declaredValue": {
"amount": 5.5,
"code": "CAD"
},
"freightClass": "FC_50"
},
"inboundPlanId": "wf1234abcd-1234-abcd-5678-1234abcd5678",
"placementOptionId": "pl1234abcd-1234-abcd-5678-1234abcd5678",
"selectedDeliveryWindow": {
"availabilityType": "AVAILABLE",
"deliveryWindowOptionId": "dw1234abcd-1234-abcd-5678-1234abcd5678",
"editableUntil": "2024-01-05T20:00:00.000Z",
"endDate": "2024-01-05T20:00:00.000Z",
"startDate": "2024-01-05T14:00:00.000Z"
},
"shipmentConfirmationId": "shipmentConfirmationId",
"shipmentId": "sh1234abcd-1234-abcd-5678-1234abcd5678",
"source": {
"sourceType": "SELLER_FACILITY"
}
},
"errors": [
{
"code": "string",
"message": "string",
"details": "string"
}
]
}🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠429429
🔴500Server Error
🔴503Service Unavailable
Modified at 2024-12-05 08:36:30