Amazon SP API
  1. Merchant Fulfillment
Amazon SP API
  • Overview
  • Authorization Workflow
  • Permissions
  • Sandbox
  • API Models
  • Available API Models
  • Request Apidog Access
  • OPENAPI SPECIFICATION
  • Research Docs
    • Amazon Seller Order Fulfillment Workflow
  • Amazon Warehousing and Distribution
    • getInboundShipment
      GET
    • listInboundShipments
      GET
    • listInventory
      GET
  • Authorization
    • Authorization
      POST
  • Catalog Items
    • searchCatalogItems
      GET
    • getCatalogItem
      GET
  • Catalog [Deprecated]
    • listCatalogItems
      GET
    • getCatalogItem
      GET
    • listCatalogCategories
      GET
  • Definitions
    • searchDefinitionsProductTypes
      GET
    • getDefinitionsProductType
      GET
  • Easy Ship
    • listHandoverSlots
    • getScheduledPackage
    • createScheduledPackage
    • updateScheduledPackages
    • createScheduledPackageBulk
  • 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
    • getInventorySummaries
    • createInventoryItem
    • deleteInventoryItem
    • addInventory
  • FBAOutbound
    • getFulfillmentPreview
    • deliveryOffers
    • listAllFulfillmentOrders
    • createFulfillmentOrder
    • getPackageTrackingDetails
    • listReturnReasonCodes
    • createFulfillmentReturn
    • getFulfillmentOrder
    • updateFulfillmentOrder
    • cancelFulfillmentOrder
    • submitFulfillmentOrderStatusUpdate
    • getFeatures
    • getFeatureInventory
    • getFeatureSKU
  • Feeds
    • getFeeds
    • createFeed
    • cancelFeed
    • getFeed
    • createFeedDocument
    • getFeedDocument
  • Fees
    • getMyFeesEstimateForSKU
    • getMyFeesEstimateForASIN
    • getMyFeesEstimates
  • Finance
    • listTransactions
    • listFinancialEventGroups
    • listFinancialEventsByGroupId
    • listFinancialEventsByOrderId
    • listFinancialEvents
  • Invoices [Brazil]
    • getInvoicesAttributes
    • getInvoicesDocument
    • createInvoicesExport
    • getInvoicesExports
    • getInvoicesExport
    • getInvoices
    • getInvoice
  • Listings Items
    • getListingsRestrictions
    • deleteListingsItem
    • getListingsItem
    • patchListingsItem
    • putListingsItem
  • Merchant Fulfillment
    • getEligibleShipmentServices
      POST
    • getShipment
      GET
    • cancelShipment
      DELETE
    • createShipment
      POST
    • getAdditionalSellerInputs
      POST
  • Orders
    • getOrders
    • getOrder
    • getOrderBuyerInfo
    • getOrderAddress
    • getOrderItems
    • getOrderItemsBuyerInfo
    • updateShipmentStatus
    • getOrderRegulatedInfo
    • updateVerificationStatus
    • confirmShipment
  • ProductPricing
    • deprecated
      • getPricing
      • getCompetitivePricing
      • getListingOffers
      • getItemOffers
      • getItemOffersBatch
      • getListingOffersBatch
    • getFeaturedOfferExpectedPriceBatch
    • getCompetitiveSummary
  • Reports
    • getReports
    • createReport
    • cancelReport
    • getReport
    • getReportSchedules
    • createReportSchedule
    • cancelReportSchedule
    • getReportSchedule
    • getReportDocument
  • Sales
    • getOrderMetrics
  • Sellers
    • getMarketplaceParticipations
    • getAccount
  • Service
    • getServiceJobByServiceJobId
    • cancelServiceJobByServiceJobId
    • completeServiceJobByServiceJobId
    • getServiceJobs
    • addAppointmentForServiceJobByServiceJobId
    • rescheduleAppointmentForServiceJobByServiceJobId
    • assignAppointmentResources
    • setAppointmentFulfillmentData
    • getRangeSlotCapacity
    • getFixedSlotCapacity
    • updateSchedule
    • createReservation
    • updateReservation
    • cancelReservation
    • getAppointmmentSlotsByJobId
    • getAppointmentSlots
    • createServiceDocumentUploadDestination
  • ShipmentInvoice[Brazil]
    • getShipmentDetails
    • submitInvoice
    • getInvoiceStatus
  • 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
    • getSupplySources
    • createSupplySource
    • getSupplySource
    • updateSupplySource
    • archiveSupplySource
    • updateSupplySourceStatus
  • Tokens
    • createRestrictedDataToken
  • Uploads
    • createUploadDestinationForResource
  • Notifications
    • getSubscription
    • createSubscription
    • getSubscriptionById
    • deleteSubscriptionById
    • getDestinations
    • createDestination
    • getDestination
    • deleteDestination
  1. Merchant Fulfillment

getAdditionalSellerInputs

POST
/mfn/v0/additionalSellerInputs
Last modified:2024-12-05 08:36:30
Maintainer:Not configured
Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping.
Usage Plan:
Rate (requests per second)Burst
11
The 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
{
    "ShippingServiceId": "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"
    },
    "OrderId": "string"
}

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/additionalSellerInputs' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ShippingServiceId": "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"
    },
    "OrderId": "string"
}'

Responses

🟢200OK
application/json
Success.
Headers

Body

Example
{
    "payload": {
        "ShipmentLevelFields": [
            {
                "AdditionalInputFieldName": "string",
                "SellerInputDefinition": {
                    "IsRequired": true,
                    "DataType": "string",
                    "Constraints": [
                        {
                            "ValidationRegEx": "string",
                            "ValidationString": "string"
                        }
                    ],
                    "InputDisplayText": "string",
                    "InputTarget": "SHIPMENT_LEVEL",
                    "StoredValue": {
                        "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
                        }
                    },
                    "RestrictedSetValues": [
                        "string"
                    ]
                }
            }
        ],
        "ItemLevelFieldsList": [
            {
                "Asin": "string",
                "AdditionalInputs": [
                    {
                        "AdditionalInputFieldName": "string",
                        "SellerInputDefinition": {
                            "IsRequired": true,
                            "DataType": "string",
                            "Constraints": [
                                {
                                    "ValidationRegEx": "string",
                                    "ValidationString": "string"
                                }
                            ],
                            "InputDisplayText": "string",
                            "InputTarget": "SHIPMENT_LEVEL",
                            "StoredValue": {
                                "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
                                }
                            },
                            "RestrictedSetValues": [
                                "string"
                            ]
                        }
                    }
                ]
            }
        ]
    },
    "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
Previous
createShipment
Next
Orders
Built with