Amazon SP API
  1. Schemas
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
    • listInboundShipments
    • listInventory
  • Authorization
    • Authorization
  • Catalog Items
    • searchCatalogItems
    • getCatalogItem
  • Catalog [Deprecated]
    • listCatalogItems
    • getCatalogItem
    • listCatalogCategories
  • Definitions
    • searchDefinitionsProductTypes
    • getDefinitionsProductType
  • 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
    • getShipment
    • cancelShipment
    • createShipment
    • getAdditionalSellerInputs
  • 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
  • Schemas
    • Schemas
      • UpdateShipmentStatusRequest
      • AdhocDisbursementEvent
      • ListCatalogItemsResponse
      • AttributeOption
      • GetOrderMetricsResponse
      • GetShipmentDetailsResponse
      • GetServiceJobByServiceJobIdResponse
      • GetItemEligibilityPreviewResponse
      • GetMyFeesEstimateRequest
      • GetItemOffersBatchRequest
      • CreateRestrictedDataTokenRequest
      • CreateUploadDestinationResponse
      • GetPurchaseOrdersResponse
      • ListTransactionsResponse
      • PackageIdentifier
      • ProcessingDirective
      • RestrictionList
      • CreateInventoryItemRequest
      • GetFeaturedOfferExpectedPriceBatchRequest
      • UpdateVerificationStatusRequest
      • AdhocDisbursementEventList
      • ListMatchingItemsResponse
      • OrderMetricsList
      • ShipmentDetail
      • CancelServiceJobByServiceJobIdResponse
      • ItemEligibilityPreview
      • GetMyFeesEstimatesRequest
      • GetListingOffersBatchRequest
      • RestrictedResource
      • UploadDestination
      • GetPurchaseOrderResponse
      • Transactions
      • AddressInput
      • CarrierCode
      • PackageStatus
      • EventFilter
      • Restriction
      • AddInventoryRequest
      • FeaturedOfferExpectedPriceRequestList
      • UpdateVerificationStatusRequestBody
      • AdjustmentEvent
      • Report
      • Export
      • MarketplaceParticipation
      • OrderMetricsInterval
      • Weight
      • ItemList
      • AccountId
      • CompleteServiceJobByServiceJobIdResponse
      • FeesEstimateByIdRequest
      • ListingOffersRequestList
      • CancelFeedResponse
      • SchemaLink
      • CreateRestrictedDataTokenResponse
      • Transaction
      • LabelFormatOptionRequest
      • GetSupplySourcesResponse
      • AllOwnersConstraint
      • CarrierCodeType
      • PackageId
      • MarketplaceFilter
      • Reason
      • Issue
      • InventoryItems
      • FeaturedOfferExpectedPriceRequest
      • AdjustmentEventList
      • GetCatalogItemResponse
      • ReportList
      • ExportInvoicesRequest
      • MarketplaceParticipationList
      • LiquidVolume
      • AddressTypeEnum
      • GetServiceJobsResponse
      • FeesEstimateRequest
      • ItemOffersRequestList
      • CreateFeedResult
      • ProductTypeDefinition
      • BigDecimal
      • LabelFormatOption
      • CODSettings
      • UpdateSupplySourceStatusRequest
      • DimensionUnitOfMeasurement
      • MarketplaceIds
      • Link
      • ItemAsin
      • PatchOperation
      • InventoryItem
      • FeaturedOfferExpectedPriceRequestParams
      • MarketplaceId
      • AdjustmentItem
      • CreateReportScheduleSpecification
      • ExportInvoicesResponse
      • GetMarketplaceParticipationsResponse
      • InvoiceDetails
      • Currency
      • ClientReferenceId
      • SetAppointmentResponse
      • GetMyFeesEstimateResponse
      • BatchOffersRequestParams
      • Feed
      • PropertyGroup
      • AvailableCarrierWillPickUpOption
      • ShipmentStatus
      • CreateFulfillmentOrderItem
      • CreateSupplySourceRequest
      • AppointmentSlotTime
      • DistributionPackage
      • HandoverMethod
      • AggregationFilter
      • ItemAttributes
      • ListingsItemPatchRequest
      • CreateInventoryItemResponse
      • GetFeaturedOfferExpectedPriceBatchResponse
      • OrderItems
      • AdjustmentItemList
      • CreateReportSpecification
      • ExportStatus
      • Marketplace
      • ChargeList
      • ContainerReferenceId
      • AssignAppointmentResourcesResponse
      • GetMyFeesEstimateResult
      • ItemOffersRequest
      • IdentifierType
      • FeedList
      • ProductTypeVersion
      • OrderDetails
      • SellingPartnerMetadata
      • AvailableCarrierWillPickUpOptionsList
      • CreateFulfillmentOrderItemList
      • CreateSupplySourceResponse
      • Box
      • DistributionPackageContents
      • OrderScheduleDetails
      • AggregationSettings
      • ItemBrowseClassification
      • ListingsItemPutRequest
      • DeleteInventoryItemResponse
      • FeaturedOfferExpectedPriceResponseList
      • UpdateShipmentStatusErrorResponse
      • AffordabilityExpenseEvent
      • ReportOptions
      • FileFormat
      • Participation
      • AssignAppointmentResourcesRequest
      • GetMyFeesEstimatesResponse
      • ListingOffersRequest
      • ASINIdentifier
      • GetFeedsResponse
      • ProductType
      • ImportDetails
      • RelatedIdentifier
      • AvailableDeliveryExperienceOption
      • FulfillmentPolicy
      • UpdateSupplySourceRequest
      • BoxContentInformationSource
      • DistributionPackageQuantity
      • AggregationTimePeriod
      • ItemContributor
      • ListingsItemSubmissionResponse
      • Decimal
      • AddInventoryResponse
      • FeaturedOfferExpectedPriceResponse
      • UpdateVerificationStatusErrorResponse
      • AffordabilityExpenseEventList
      • ReportSchedule
      • GetInvoiceResponse
      • GetAccountResponse
      • TaxClassificationList
      • JobListing
      • GetItemOffersBatchResponse
      • SellerSKUIdentifier
      • GetFeedResponse
      • ProductTypeList
      • DateTimeInterval
      • RelatedIdentifiers
      • AvailableDeliveryExperienceOptionsList
      • FulfillmentOrderStatus
      • SupplySource
      • BoxInput
      • DistributionPackageType
      • OrderChangeTypeFilter
      • ItemContributorRole
      • Points
      • Granularity
      • CompetitiveSummaryBatchRequest
      • GetOrdersResponse
      • ReportScheduleList
      • GetInvoicesAttributesResponse
      • MarketplaceLevelAttributes
      • ServiceJob
      • GetMyFeesEstimatesErrorList
      • GetListingOffersBatchResponse
      • AttributeSetList
      • FeedDocumentEncryptionDetails
      • PartyIdentification
      • Date
      • AvailableShippingServiceOptions
      • CreateFulfillmentOrderRequest
      • SupplySourceConfiguration
      • BoxUpdateInput
      • OrderChangeTypes
      • ItemBrowseClassifications
      • ItemIssues
      • ReservedQuantity
      • CompetitiveSummaryRequestList
      • GetOrderResponse
      • AttributeSetListType
      • CreateReportResponse
      • GetInvoicesDocumentResponse
      • RequestToken
      • ChargeComponent
      • Account
      • ShipmentItems
      • ServiceJobId
      • ItemOffersResponseList
      • FeedDocument
      • TaxRegistrationDetails
      • MarketplaceDetails
      • AvailableFormatOptionsForLabel
      • CreateFulfillmentReturnRequest
      • SupplySourceCapabilities
      • CancelInboundPlanResponse
      • ListHandoverSlotsRequest
      • OrderChangeTypeEnum
      • ItemBrowseClassificationsByMarketplace
      • ResearchingQuantityEntry
      • CompetitiveSummaryRequest
      • GetOrderBuyerInfoResponse
      • ChargeComponentList
      • DecimalWithUnits
      • GetReportsResponse
      • GetInvoicesExportResponse
      • Business
      • RateId
      • OrderId
      • ListingOffersResponseList
      • GetFeedDocumentResponse
      • Items
      • AvailableFormatOptionsForLabelList
      • CreateFulfillmentReturnResult
      • SupplySourceList
      • CancelSelfShipAppointmentRequest
      • InboundShipment
      • ListHandoverSlotsResponse
      • Subscription
      • Dimension
      • IssueEnforcements
      • ResearchingQuantity
      • CompetitiveSummaryIncludedData
      • GetOrderRegulatedInfoResponse
      • ChargeInstrument
      • CreatorType
      • CreateReportScheduleResponse
      • GetInvoicesExportsResponse
      • CarrierId
      • ScopeOfWork
      • FeesEstimateResult
      • BatchOffersResponse
      • CreateFeedResponse
      • Constraint
      • CreateFulfillmentReturnResponse
      • SupplySourceId
      • CancelSelfShipAppointmentResponse
      • InboundShipmentStatus
      • InvoiceData
      • CreateSubscriptionResponse
      • Item
      • Dimensions
      • IssueEnforcementAction
      • UnfulfillableQuantity
      • LowestPricedOffersInput
      • GetOrderAddressResponse
      • ChargeInstrumentList
      • DimensionType
      • ReportDocument
      • GetInvoicesResponse
      • PrimaryContact
      • CarrierName
      • SerialNumbersList
      • Seller
      • FeesEstimateIdentifier
      • ItemOffersRequestParams
      • FeedOptions
      • ItemRelatedIdentifier
      • Constraints
      • CreateReturnItem
      • SupplySourceCode
      • InboundShipmentSummary
      • CreateSubscriptionRequest
      • ItemDimensions
      • IssueExemption
      • InventoryDetails
      • CompetitiveSummaryBatchResponse
      • GetOrderItemsResponse
      • ChargeRefundEvent
      • LanguageType
      • Invoice
      • PackageClientReferenceId
      • EventList
      • ServiceJobProvider
      • PriceToEstimateFees
      • ItemOffersResponse
      • CreateFeedSpecification
      • ItemRelatedIdentifiers
      • AdditionalInputs
      • CreateReturnItemList
      • SupplySourceAlias
      • CarrierAppointment
      • GetSubscriptionByIdResponse
      • ItemDimensionsByMarketplace
      • ItemOffers
      • InventorySummary
      • CompetitiveSummaryResponseList
      • GetOrderItemsBuyerInfoResponse
      • ChargeRefundEventList
      • Image
      • InvoicesAttributes
      • ShipmentId
      • Buyer
      • FeesEstimate
      • ListingOffersRequestParams
      • CreateFeedDocumentSpecification
      • SubmitAcknowledgementResponse
      • Breakdowns
      • SellerInputDefinition
      • SupplySourceStatusReadOnly
      • ComplianceDetail
      • InventoryDetailsVisibility
      • GetSubscriptionResponse
      • ItemIdentifiers
      • ItemOfferByMarketplace
      • InventorySummaries
      • CompetitiveSummaryResponse
      • OrdersList
      • ChargeRefundTransaction
      • InvoicesDocument
      • TrackingId
      • SubmitInvoiceRequest
      • AppointmentTime
      • FeeDetailList
      • ListingOffersResponse
      • CreateFeedDocumentResponse
      • TransactionId
      • Breakdown
      • InputTargetType
      • SupplySourceStatus
      • ConfirmDeliveryWindowOptionsResponse
      • InventoryListing
      • OrderItemSerialNumber
      • DeleteSubscriptionByIdResponse
      • ItemIdentifiersByMarketplace
      • ItemProcurement
      • CompetitiveSummaryResponseBody
      • Price
      • ChargeRefundTransactions
      • TransactionIdentifier
      • AlternateLegTrackingId
      • PromisedDeliveryDate
      • Blob
      • AppointmentId
      • FeesEstimateError
      • RelationshipList
      • CreateFeedDocumentResult
      • OrderList
      • Contexts
      • AdditionalInputsList
      • DeliveryWindow
      • OutboundCapability
      • ConfirmPackingOptionResponse
      • InventoryQuantity
      • OrderItemSerialNumbers
      • DestinationList
      • ItemIdentifier
      • FulfillmentAvailability
      • GetInventorySummariesResult
      • ReferencePrice
      • CouponPaymentEvent
      • RelationshipType
      • ServiceId
      • SubmitInvoiceResponse
      • Appointment
      • FeesEstimateErrorDetail
      • GetPricingResponse
      • SubmitAcknowledgementRequest
      • Order
      • Context
      • AdditionalSellerInput
      • DeliveryWindowList
      • ServicesCapability
      • ConfirmPlacementOptionResponse
      • ItemImages
      • GetInventorySummariesResponse
      • FeaturedBuyingOption
      • OrderBuyerInfo
      • CouponPaymentEventList
      • ServiceName
      • TimeRange
      • ShipmentInvoiceStatusInfo
      • Technician
      • FeeDetail
      • GetOffersResponse
      • SalesRankList
      • OrderAcknowledgement
      • ProductContext
      • AdditionalSellerInputs
      • PickupChannel
      • ConfirmShipmentContentUpdatePreviewResponse
      • InventoryUnitOfMeasurement
      • Packages
      • DestinationResource
      • ItemImagesByMarketplace
      • SegmentedFeaturedOffer
      • OrderRegulatedInfo
      • ShipperInstruction
      • ShippingPromiseSet
      • ShipmentInvoiceStatus
      • Poa
      • IncludedFeeDetailList
      • PriceList
      • SalesRankType
      • OrderAcknowledgementItem
      • AmazonPayContext
      • AdditionalSellerInputsList
      • DropOffLocation
      • ParkingConfiguration
      • ConfirmTransportationOptionsRequest
      • MeasurementData
      • PackageDetails
      • DestinationResourceSpecification
      • ItemImage
      • LowestPricedOffer
      • RegulatedOrderVerificationStatus
      • ListCatalogCategoriesResponse
      • ServiceType
      • ShipmentInvoiceStatusResponse
      • IncludedFeeDetail
      • GetOffersResult
      • OrderItemAcknowledgement
      • PaymentsContext
      • Fee
      • ParkingCostType
      • ConfirmTransportationOptionsResponse
      • RejectedOrder
      • SqsResource
      • ItemProductTypes
      • Audience
      • Offer
      • RejectionReason
      • DebtRecoveryEvent
      • ListOfCategories
      • Geocode
      • ServiceTypeList
      • GetInvoiceStatusResponse
      • ItemDelivery
      • HttpRequestHeaders
      • ItemQuantity
      • DeferredContext
      • AddressLine1
      • FeeList
      • ParkingSpotIdentificationType
      • ContactInformation
      • PackageVolume
      • TimeSlot
      • EventBridgeResourceSpecification
      • ItemProductTypeByMarketplace
      • MoneyType
      • PrimeDetails
      • PrescriptionDetail
      • DebtRecoveryEventList
      • Categories
      • StateOrRegion
      • ItemDeliveryPromise
      • OptionalFulfillmentProgram
      • HttpResponseHeaders
      • GetPurchaseOrdersStatusResponse
      • TimeRangeContext
      • AddressLine2
      • FulfillmentAction
      • InStorePickupConfiguration
      • ContentUpdatePreview
      • PackageWeight
      • TimeSlots
      • EventBridgeResource
      • ItemSalesRanks
      • ShippingOption
      • ValidVerificationDetail
      • DebtRecoveryItem
      • City
      • ServiceLocation
      • IdType
      • GetOffersHttpStatusLine
      • OrderListStatus
      • AddressLine3
      • FulfillmentOrder
      • CurbsidePickupConfiguration
      • CreateInboundPlanRequest
      • ProductAttribute
      • ScheduledPackageId
      • CreateDestinationRequest
      • ItemSalesRanksByMarketplace
      • FeaturedOfferSegment
      • VerificationDetails
      • DebtRecoveryItemList
      • CountryCode
      • OrderStatus
      • AddressName
      • FulfillmentOrderItem
      • ParkingWithAddressConfiguration
      • CreateInboundPlanResponse
      • ProductQuantity
      • CreateScheduledPackageRequest
      • CreateDestinationResponse
      • ItemClassificationSalesRank
      • SegmentDetails
      • VerificationStatus
      • DirectPayment
      • PostalCode
      • AcceptedRate
      • AddAppointmentRequest
      • ItemStatus
      • AmazonOrderId
      • FulfillmentOrderItemList
      • DeliveryChannel
      • CreateMarketplaceItemLabelsRequest
      • ShipmentListing
      • UpdateScheduledPackagesRequest
      • GetDestinationResponse
      • ItemDisplayGroupSalesRank
      • Errors
      • RegulatedInformation
      • DirectPaymentList
      • Location
      • ServiceRate
      • RescheduleAppointmentRequest
      • OrderItemStatus
      • FulfillmentPreview
      • OperationalConfiguration
      • CreateMarketplaceItemLabelsResponse
      • ShipmentSortableField
      • UpdatePackageDetails
      • GetDestinationsResponse
      • ItemSummaries
      • FeaturedOfferExpectedPriceResponseBody
      • RegulatedInformationField
      • FailedAdhocDisbursementEventList
      • DocumentFormat
      • ServiceRateList
      • AppointmentTimeInput
      • OrderedQuantityDetails
      • FulfillmentPreviewItem
      • Duration
      • SkuQuantitiesVisibility
      • UpdatePackageDetailsList
      • DeleteDestinationResponse
      • ItemSummaryByMarketplace
      • FeaturedOfferExpectedPriceResultList
      • OrderAddress
      • FailedAdhocDisbursementEvent
      • DocumentType
      • Party
      • RescheduleReasonCode
      • Product
      • AcknowledgementStatusDetails
      • FulfillmentPreviewItemList
      • ThroughputConfig
      • CustomPlacementInput
      • SkuQuantity
      • String
      • ItemVariationTheme
      • FeaturedOfferExpectedPriceResult
      • FBALiquidationEvent
      • Dpi
      • Address
      • FulfillmentPreviewList
      • ReturnLocation
      • Dates
      • SortOrder
      • ItemRelationships
      • FeaturedOfferExpectedPrice
      • AddressExtendedFields
      • FBALiquidationEventList
      • PageLayout
      • ExcludedBenefitReasonCodes
      • FulfillmentPreviewShipment
      • AddressWithContact
      • DeliveryWindowOption
      • VolumeUnitOfMeasurement
      • ItemRelationshipsByMarketplace
      • FeaturedOffer
      • FeeComponent
      • NeedFileJoining
      • WarningList
      • FulfillmentPreviewShipmentList
      • DeliveryPreferences
      • ContactDetails
      • WeightUnitOfMeasurement
      • ItemRelationship
      • HttpHeaders
      • PreferredDeliveryTime
      • FeeComponentList
      • Contents
      • ContainerItem
      • Warning
      • FulfillmentReturnItemStatus
      • ThroughputCap
      • DocumentDownload
      • CreateScheduledPackagesRequest
      • ItemVendorDetailsCategory
      • HttpStatusLine
      • BusinessHours
      • FinancialEventGroup
      • PackageDocumentList
      • Container
      • RangeSlotCapacityErrors
      • FulfillmentShipment
      • OperatingHour
      • CreateScheduledPackagesResponse
      • ItemVendorDetails
      • HttpBody
      • ExceptionDates
      • FinancialEventGroupList
      • PackageDocument
      • ContainerList
      • RangeSlotCapacity
      • CompetitivePricingType
      • FulfillmentShipmentItem
      • URL
      • ItemVendorDetailsByMarketplace
      • HttpUri
      • OpenInterval
      • FinancialEvents
      • PrintOptionList
      • ContainerSpecification
      • RangeCapacity
      • CompetitivePriceList
      • FulfillmentShipmentItemList
      • ThroughputUnit
      • FreightInformation
      • ItemSearchResults
      • HttpMethod
      • OpenTimeInterval
      • ImagingServicesFeeEvent
      • PrintOption
      • ContainerSpecificationList
      • RangeSlot
      • CompetitivePriceType
      • ItemLevelFields
      • FulfillmentShipmentList
      • OperatingHoursByDay
      • GenerateDeliveryWindowOptionsResponse
      • Pagination
      • BatchRequest
      • OtherDeliveryAttributes
      • ImagingServicesFeeEventList
      • DocumentSize
      • Label
      • FixedSlotCapacityErrors
      • NumberOfOfferListingsList
      • ItemLevelFieldsList
      • FulfillmentShipmentPackage
      • TimeUnit
      • GeneratePackingOptionsResponse
      • Refinements
      • BatchResponse
      • ListFinancialEventGroupsPayload
      • SupportedDocumentDetail
      • LabelResult
      • FixedSlotCapacity
      • OfferListingCountType
      • GetAdditionalSellerInputsRequest
      • FulfillmentShipmentPackageList
      • NonNegativeInteger
      • GeneratePlacementOptionsRequest
      • BrandRefinement
      • Money
      • OfferIdentifier
      • ListFinancialEventGroupsResponse
      • RequestedDocumentSpecification
      • LabelResultList
      • PaymentMethodDetailItemList
      • FixedSlot
      • GetAdditionalSellerInputsResult
      • GetFulfillmentOrderResult
      • GeneratePlacementOptionsResponse
      • ClassificationRefinement
      • PaymentExecutionDetailItemList
      • ListFinancialEventsPayload
      • SupportedDocumentSpecificationList
      • LabelStream
      • UpdateScheduleResponse
      • GetAdditionalSellerInputsResponse
      • GetFulfillmentOrderResponse
      • GenerateSelfShipAppointmentSlotsRequest
      • Code
      • PaymentExecutionDetailItem
      • ListFinancialEventsResponse
      • SupportedDocumentSpecification
      • LabelSpecification
      • SetAppointmentFulfillmentDataRequest
      • CurrencyAmount
      • GetFulfillmentPreviewItem
      • DateTime
      • GenerateSelfShipAppointmentSlotsResponse
      • LoanServicingEvent
      • CreateShipmentRequest
      • BuyerTaxInfo
      • FulfillmentTime
      • PriceType
      • CustomTextForLabel
      • GetFulfillmentPreviewItemList
      • GenerateShipmentContentUpdatePreviewsRequest
      • FulfillmentType
      • LoanServicingEventList
      • PurchaseLabelsRequest
      • MarketplaceTaxInfo
      • FulfillmentDocuments
      • OffersList
      • DeliveryExperienceType
      • GetFulfillmentPreviewRequest
      • GenerateShipmentContentUpdatePreviewsResponse
      • NetworkComminglingTransactionEvent
      • Package
      • RetrieveShippingLabelRequest
      • TaxClassification
      • FulfillmentDocument
      • OfferType
      • DistrictOrCounty
      • GetFulfillmentPreviewResult
      • GenerateTransportationOptionsRequest
      • Sku
      • OrderItemsList
      • NetworkComminglingTransactionEventList
      • PackageList
      • AppointmentResources
      • OfferCustomerType
      • EmailAddress
      • GetFulfillmentPreviewResponse
      • GenerateTransportationOptionsResponse
      • Condition
      • OrderItemList
      • PayWithAmazonEvent
      • DirectFulfillmentItemIdentifiers
      • AppointmentResource
      • QuantityDiscountPriceType
      • FileContents
      • GetDeliveryOffersRequest
      • GetDeliveryChallanDocumentResponse
      • Asin
      • PayWithAmazonEventList
      • PackageDocumentDetail
      • CreateShipmentResult
      • CreateReservationResponse
      • QuantityDiscountType
      • OrderItem
      • FileType
      • GetDeliveryOffersResponse
      • GetSelfShipAppointmentSlotsResponse
      • AmazonPrograms
      • ProductAdsPaymentEvent
      • PackageDocumentDetailList
      • Shipment
      • UpdateReservationResponse
      • GetEligibleShipmentServicesRequest
      • GetDeliveryOffersResult
      • InboundOperationStatus
      • SubstitutionPreferences
      • ProductAdsPaymentEventList
      • TimeWindow
      • PurchaseLabelsResult
      • CancelReservationResponse
      • ConditionType
      • GetEligibleShipmentServicesResponse
      • DeliveryOffersList
      • InboundPlan
      • SubstitutionOptionList
      • Promotion
      • Promise
      • RetrieveShippingLabelResult
      • DayOfWeek
      • GetEligibleShipmentServicesResult
      • DeliveryOffer
      • InboundPlanSummary
      • SubstitutionOption
      • PromotionList
      • RequestedValueAddedServiceList
      • Recurrence
      • Summary
      • GetDeliveryOffersProduct
      • Incentive
      • Measurement
      • RemovalShipmentEvent
      • RequestedValueAddedService
      • AvailabilityRecord
      • BuyBoxEligibleOffers
      • HazmatType
      • Amount
      • RemovalShipmentEventList
      • AvailableValueAddedServiceGroupList
      • AvailabilityRecords
      • AssociatedItem
      • BuyBoxPrices
      • GetDeliveryOffersTerms
      • ItemInput
      • AssociationType
      • RemovalShipmentItem
      • AvailableValueAddedServiceGroup
      • TrackingInformation
      • Reservation
      • LowestPrices
      • IpAddress
      • ItemLabelPageType
      • OrderItemsBuyerInfoList
      • RemovalShipmentItemList
      • ValueAddedService
      • CreateShipmentResponse
      • UpdateScheduleRecord
      • NumberOfOffers
      • LabelOwner
      • Destination
      • OrderItemBuyerInfoList
      • RemovalShipmentAdjustmentEvent
      • CollectOnDelivery
      • GetShipmentResponse
      • CreateReservationRecord
      • OfferCountType
      • ItemDescription
      • ProductIdentifier
      • LabelPrintType
      • OrderItemBuyerInfo
      • RemovalShipmentAdjustmentEventList
      • ValueAddedServiceDetails
      • UpdateReservationRecord
      • FulfillmentChannelType
      • Origin
      • ListDeliveryWindowOptionsResponse
      • PointsGrantedDetail
      • RemovalShipmentItemAdjustment
      • DangerousGoodsDetails
      • RangeSlotCapacityQuery
      • LowestPriceType
      • LabelCustomization
      • VariablePrecisionAddress
      • ListInboundPlanBoxesResponse
      • ProductInfoDetail
      • RentalTransactionEvent
      • TaxType
      • FixedSlotCapacityQuery
      • BuyBoxPriceType
      • LabelDimension
      • ListInboundPlanItemsResponse
      • PromotionIdList
      • RentalTransactionEventList
      • TaxDetail
      • PurchaseLabelsResponse
      • UpdateScheduleRequest
      • OfferDetailList
      • LabelDimensions
      • DeliveryPolicy
      • ListInboundPlanPalletsResponse
      • BuyerCustomizedInfoDetail
      • RetrochargeEvent
      • TaxDetailList
      • RetrieveShippingLabelResponse
      • CapacityType
      • OfferDetail
      • LabelFormat
      • DeliveryMessage
      • ListInboundPlansResponse
      • TaxCollection
      • RetrochargeEventList
      • EventCode
      • CreateReservationRequest
      • PrimeInformationType
      • LabelFormatList
      • InvalidItemReasonCode
      • ListItemComplianceDetailsResponse
      • BuyerTaxInformation
      • SAFETReimbursementEvent
      • Event
      • GetTrackingInformationResponse
      • UpdateReservationRequest
      • SellerFeedbackType
      • Length
      • InvalidItemReason
      • ListPackingGroupBoxesResponse
      • FulfillmentInstruction
      • SAFETReimbursementEventList
      • TrackingSummary
      • GetAppointmentSlotsResponse
      • OrderItemId
      • InvalidReturnItem
      • ListPackingGroupItemsResponse
      • ShippingConstraints
      • SAFETReimbursementItem
      • Status
      • AppointmentSlotReport
      • DetailedShippingTimeType
      • PackageDimension
      • InvalidReturnItemList
      • ListPackingOptionsResponse
      • ConstraintType
      • SAFETReimbursementItemList
      • AmazonOrderDetails
      • AppointmentSlot
      • ShipsFromType
      • PackageDimensions
      • ListAllFulfillmentOrdersResult
      • ListPlacementOptionsResponse
      • BuyerInfo
      • SellerDealPaymentEvent
      • AmazonShipmentDetails
      • ServiceUploadDocument
      • PhoneNumber
      • ListAllFulfillmentOrdersResponse
      • ListPrepDetailsResponse
      • ItemBuyerInfo
      • SellerDealPaymentEventList
      • ChannelType
      • CreateServiceDocumentUploadDestination
      • ItemCondition
      • ListReturnReasonCodesResult
      • ListShipmentBoxesResponse
      • AutomatedShippingSettings
      • SellerReviewEnrollmentPaymentEvent
      • ChannelDetails
      • ServiceDocumentUploadDestination
      • PredefinedPackageDimensions
      • ListReturnReasonCodesResponse
      • ListShipmentContentUpdatePreviewsResponse
      • BuyerRequestedCancel
      • SellerReviewEnrollmentPaymentEventList
      • RateList
      • EncryptionDetails
      • CustomerType
      • RestrictedSetValues
      • LockerDetails
      • ListShipmentItemsResponse
      • EasyShipShipmentStatus
      • ServiceFeeEvent
      • Rate
      • SellerOrderId
      • DeliveryInformation
      • ListShipmentPalletsResponse
      • ElectronicInvoiceStatus
      • ServiceFeeEventList
      • IneligibilityReasonCode
      • DeliveryDocumentList
      • ListTransportationOptionsResponse
      • ConfirmShipmentRequest
      • ShipmentEvent
      • IneligibilityReason
      • DeliveryDocument
      • LtlTrackingDetail
      • ConfirmShipmentErrorResponse
      • ShipmentEventList
      • IneligibleRate
      • ShipmentRequestDetails
      • NotificationEmailList
      • LtlTrackingDetailInput
      • PackageDetail
      • ShipmentSettleEventList
      • IneligibleRateList
      • CurrentStatus
      • MskuPrepDetail
      • ConfirmShipmentOrderItemsList
      • CancelShipmentResult
      • ShipmentItem
      • DeliveryExperienceOption
      • AdditionalLocationInfo
      • MskuPrepDetailInput
      • ConfirmShipmentOrderItem
      • ShipmentItemList
      • CancelShipmentResponse
      • ShippingOfferingFilter
      • PackageTrackingDetails
      • MskuQuantity
      • SolutionProviderCreditEvent
      • GetRatesRequest
      • ShippingService
      • TransparencyCodeList
      • GetPackageTrackingDetailsResponse
      • OperationProblem
      • SolutionProviderCreditEventList
      • AccessPointDetails
      • ShippingServiceIdentifier
      • TransparencyCode
      • ReasonCodeDetails
      • OperationStatus
      • PackageReferenceId
      • TaxWithholdingPeriod
      • GetRatesResult
      • ShippingServiceList
      • ReasonCodeDetailsList
      • OwnerConstraint
      • TaxWithholdingEvent
      • GetRatesResponse
      • ShippingServiceOptions
      • PaymentInformation
      • PackageGroupingInput
      • ErrorList
      • TaxWithholdingEventList
      • DirectPurchaseRequest
      • CarrierWillPickUpOption
      • ReturnAuthorization
      • PackingOption
      • Error
      • TaxWithheldComponent
      • DirectPurchaseResult
      • StandardIdForLabel
      • PaymentInformationList
      • PackingOptionSummary
      • TaxWithheldComponentList
      • DirectPurchaseResponse
      • StateOrProvinceCode
      • ReturnAuthorizationList
      • TDSReimbursementEvent
      • GetShipmentDocumentsResult
      • RejectedShippingService
      • ReturnItem
      • Pallet
      • TDSReimbursementEventList
      • GetShipmentDocumentsResponse
      • RejectedShippingServiceList
      • ReturnItemDisposition
      • PalletInput
      • TrialShipmentEvent
      • GetTrackingResult
      • TemporarilyUnavailableCarrier
      • ReturnItemList
      • PlacementOption
      • TrialShipmentEventList
      • GetTrackingResponse
      • TemporarilyUnavailableCarrierList
      • ScheduledDeliveryInfo
      • PlacementOptionSummary
      • ValueAddedServiceChargeEventList
      • PurchaseShipmentRequest
      • TermsAndConditionsNotAcceptedCarrier
      • ShippingSpeedCategoryList
      • PrepCategory
      • ValueAddedServiceChargeEvent
      • PurchaseShipmentResult
      • TermsAndConditionsNotAcceptedCarrierList
      • StringList
      • PrepInstruction
      • CapacityReservationBillingEvent
      • PurchaseShipmentResponse
      • Timestamp
      • PrepOwner
      • CapacityReservationBillingEventList
      • OneClickShipmentRequest
      • TrackingAddress
      • PrepType
      • OneClickShipmentResponse
      • Quote
      • OneClickShipmentResult
      • TrackingEvent
      • ReasonComment
      • GetAccessPointsResponse
      • UnitOfLength
      • TrackingEventList
      • Region
      • GetAccessPointsResult
      • UnitOfWeight
      • UnfulfillablePreviewItem
      • RequestedUpdates
      • AccessPointType
      • UnfulfillablePreviewItemList
      • ScheduleSelfShipAppointmentRequest
      • AccessPointsMap
      • WeightValue
      • UpdateFulfillmentOrderItem
      • ScheduleSelfShipAppointmentResponse
      • AccessPointList
      • UpdateFulfillmentOrderItemList
      • SelectedDeliveryWindow
      • AccessPointId
      • UpdateFulfillmentOrderRequest
      • SelfShipAppointmentDetails
      • AccessPoint
      • UpdateFulfillmentOrderResponse
      • SelfShipAppointmentSlotsAvailability
      • AccessibilityAttributes
      • CreateFulfillmentOrderResponse
      • SetPackingInformationRequest
      • OperatingHours
      • CancelFulfillmentOrderResponse
      • SetPackingInformationResponse
      • TimeOfDay
      • SetPrepDetailsRequest
      • DayOfWeekTimeMap
      • Quantity
      • SetPrepDetailsResponse
      • ExceptionOperatingHours
      • ShippingSpeedCategory
      • GetAdditionalInputsResult
      • GetFeatureInventoryResponse
      • ShipmentDestination
      • GetAdditionalInputsResponse
      • GetFeatureInventoryResult
      • ShipmentSource
      • GetCarrierAccountsRequest
      • FeatureSku
      • ShipmentSummary
      • LinkCarrierAccountRequest
      • GetFeaturesResponse
      • ShipmentTransportationConfiguration
      • UnlinkCarrierAccountRequest
      • GetFeaturesResult
      • ShippingConfiguration
      • GenerateCollectionFormRequest
      • Features
      • SpdTrackingDetail
      • GetCollectionFormHistoryRequest
      • Feature
      • SpdTrackingDetailInput
      • GetUnmanifestedShipmentsRequest
      • GetFeatureSkuResponse
      • SpdTrackingItem
      • GetCarrierAccountFormInputsResponse
      • GetFeatureSkuResult
      • SpdTrackingItemInput
      • GetCarrierAccountsResponse
      • FeatureSettings
      • Stackability
      • LinkCarrierAccountResponse
      • SubmitFulfillmentOrderStatusUpdateRequest
      • TaxDetails
      • UnlinkCarrierAccountResponse
      • SubmitFulfillmentOrderStatusUpdateResponse
      • TaxRate
      • GenerateCollectionFormResponse
      • TrackingDetails
      • GetCollectionFormHistoryResponse
      • TrackingDetailsInput
      • GetUnmanifestedShipmentsResponse
      • TransportationOption
      • GetCollectionFormResponse
      • TransportationSelection
      • ClientReferenceDetails
      • UnitOfMeasurement
      • ClientReferenceDetail
      • CollectionFormId
      • UpdateInboundPlanNameRequest
      • ShipmentType
      • UpdateItemComplianceDetailsRequest
      • ActiveAccounts
      • UpdateItemComplianceDetailsResponse
      • ActiveAccount
      • UpdateShipmentNameRequest
      • DateRange
      • UpdateShipmentSourceAddressRequest
      • CarrierAccountAttributes
      • UpdateShipmentSourceAddressResponse
      • CarrierAccountAttribute
      • UpdateShipmentTrackingDetailsRequest
      • CarrierAccountType
      • UpdateShipmentTrackingDetailsResponse
      • MerchantId
      • AccountStatus
      • Window
      • CollectionsFormDocument
      • WindowInput
      • CollectionFormsHistoryRecordList
      • CollectionFormsHistoryRecord
      • UnmanifestedCarrierInformationList
      • UnmanifestedCarrierInformation
      • UnmanifestedShipmentLocationList
      • UnmanifestedShipmentLocation
      • LinkableCarriersList
      • LinkableCarrier
      • LinkableAccountTypeList
      • LinkableAccountType
      • CarrierAccountInputsList
      • CarrierAccountInput
      • ValidationMetadataList
      • ValidationMetadata
      • GenerationStatus
      • AccountType
      • InputType
      • PaymentType
      • RateItemList
      • RateItem
      • RateItemID
      • RateItemType
      • Benefits
      • IncludedBenefits
      • ExcludedBenefits
      • ExcludedBenefit
      • ServiceSelection
      • ServiceIds
      • OneClickShipmentValueAddedServiceDetails
      • OneClickShipmentValueAddedService
      • Service
      • Carrier
  1. Schemas

CODSettings

The COD (Cash On Delivery) charges that you associate with a COD fulfillment order.

{
    "isCodRequired": true,
    "codCharge": {
        "currencyCode": "string",
        "amount": "string"
    },
    "codChargeTax": {
        "currencyCode": "string",
        "amount": "string"
    },
    "shippingCharge": {
        "currencyCode": "string",
        "amount": "string"
    },
    "shippingChargeTax": {
        "currencyCode": "string",
        "amount": "string"
    }
}
Built with