Amazon Marketplace Web Service (MWS) will no longer be available after March 31, 2024. All MWS developers must migrate to Selling Partner API (SP-API) to avoid service disruptions. Refer to the Migration Hub for more information.
The following datatypes are used in the Amazon Marketplace Web Service (Amazon MWS) Finances API section:
Datatype | Description |
---|---|
AdjustmentEvent | An adjustment to your account. |
AdjustmentItem | An item of an adjustment to your account. |
AffordabilityExpenseEvent | An expense related to an affordability promotion. |
AffordabilityExpenseReversalEvent | An expense refund related to an affordability promotion. |
ChargeComponent | A charge on the seller's account. |
ChargeInstrument | A payment instrument. |
CouponPaymentEvent | An event related to coupon payments. |
CurrencyAmount | A currency type and amount. |
DebtRecoveryEvent | A debt payment or debt adjustment. |
DebtRecoveryItem | An item of a debt payment or debt adjustment. |
DirectPayment | A payment made directly to a seller. |
FBALiquidationEvent | A payment event for Fulfillment by Amazon (FBA) inventory liquidation. This event is used only in the US marketplace. |
FeeComponent | A fee on the seller's account. |
FinancialEventGroup | Contains information related to a financial event group. |
FinancialEvents | Contains all information related to a financial event. |
ImagingServicesFeeEvent | An event related to Amazon Imaging services. |
LoanServicingEvent | A loan advance, loan payment, or loan refund. |
NetworkComminglingTransactionEvent | A network commingling transaction event. |
PayWithAmazonEvent | An event related to your Pay with Amazon account. |
Promotion | A promotion applied to an item. |
RentalTransactionEvent | An event related to a rental transaction. |
RetrochargeEvent | A retrocharge or retrocharge reversal. |
SAFETReimbursementEvent | A SAFE-T claim reimbursement on your account. |
SAFETReimbursementItem | An item from a SAFE-T claim reimbursement. |
ServiceFeeEvent | A service fee on your account. |
ShipmentItem | An item of a shipment, refund, guarantee claim, or chargeback. |
SolutionProviderCreditEvent | A credit given to a solution provider. |
TaxWithheldComponent | Information about the taxes withheld. |
TaxWithholdingEvent | A tax withholding event. |
TaxWithholdingPeriod | A tax withholding period. |
CapacityReservationBillingEvent | An event related to a capacity reservation billing charge. |
An adjustment to your account.
The following table shows the elements of the AdjustmentEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
AdjustmentType | The type of adjustment. | No | AdjustmentType values:
|
AdjustmentAmount | The amount adjusted as part of this event. | No | Type: CurrencyAmount |
AdjustmentItemList | A list of AdjustmentItem values. | No | Type: List of AdjustmentItem |
PostedDate | The date when the financial event was posted. | No | Type: xs:dateTime |
An item of an adjustment to your account.
The following table shows the elements of the AdjustmentItem datatype:
Name | Description | Required | Values |
---|---|---|---|
Quantity | Represents the number of units in the seller's inventory when the AdustmentType is FBAInventoryReimbursement. | No | Type: xs:string |
PerUnitAmount | The per unit value of the item. | No | Type: CurrencyAmount |
TotalAmount | The total value of the item. | No | Type: CurrencyAmount |
SellerSKU | The Seller SKU of the item. The Seller SKU is qualified by your Seller ID, which is included with every call to Amazon MWS. | No | Type: xs:string |
FnSKU | A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center. | No | Type: xs:string |
ProductDescription | A short description of the item. | No | Type: xs:string |
ASIN | The ASIN of the item. | No | Type: xs:string |
An expense related to an affordability promotion.
The following table shows the elements of the AffordabilityExpenseEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
PostedDate | The date when the financial event was created. | No | Type: xs:dateTime |
TransactionType | Indicates the type of transaction. | No | TransactionType values:
|
AmazonOrderId | An Amazon-defined identifier for an order. | No | Type: xs:string |
BaseExpense | The amount charged for clicks incurred under the Sponsored Products program. | No | Type: CurrencyAmount |
TotalExpense | The total amount charged to the seller. TotalExpense=BaseExpense+TaxTypeIGST+TaxTypeCGST+TaxTypeSGST. | No | Type: CurrencyAmount |
TaxTypeIGST | Integrated Goods and Service Tax, charged and collected by the central government. | Yes | Type: CurrencyAmount |
TaxTypeCGST | Central Goods and Service Tax, charged and collected by the central government. | Yes | Type: CurrencyAmount |
TaxTypeSGST | State Goods and Service Tax, charged and collected by the state government. | Yes | Type: CurrencyAmount |
MarketplaceId | An encrypted, Amazon-defined marketplace identifier. | No | Type: xs:string |
An expense refund related to an affordability promotion.
The following table shows the elements of the AffordabilityExpenseReversalEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
PostedDate | The date when the financial event was created. | No | Type: xs:dateTime |
TransactionType | Indicates the type of transaction. | No | TransactionType values:
|
AmazonOrderId | An Amazon-defined identifier for an order. | No | Type: xs:string |
BaseExpense | The amount charged for clicks incurred under the Sponsored Products program. | No | Type: CurrencyAmount |
TotalExpense | The total amount charged to the seller. TotalExpense=BaseExpense+TaxTypeIGST+TaxTypeCGST+TaxTypeSGST. | No | Type: CurrencyAmount |
TaxTypeIGST | Integrated Goods and Service Tax, charged and collected by the central government. | Yes | Type: CurrencyAmount |
TaxTypeCGST | Central Goods and Service Tax, charged and collected by the central government. | Yes | Type: CurrencyAmount |
TaxTypeSGST | State Goods and Service Tax, charged and collected by the state government. | Yes | Type: CurrencyAmount |
MarketplaceId | An encrypted, Amazon-defined marketplace identifier. | No | Type: xs:string |
A charge on the seller's account.
The following table shows the elements of the ChargeComponent datatype:
Name | Description | Required | Values |
---|---|---|---|
ChargeType | The type of charge. | No | ChargeType values:
Type: xs:string |
ChargeAmount | The amount of the charge. | No | Type: CurrencyAmount |
A payment instrument.
The following table shows the elements of the ChargeInstrument datatype:
Name | Description | Required | Values |
---|---|---|---|
Description | A short description of the charge instrument. | No |
Type: xs:string |
Tail | The account tail (trailing digits) of the charge instrument. | No | Type: xs:string |
Amount | The amount charged to this charge instrument. | No | Type: CurrencyAmount |
An event related to coupon payments.
The following table shows the elements of the CouponPaymentEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
PostedDate | The date when the financial event was posted. | No | Type: xs:dateTime |
CouponId | A coupon identifier. | No | Type: xs:string |
SellerCouponDescription | The description provided by the seller when they created the coupon. | No | Type: xs:string |
ClipOrRedemptionCount | The number of coupon clips or redemptions. | No | Type: xs:int |
PaymentEventId | A payment event identifier. | No | Type: xs:string |
FeeComponent | A fee associated with the event. | No | FeeComponent |
ChargeComponent | A charge associated with the event. | No | ChargeComponent |
TotalAmount | The FeeComponent value plus the ChargeComponent value. | No | Type: CurrencyAmount |
A currency type and amount.
The following table shows the elements of the CurrencyAmount datatype:
Name | Description | Required | Values |
---|---|---|---|
CurrencyCode | The three-digit currency code in ISO 4217 format . | No | Type: xs:string |
CurrencyAmount | The currency amount. | No | Type: xs:decimal |
A debt payment or debt adjustment.
The following table shows the elements of the DebtRecoveryEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
DebtRecoveryType | The debt recovery type. | No | DebtRecoveryType values:
Type: xs:string |
RecoveryAmount | The amount applied for recovery. | No | Type: CurrencyAmount |
OverPaymentCredit | The amount returned for overpayment. | No | Type: CurrencyAmount |
DebtRecoveryItemList | A list of settlement debt recovery items. | No | Type: List of DebtRecoveryItem |
ChargeInstrumentList | A list of charge instruments used for DebtPayment or DebtPaymentFailure recovery types. | No | Type: List of ChargeInstrument |
An item of a debt payment or debt adjustment.
The following table shows the elements of the DebtRecoveryItem datatype:
Name | Description | Required | Values |
---|---|---|---|
RecoveryAmount | The amount applied for the recovery item. | No | Type: CurrencyAmount |
OriginalAmount | The original debt amount. | No | Type: CurrencyAmount |
GroupBeginDate | The beginning date of the financial event group that contains the debt. In ISO 8601 date time format. | No | Type: xs:dateTime |
GroupEndDate | The ending date of the financial event group that contains the debt. In ISO 8601 date time format. | No | Type: xs:dateTime |
A payment made directly to a seller.
The following table shows the elements of the DirectPayment datatype:
Name | Description | Required | Values |
---|---|---|---|
DirectPaymentType | The type of payment. | No | DirectPaymentType values:
Type: xs:string |
DirectPaymentAmount | The amount of the direct payment. | No | Type: CurrencyAmount |
A payment event for Fulfillment by Amazon (FBA) inventory liquidation. This event is used only in the US marketplace.
The following table shows the elements of the FBALiquidationEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
PostedDate | The date when the financial event was posted. | No | Type: xs:dateTime |
OriginalRemovalOrderId | The identifier for the original removal order. | No | Type: xs:string |
LiquidationProceedsAmount | The amount paid by the liquidator for the seller’s inventory. The seller receives this amount minus LiquidationFeeAmount. | No | Type: CurrencyAmount |
LiquidationFeeAmount | The fee charged to the seller by Amazon for liquidating the seller's FBA inventory. | No | Type: CurrencyAmount |
A fee on the seller's account.
The following table shows the elements of the FeeComponent datatype:
Name | Description | Required | Values |
---|---|---|---|
FeeType | The type of fee. | No | FeeType values: one of the Fee Types
Type: xs:string |
FeeAmount | The amount of the fee. | No | Type: CurrencyAmount |
Contains information related to a financial event group.
The following table shows the elements of the FinancialEventGroup datatype:
Name | Description | Required | Values |
---|---|---|---|
FinancialEventGroupId | A unique identifier for the financial event group. | No | Type: xs:string |
ProcessingStatus | The processing status of the financial event group indicates whether the balance of the financial event group is settled. | No | ProcessingStatus values:
|
FundTransferStatus | The status of the fund transfer. | No | Type: xs:string |
OriginalTotal | The total amount in the currency of the marketplace in which the transactions occurred. | No | Type: CurrencyAmount |
ConvertedTotal | The total amount in the currency of the marketplace in which the funds were disbursed. | No | Type: CurrencyAmount |
FundTransferDate | The date when the disbursement or charge was initiated. Only present for closed settlements. In ISO 8601 date time format. | No | Type: xs:dateTime |
TraceId | The trace ID used by sellers to look up transactions externally. | No | Type: xs:string |
AccountTail | The account tail of the payment instrument. | No | Type: xs:string |
BeginningBalance | The balance at the beginning of the settlement period. | No | Type: CurrencyAmount |
FinancialEventGroupStart | The time at which the financial event group started. In ISO 8601 date time format. | No | Type: xs:dateTime |
FinancialEventGroupEnd | The time at which the financial event group ended. In ISO 8601 date time format. | No | Type: xs:dateTime |
Contains all information related to a financial event.
The following table shows the elements of the FinancialEvents datatype:
Name | Description | Required | Values |
---|---|---|---|
ShipmentEventList | A list of shipment events. | No | Type: List of ShipmentEvent |
RefundEventList | A list of refund events. | No | Type: List of ShipmentEvent |
GuaranteeClaimEventList | A list of guarantee claim events. | No | Type: List of ShipmentEvent |
ChargebackEventList | A list of chargeback events. | No | Type: List of ShipmentEvent |
PayWithAmazonEventList | A list of Pay with Amazon events. | No | Type: List of PayWithAmazonEvent |
ServiceProviderCreditEventList | A list of service provider credit events. | No | Type: List of SolutionProviderCreditEvent |
RetrochargeEventList | A list of retrocharge events. | No | Type: List of RetrochargeEvent |
RentalTransactionEventList | A list of rental transaction events. | No | Type: List of RentalTransactionEvent |
PerformanceBondRefundEventList | A list of performance bond refund events. | No | Type: List of |
ProductAdsPaymentEventList | A list of Sponsored Products payment events. | No | Type: List of ProductAdsPaymentEvent |
ServiceFeeEventList | A list of service fee events. | No | Type: List of ServiceFeeEvent |
DebtRecoveryEventList | A list of debt recovery events. | No | Type: List of DebtRecoveryEvent |
LoanServicingEventList | A list of loan servicing events. | No | Type: List of LoanServicingEvent |
AdjustmentEventList | A list of adjustment events. | No | Type: List of AdjustmentEvent |
CouponPaymentEventList | A list of coupon payment events. | No | Type: List of CouponPaymentEvent |
SAFETReimbursementEventList | A list of SAFE-T reimbursement events. | No | Type: List of SAFETReimbursementEvent |
SellerReviewEnrollmentPaymentEventList | A list of fee payment events for the Early Reviewer Program. | No | Type: List of SellerReviewEnrollmentPaymentEvent |
FBALiquidationEventList | A list of Fulfillment by Amazon liquidation events. | No | Type: List of FBALiquidationEvent |
ImagingServicesFeeEventList | A list of Amazon Imaging service events. | No | Type: List of ImagingServicesFeeEvent |
AffordabilityExpenseEventList | A list of events related to affordability promotion expenses. | No | Type: List of AffordabilityExpenseEvent |
AffordabilityExpenseReversalEventList | A list of events related to affordability promotion expense reversals. | No | Type: List of AffordabilityExpenseReversalEvent |
NetworkComminglingTransactionEventList | A list of network commingling transaction events. | No | Type: List of NetworkComminglingTransactionEvent |
TDSReimbursementEventList | A list of TDS (Tax Deduction at Source) claim reimbursement events. | No | Type: List of TDSReimbursementEvent |
TaxWithholdingEventList | A list of tax withholding events. | No | Type: List of TaxWithholdingEvent |
CapacityReservationBillingEventList | A list of capacity reservation billing events. | No | Type: List of CapacityReservationBillingEvent |
An event related to Amazon Imaging services.
The following table shows the elements of the ImagingServicesFeeEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
ImagingRequestBillingItemID | The identifier for the imaging services request. | No | Type: xs:string |
ASIN | The Amazon Standard Identification Number (ASIN) of the item that the imaging service was requested for. | No | Type: xs:string |
PostedDate | The date when the financial event was posted. | No | Type: xs:dateTime |
FeeList | A list of fees associated with the event. | No | Type: List of FeeComponent |
A loan advance, loan payment, or loan refund.
The following table shows the elements of the LoanServicingEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
LoanAmount | The amount of the loan. | No | Type: CurrencyAmount |
SourceBusinessEventType | The type of event. | No | SourceBusinessEventType values:
Type: xs:string |
A network commingling transaction event.
The following table shows the elements of the NetworkComminglingTransactionEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
PostedDate | The date when the financial event was posted. | No | Type: xs:dateTime |
NetCoTransactionID | The identifier for the network item swap. | No | Type: xs:string |
SwapReason | The reason for the network item swap. | No | Type: xs:string |
TransactionType | The type of network item swap. | No | TransactionType value:
|
ASIN | The ASIN of the swapped item. | No | Type: xs:string |
MarketplaceId | The marketplace in which the event took place. | No | Type: xs:string |
TaxExclusiveAmount | The price of the swapped item minus TaxAmount. | No | Type: CurrencyAmount |
TaxAmount | The tax on the network item swap paid by the seller. | No | Type: CurrencyAmount |
An event related to your Pay with Amazon account.
The following table shows the elements of the PayWithAmazonEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerOrderId | An order identifier that is specified by the seller. | No | Type: xs:string |
TransactionPostedDate | The date when the payment transaction is posted. In ISO 8601 date time format. | No | Type: xs:dateTime |
BusinessObjectType | The type of business object. | No | BusinessObjectType values:
Type: xs:string |
SalesChannel | The sales channel for the transaction. | No | Type: xs:string |
Charge | The charge associated with the event. | No | Type: ChargeComponent |
FeeList | A list of fees associated with the event. | No | Type: List of FeeComponent |
PaymentAmountType | The type of payment. | No | PaymentAmountType values:
Type: xs:string |
AmountDescription | A short description of this payment event. | No | Type: xs:string |
FulfillmentChannel | The fulfillment channel. | No | FulfillmentChannel values:
Type: xs:string |
StoreName | The store name where the event occurred. | No | Type: xs:string |
A Sponsored Products payment event.
The following table shows the elements of the ProductAdsPaymentEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
postedDate | The date when the financial event was posted. | No | Type: xs:dateTime |
transactionType | Indicates if the transaction is for a charge or a refund. | No | transactionType values:
Type: xs:string |
invoiceId | Identifier for the invoice that the transaction appears in. | No | Type: xs:string |
baseValue | Base amount of the transaction, before tax. | No | Type: CurrencyAmount |
taxValue |
Tax amount of the transaction. |
No | Type: CurrencyAmount |
transactionValue |
The total amount of the transaction. Equal to baseValue + taxValue. |
No | Type: CurrencyAmount |
A promotion applied to an item.
The following table shows the elements of the Promotion datatype:
Name | Description | Required | Values |
---|---|---|---|
PromotionType | The type of promotion. | No | Type: xs:string |
PromotionId | The seller-specified identifier for the promotion. | No | Type: xs:string |
PromotionAmount | The amount of promotional discount applied to the item. | No | Type: CurrencyAmount |
An event related to a rental transaction.
The following table shows the elements of the RentalTransactionEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
AmazonOrderId | An Amazon-defined identifier for an order. | No | Type: xs:string |
RentalEventType | The type of rental event. | No | RentalEventType values:
Type: xs:string |
ExtensionLength | The number of days that the buyer extended an already rented item. This value is only returned for RentalCustomerPayment-Extension and RentalCustomerRefund-Extension events. | No | Type: xs:int |
PostedDate | The date when the financial event was posted. | No | Type: xs:dateTime |
RentalChargeList | A list of charges associated with the rental event. | No | Type: List of ChargeComponent |
RentalFeeList | A list of fees associated with the rental event. | No | Type: List of FeeComponent |
MarketplaceName | The name of the marketplace. | No | Type: xs:string |
RentalInitialValue | The amount of money the customer originally paid to rent the item. This value is only returned for RentalChargeFailureReimbursement and RentalLostItemReimbursement events. | No | Type: CurrencyAmount |
RentalReimbursement | The amount of money Amazon sends the seller to compensate for a lost item or a failed charge. This value is only returned for RentalChargeFailureReimbursement and RentalLostItemReimbursement events. | No | Type: CurrencyAmount |
RentalTaxWithheldList | A list of TaxWithheldComponent elements for a rental item. | No | Type: List of TaxWithheldComponent |
A retrocharge or retrocharge reversal.
The following table shows the elements of the RetrochargeEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
RetrochargeEventType | The type of event. | No | RetrochargeEventType values:
Type: xs:string |
AmazonOrderId | An Amazon-defined identifier for an order. | No | Type: xs:string |
PostedDate | The date when the financial event was posted. | No | Type: xs:dateTime |
BaseTax | The base tax associated with the retrocharge event. | No | Type: CurrencyAmount |
ShippingTax | The shipping tax associated with the retrocharge event. | No | Type: CurrencyAmount |
MarketplaceName | The name of the marketplace where the retrocharge event occurred. | No | Type: xs:string |
RetrochargeTaxWithheldComponentList | A list of TaxWithheldComponent elements for Marketplace Facilitator taxes withheld. | No | Type: List of TaxWithheldComponent |
A SAFE-T claim reimbursement on your account.
The following table shows the elements of the SAFETReimbursementEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
PostedDate | The date when the financial event was posted. | No | Type: xs:dateTime |
SAFETClaimId | A SAFE-T claim identifier. | No | Type: xs:string |
ReimbursedAmount | The amount of the reimbursement. | No | Type: CurrencyAmount |
SAFETReimbursementItemList | A list of SAFE-T reimbursement items. | No | Type: List of SAFETReimbursementItem |
An item from a SAFE-T claim reimbursement.
The following table shows the elements of the SAFETReimbursementItem datatype:
Name | Description | Required | Values |
---|---|---|---|
ItemChargeList | A list of charges associated with the reimbursement item. | No | Type: List of ChargeComponent |
A fee payment event for the Early Reviewer Program. This element is used only in the US marketplace.
The following table shows the elements of the SellerReviewEnrollmentPaymentEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
PostedDate | The date when the financial event was posted. | No. | Type: xs:dateTime |
EnrollmentId | An enrollment identifier. | No. | Type: xs:string |
ParentASIN | The ASIN that was enrolled in the Early Reviewer Program. | No. | Type: xs:string |
FeeComponent | A fee associated with the event. | No. | Type: FeeComponent |
ChargeComponent | A charge associated with the event. | No. | Type: ChargeComponent |
TotalAmount | The FeeComponent value plus the ChargeComponent value. | No. | Type: CurrencyAmount |
A service fee on your account.
The following table shows the elements of the ServiceFeeEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
AmazonOrderId | An Amazon-defined identifier for an order. | No | Type: xs:string |
FeeReason | A short description of the service fee reason. | No | Type: xs:string |
FeeList | A list of fee components associated with the service fee. | No | Type: List of FeeComponent |
SellerSKU | The Seller SKU of the item. The Seller SKU is qualified by your Seller ID, which is included with every call to Amazon MWS. | No | Type: xs:string |
FnSKU | A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center. | No | Type: xs:string |
FeeDescription | A short description of the service fee event. | No | Type: xs:string |
ASIN | The ASIN of the item. | No | Type: xs:string |
A shipment, refund, guarantee claim, or chargeback.
The following table shows the elements of the ShipmentEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
AmazonOrderId | An Amazon-defined identifier for an order. | No | Type: xs:string |
SellerOrderId | A seller-defined identifier for an order. | No | Type: xs:string |
MarketplaceName | The name of the marketplace where the event occurred. | No | Type: xs:string |
OrderChargeList | A list of order-level charges. These charges are applicable to Multi-Channel Fulfillment COD orders. | No | Type: List of ChargeComponent |
OrderChargeAdjustmentList | A list of order-level charge adjustments. These adjustments are applicable to Multi-Channel Fulfillment COD orders. | No | Type: List of ChargeComponent |
ShipmentFeeList | A list of shipment-level fees. | No | Type: List of FeeComponent |
ShipmentFeeAdjustmentList | A list of shipment-level fee adjustments. | No | Type: List of FeeComponent |
OrderFeeList | A list of order-level fees. These charges are applicable to Multi-Channel Fulfillment orders. | No | Type: List of FeeComponent |
OrderFeeAdjustmentList | A list of order-level fee adjustments. These adjustments are applicable to Multi-Channel Fulfillment orders. | No | Type: List of FeeComponent |
DirectPaymentList | A list of transactions where buyers pay Amazon through one of the credit cards offered by Amazon or where buyers pay a seller directly through COD. | No | Type: List of DirectPayment |
PostedDate | The date when the financial event was posted. | No | Type: xs:dateTime |
ShipmentItemList | A list of shipment items. | No | Type: List of ShipmentItem |
ShipmentItemAdjustmentList | A list of shipment item adjustments. | No | Type: List of ShipmentItem |
An item of a shipment, refund, guarantee claim, or chargeback.
The following table shows the elements of the ShipmentItem datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerSKU | The Seller SKU of the item. The Seller SKU is qualified by your Seller ID, which is included with every call to Amazon MWS. | No | Type: xs:string |
OrderItemId | An Amazon-defined order item identifier. | No | Type: xs:string |
OrderAdjustmentItemId | An Amazon-defined order adjustment identifier defined for refunds, guarantee claims, and chargeback events. | No | Type: xs:string |
QuantityShipped | The number of items shipped. | No | Type: xs:int |
ItemChargeList | A list of charges associated with the shipment item. | No | Type: List of ChargeComponent |
ItemTaxWithheldList | A list of TaxWithheldComponent elements for a shipment item. | No | Type: List of TaxWithheldComponent |
ItemChargeAdjustmentList | A list of charge adjustments associated with the shipment item. This value is only returned for refunds, guarantee claims, and chargeback events. | No | Type: List of ChargeComponent |
ItemFeeList | A list of fees associated with the shipment item. | No | Type: List of FeeComponent |
ItemFeeAdjustmentList | A list of fee adjustments associated with the shipment item. This value is only returned for refunds, guarantee claims, and chargeback events. | No | Type: List of FeeComponent |
PromotionList | A list of promotions associated with the shipment item. | No | Type: List of Promotion |
PromotionAdjustmentList | A list of promotion adjustments associated with the shipment item. This value is only returned for refunds, guarantee claims, and chargeback events. | No | Type: List of Promotion |
CostOfPointsGranted | The cost of Amazon Points granted for a shipment item. | No | Type: CurrencyAmount |
CostOfPointsReturned | The cost of Amazon Points returned for a shipment item. This value is only returned for refunds, guarantee claims, and chargeback events. | No | Type: CurrencyAmount |
A credit given to a solution provider.
The following table shows the elements of the SolutionProviderCreditEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
ProviderTransactionType | The transaction type. | No | ProviderTransactionType values:
Type: xs:string |
SellerOrderId | A seller-defined identifier for an order. | No | Type: xs:string |
MarketplaceId | The identifier of the marketplace where the order was placed. | No | Type: xs:string |
MarketplaceCountryCode | The two-letter country code of the country associated with the marketplace where the order was placed. | No | Type: xs:string |
SellerId | The Amazon-defined identifier of the seller. | No | Type: xs:string |
SellerStoreName | The store name where the payment event occurred. | No | Type: xs:string |
ProviderId | The Amazon-defined identifier of the solution provider. | No | Type: xs:string |
ProviderStoreName | The store name where the payment event occurred. | No | Type: xs:string |
A TDS (Tax Deduction at Source) claim reimbursement on the seller's account.
The following table shows the elements of the TDSReimbursementEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
PostedDate | The date when the financial event was posted. | No | Type: xs:dateTime |
TdsOrderId | A TDS claim identifier. | No | Type: xs:string |
ReimbursedAmount | The amount of the reimbursement. | No | Type: CurrencyAmount |
Information about the taxes withheld.
The following table shows the elements of the TaxWithheldComponent datatype:
Name | Description | Required | Values |
---|---|---|---|
TaxCollectionModel | The tax collection model applied to the item. | No | TaxCollectionModel value:
|
TaxesWithheld | A list of ChargeComponent elements that represent the types and amounts of taxes withheld. | No | Type: List of ChargeComponent ChargeType values for TaxesWithheld are MarketplaceFacilitatorTax-Principal, MarketplaceFacilitatorTax-Shipping, MarketplaceFacilitatorTax-GiftWrap, and MarketplaceFacilitatorTax-Other. |
A tax withholding event.
The following table shows the elements of the TaxWithholdingEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
BaseAmount | The base amount from which the tax deduction is calculated. | No | CurrencyAmount |
WithheldAmount | The amount of tax deducted from the seller’s balance and remitted to the taxing authority. | No | CurrencyAmount |
PostedDate | The date when the financial event was posted. | No | Type: xs:dateTime |
TaxWithholdingPeriod | The period in which the tax is calculated and withheld. | No | Type: TaxWithholdingPeriod |
A tax withholding period.
The following table shows the elements of the TaxWithholdingPeriod datatype:
Name | Description | Required | Values |
---|---|---|---|
StartDateMillis | The start time for the period in which the tax is calculated and withheld. Epoch value in milliseconds. | No | Type: xs:long |
EndDateMillis | The end time for the period in which the tax is calculated and withheld. Epoch value in milliseconds. | No | Type: xs:long |
An event related to a capacity reservation billing charge.
The following table shows the elements of the CapacityReservationBillingEvent datatype:
Name | Description | Required | Values |
---|---|---|---|
TransactionType | Indicates the type of transaction. | No | Type: xs:string |
PostedDate | The date and time when the financial event was posted. | No | Type: xs:dateTime |
Description | A short description of the capacity reservation billing event. | No | Type: xs:string |
TransactionAmount | The amount of the capacity reservation billing event. | No | Type: CurrencyAmount |