The deactivation of MWS starts on July 31 2022
The migration to the Amazon SP-API is urgent, as the first Amazon MWS API sections will be deprecated in July. Amazon is starting the end of the Marketplace Web Service for all third-party tools with the deprecation of the MWS Merchant Fulfillment, Orders, and Reports API section on July 31, 2022. Followed by the MWS Products section on September 30, 2022 and finally all other MWS sections on December 31, 2022.
Who should migrate to the SP-API?
Since Amazon will keep up MWS for Sellers who directly integrate with the Marketplace Web Service through a self-developed connection, not everyone needs to migrate to the Selling Partner API.
You should migrate to the SP-API when you:
- use a third-party (public) application to connect to Amazon’s MWS currently
- want to benefit from a maintained state-of-the-art API and all its future developments
- are an Amazon Vendor and would like to access your Amazon data via an API for the first time
SP-API migration made easy with Pipes
Re-configuration of existing MWS data pipelines is unavoidable
Amazon decided that the efficiency of the SP-API, like the naming of the API sections, should reflect the present day situation better. Due to these differences between the SP-API and the MWS, there will be compatibility issues when migrating to the Selling Partner API. The data, while representing the same objects, e.g. orders, financial events, inventory items, etc., is provided by the new Amazon API in a different way.
Consequently, it will not be possible to reconfigure existing data pipelines from the new SP-API connector into existing tables populated by the MWS connector. Because of this, migration to the new connector, and the new API, requires that the current Amazon MWS data pipelines for the SP-API be re-created from scratch.
See here how the MWS API sections map to the SP-API operations:
| Amazon MWS sections | Amazon SP-API sections |
| Feeds API section | Feeds API |
| Finances API section | Finances API |
| Fulfillment Inbound Shipment API section | Fulfillment Inbound API |
| Fulfillment Inventory API section | FBA Inventory API |
| Fulfillment Outbound Shipment API section | Fulfillment Outbound API |
| Merchant Fulfillment API section | Merchant Fulfillment API |
| Orders API section | Orders API |
| Products API section: Product Fees | Product Fees API |
| Products API section: Product Listings | Catalog Items API |
| Products API section: Product Pricing | Product Pricing API |
| Recommendations API section | Deprecated in the SP-API |
| Reports API section | Reports API |
| Sellers API section | Sellers API |
| Subscriptions API section | Notifications API |
With Pipes, you can easily migrate to the Selling Partner API through:
Ready-to-use SP-API data connector:
It doesn’t matter if you’re an Amazon Seller or Vendor. With the ready-to-use Amazon data connectors from Pipes, you’re able to connect to the SP-API in just a few clicks. You only need your Amazon Seller or Vendor account credentials (or you are just already logged in).
Pre-built SP-API data templates:
With the pre-built selling partner data templates, we bundled meaningful connected metrics of an Amazon selling business. You can check the metrics and the structure with which the table is created in your data warehouse before you configure a constant data pipeline between the SP-API and your data warehouse.
SP-API best-practices templates:
For a really quick and easy migration to the SP-API, we provide best-practices templates based on our experience with a variety of Amazon selling partners. These SP-API best-practices templates configure several data pipelines and schedules at once, according to the known best practices for our Selling Partner API connector. This way you cover the most important Amazon data on your business with just a few clicks.
SP-API best-practices template I: Order data, popular FBA reports and settlement data
Detailed Active Listings Report
| Parameter | Description |
| marketplace_id | The encrypted marketplace value |
| item_name | The item name |
| item_description | The item description |
| listing_id | The listing id |
| seller_sku | Stock Keeping Units (SKUs) are unique blocks of letters and/or numbers that identify your products. SKUs are assigned by you as the seller |
| price | Price per item in the currency of the marketplace where you are listing the product. Do not include the currency symbol. This field is required. You must provide a price to make the product available for purchase on Amazon |
| quantity | The total number of units reimbursed for this line item |
| open_date | Open date |
| image_url | The image url |
| item_is_marketplace | Item is marketplace |
| product_id_type | The type of product id |
| zshop_shipping_fee | Zshop shipping fee |
| item_note | The item note |
| item_condition | Numeric entry that indicates the condition of the product. This field is required. Note: Not all conditions are available for all categories. For more information about what conditions you may use in your product category, see Condition Guidelines |
| zshop_category1 | Zshop category1 |
| zshop_browse_path | Zshop browse path |
| zshop_storefront_feature | Zshop storefront feature |
| asin1 | The Amazon Standard Identification Number (ASIN) of the item |
| asin2 | The Amazon Standard Identification Number (ASIN) of the item |
| asin3 | The Amazon Standard Identification Number (ASIN) of the item |
| will_ship_internationally | Will ship internationally |
| expedited_shipping | Expedited shipping |
| zshop_boldface | Zshop boldface |
| product_id | The product id |
| bid_for_featured_placement | The bid for featured placement |
| add_delete | Add delete |
| pending_quantity | Pending quantity |
| fulfillment_channel | Indicates how the order was fulfilled, via Amazon (AFN) or Merchant (MFN) |
| Business_Price | A special price that is available only for Amazon Business orders |
| Quantity_Price_Type | Quantity price type |
| Quantity_Lower_Bound_1 | Quantity lower bound |
| Quantity_Price_1 | Quantity price |
| Quantity_Lower_Bound_2 | Quantity lower bound |
| Quantity_Price_2 | Quantity price |
| Quantity_Lower_Bound_3 | Quantity lower bound |
| Quantity_Price_3 | Quantity price |
| Quantity_Lower_Bound_4 | Quantity lower bound |
| Quantity_Price_4 | Quantity price |
| Quantity_Lower_Bound_5 | Quantity lower bound |
| Quantity_Price_5 | Quantity price |
| merchant_shipping_group | The merchant shipping group |
| Progressive_Price_Type | Progressive price type |
| Progressive_Lower_Bound_1 | Progressive lower bound |
| Progressive_Price_1 | Progressive price |
| Progressive_Lower_Bound_2 | Progressive lower bound |
| Progressive_Price_2 | Progressive price |
| Progressive_Lower_Bound_3 | Progressive lower bound |
| Progressive_Price_3 | Progressive price |
Estimated Amazon Selling and Fulfillment Fees for the seller’s FBA inventory with active offers
| Parameter | Description |
| sku | Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify your products. SKUs are assigned by you as the seller |
| fnsku | Unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center |
| asin | Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters or numbers that identify products. ASINs are assigned by Amazon. You can find the ASIN on the product detail page |
| product_name | The title of your product |
| product_group | The Amazon department or category |
| brand | The brand of your product |
| fulfilled_by | The entity that fulfilled the item |
| your_price | Your current selling price |
| sales_price | Your current promotional price |
| longest_side | Measurement of the longest side of your product including its packaging |
| median_side | Measurement of the side that is neither the longest nor the shortest side of your product including its packaging |
| shortest_side | Measurement of the shortest side of your product including its packaging |
| length_and_girth | The longest side of your product, including its packaging, plus the girth, a unit measure, equivalent to 2 x (median side + shortest side) |
| unit_of_dimension | The unit of dimension |
| item_package_weight | The item package weight |
| unit_of_weight | The unit of weight used in weight measurement |
| product_size_tier | The size tier assigned to your product by FBA based on its dimensions and weight |
| currency | The currency in which the fee is calculated |
| estimated_fee_total | The estimated fulfillment and Selling on Amazon fee |
| estimated_referral_fee_per_unit | The estimated Selling on Amazon Referral Fee |
| estimated_variable_closing_fee | The estimated Variable Closing Fee for your product |
| estimated_order_handling_fee_per_order | The estimated Order Handling Fee per order |
| estimated_pick_pack_fee_per_unit | Estimated pick pack fee per unit |
| estimated_weight_handling_fee_per_unit | The estimated Weight Handling Fee for your product based on the Outbound Shipping Weight |
| expected_fulfillment_fee_per_unit | Expected fulfillment fee per unit |
Current details of active (not archived) inventory
| Parameter | Description |
| sku | Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify your products |
| fnsku | Fulfillment Network Stock Keeping Units (FNSKUs) are unique identifiers assigned by Amazon to products stored in and fulfilled from Amazon fulfillment centers |
| asin | Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters or numbers that identify items. ASINs are assigned by Amazon. You can find the ASIN on the product detail page |
| product_name | The title of your product |
| condition | The condition of your product |
| your_price | Your current selling price |
| mfn_listing_exists | “Yes” indicates that the product is listed for fulfillment by you as the seller |
| mfn_fulfillable_quantity | The quantity in your fulfillment network that can be picked, packed, and shipped |
| afn_listing_exists | “Yes” indicates that the item is listed for Fulfillment by Amazon |
| afn_warehouse_quantity | The number of units you have for an SKU in Amazon fulfillment centers that have been processed: (afn-warehouse-quantity) = (afn-fulfillable-quantity) + (afn-unsellable-quantity) + (afn-reserved-quantity) |
| afn_fulfillable_quantity | The number of units you have for a SKU in Amazon fulfillment centers that can be picked, packed, and shipped |
| afn_unsellable_quantity | The number of units you have for a SKU in Amazon fulfillment centers in unsellable condition |
| afn_reserved_quantity | The number of units you have for a SKU in Amazon fulfillment centers that are currently being picked, packed, and shipped or are sidelined for measurement, sampling, or other internal processes |
| afn_total_quantity | The total number of units you have for a SKU in an inbound shipment or in Amazon fulfillment centers: (afn-total-quantity) = (afn-warehouse-quantity) + (afn-inbound-working-quantity) + (afn-inbound-shipped-quantity) + (afn-inbound-receiving-quantity) |
| per_unit_volume | The volume in cubic feet of one unit (to the nearest 1/100 of an inch) |
| afn_inbound_working_quantity | The number of units you have for a SKU in an inbound shipment that you have notified Amazon about |
| afn_inbound_shipped_quantity | The number of units you have for a SKU in an inbound shipment that you have notified Amazon about and provided a tracking number |
| afn_inbound_receiving_quantity | The number of units you have for a SKU that have not yet been received at an Amazon fulfillment center for processing, but are part of an inbound shipment with some units that have already been received and processed |
| afn_researching_quantity | Afn researching quantity |
| afn_reserved_future_supply | The number of units that customers have purchased while inventory is on its way to an Amazon fulfillment center through In-Stock Head Start |
| afn_future_supply_buyable | The number of units available for customers to find and buy while inventory is on its way to an Amazon fulfillment center through In-Stock Head Start |
Number of reserved units in a seller’s inventory
| Parameter | Description |
| marketplace_id | The encrypted marketplace value |
| sku | Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify your products. SKUs are assigned by you as the seller |
| fnsku | Unique identifier assigned by Amazon to items stored in and fulfilled from an Amazon fulfillment center |
| asin | Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters or numbers that identify items. ASINs are assigned by Amazon. You can find the ASIN on the product detail page |
| product_name | The title of your product |
| reserved_qty | The total number of units in reserved status |
| reserved_customerorders | The number of units reserved for customer orders |
| reserved_fc_transfers | The number of units being transferred from one fulfillment center to another |
| reserved_fc_processing | The number of units that have been sidelined at the fulfillment center for additional processing |
Financial Events
| Parameter | Description |
| PostedDate | The date and time when the financial event was posted |
| EventName | |
| ASIN | The Amazon Standard Identification Number (ASIN) of the item |
| AdjustmentAmount_CurrencyAmount | The monetary value |
| AdjustmentAmount_CurrencyCode | The three-digit currency code in ISO 4217 format |
| AdjustmentType | The type of adjustment. Possible values: FBAInventoryReimbursement – An FBA inventory reimbursement to a seller’s account. This occurs if a seller’s inventory is damaged; ReserveEvent – A reserve event that is generated at the time of a settlement period closing. This occurs when some money from a seller’s account is held back; PostageBilling – The amount paid by a seller for shipping labels; PostageRefund – The reimbursement of shipping labels purchased for orders that were canceled or refunded; LostOrDamagedReimbursement – An Amazon Easy Ship reimbursement to a seller’s account for a package that we lost or damaged; CanceledButPickedUpReimbursement – An Amazon Easy Ship reimbursement to a seller’s account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace; ReimbursementClawback – An Amazon Easy Ship reimbursement clawback from a seller’s account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace; SellerRewards – An award credited to a seller’s account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace; |
| AmazonOrderId | An Amazon-defined identifier for an order |
| AmountDescription | A short description of this payment event |
| BaseExpense_CurrencyAmount | The monetary value |
| BaseExpense_CurrencyCode | The three-digit currency code in ISO 4217 format |
| BaseTax_CurrencyAmount | The monetary value |
| BaseTax_CurrencyCode | The three-digit currency code in ISO 4217 format |
| BaseValue_CurrencyAmount | The monetary value |
| BaseValue_CurrencyCode | The three-digit currency code in ISO 4217 format |
| BusinessObjectType | The type of business object |
| ChargeComponent_ChargeAmount_CurrencyAmo… | |
| ChargeComponent_ChargeAmount_CurrencyCod… | |
| ChargeComponent_ChargeType | |
| Charge_ChargeAmount_CurrencyAmount | |
| Charge_ChargeAmount_CurrencyCode | |
| Charge_ChargeType | |
| ClipOrRedemptionCount | The number of coupon clips or redemptions |
| CouponId | A coupon identifier |
| DealDescription | The internal description of the deal |
| DealId | The unique identifier of the deal |
| DebtRecoveryType | The debt recovery type. Possible values: DebtPayment; DebtPaymentFailure; DebtAdjustment; |
| EnrollmentId | An enrollment identifier |
| EventType | The type of event: SellerDealComplete |
| 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 |
| FeeAmount_CurrencyAmount | The monetary value |
| FeeAmount_CurrencyCode | The three-digit currency code in ISO 4217 format |
| FeeComponent_FeeAmount_CurrencyAmount | The monetary value |
| FeeComponent_FeeAmount_CurrencyCode | The three-digit currency code in ISO 4217 format |
| FeeComponent_FeeType | The type of fee. For more information about Selling on Amazon fees, see Selling on Amazon Fee Schedule on Seller Central. For more information about Fulfillment by Amazon fees, see FBA features, services and fees on Seller Central |
| FeeDescription | A short description of the service fee event |
| FeeReason | A short description of the service fee reason |
| FeeType | The type of fee: RunLightningDealFee |
| FnSKU | A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center |
| FulfillmentChannel | The fulfillment channel. Possible values: AFN – Amazon Fulfillment Network (Fulfillment by Amazon); MFN – Merchant Fulfillment Network (self-fulfilled); |
| ImagingRequestBillingItemID | The identifier for the imaging services request |
| InvoiceId | Identifier for the invoice that the transaction appears in |
| LiquidationFeeAmount_CurrencyAmount | The monetary value |
| LiquidationFeeAmount_CurrencyCode | The three-digit currency code in ISO 4217 format |
| LiquidationProceedsAmount_CurrencyAmount | The monetary value |
| LiquidationProceedsAmount_CurrencyCode | The three-digit currency code in ISO 4217 format |
| LoanAmount_CurrencyAmount | The monetary value |
| LoanAmount_CurrencyCode | The three-digit currency code in ISO 4217 format |
| MarketplaceCountryCode | The two-letter country code of the country associated with the marketplace where the order was placed |
| MarketplaceId | An encrypted, Amazon-defined marketplace identifier |
| MarketplaceName | The name of the marketplace where the event occurred |
| NetCoTransactionID | The identifier for the network item swap |
| OriginalRemovalOrderId | The identifier for the original removal order |
| OverPaymentCredit_CurrencyAmount | The monetary value |
| OverPaymentCredit_CurrencyCode | The three-digit currency code in ISO 4217 format |
| ParentASIN | The Amazon Standard Identification Number (ASIN) of the item that was enrolled in the Early Reviewer Program |
| PaymentAmountType | The type of payment. Possible values: Sales; |
| PaymentEventId | A payment event identifier |
| ProviderId | The Amazon-defined identifier of the solution provider |
| ProviderStoreName | The store name where the payment event occurred |
| ProviderTransactionType | The transaction type |
| ReasonCode | Indicates why the seller was reimbursed |
| RecoveryAmount_CurrencyAmount | The monetary value |
| RecoveryAmount_CurrencyCode | The three-digit currency code in ISO 4217 format |
| ReimbursedAmount_CurrencyAmount | The monetary value |
| ReimbursedAmount_CurrencyCode | The three-digit currency code in ISO 4217 format |
| RentalEventType | The type of rental event. Possible values: RentalCustomerPayment-Buyout – Transaction type that represents when the customer wants to buy out a rented item; RentalCustomerPayment-Extension – Transaction type that represents when the customer wants to extend the rental period; RentalCustomerRefund-Buyout – Transaction type that represents when the customer requests a refund for the buyout of the rented item; RentalCustomerRefund-Extension – Transaction type that represents when the customer requests a refund over the extension on the rented item; RentalHandlingFee – Transaction type that represents the fee that Amazon charges sellers who rent through Amazon; RentalChargeFailureReimbursement – Transaction type that represents when Amazon sends money to the seller to compensate for a failed charge; RentalLostItemReimbursement – Transaction type that represents when Amazon sends money to the seller to compensate for a lost item; |
| RentalInitialValue_CurrencyAmount | The monetary value |
| RentalInitialValue_CurrencyCode | The three-digit currency code in ISO 4217 format |
| RentalReimbursement_CurrencyAmount | The monetary value |
| RentalReimbursement_CurrencyCode | The three-digit currency code in ISO 4217 format |
| RetrochargeEventType | The type of event. Possible values: Retrocharge; RetrochargeReversal; |
| SAFETClaimId | A SAFE-T claim identifier |
| SalesChannel | The sales channel for the transaction |
| SellerCouponDescription | The description provided by the seller when they created the coupon |
| SellerId | The Amazon-defined identifier of the seller |
| SellerOrderId | A seller-defined identifier for an order |
| SellerSKU | The seller SKU of the item. The seller SKU is qualified by the seller’s seller ID, which is included with every call to the Selling Partner API |
| SellerStoreName | The store name where the payment event occurred |
| ShippingTax_CurrencyAmount | The monetary value |
| ShippingTax_CurrencyCode | The three-digit currency code in ISO 4217 format |
| SourceBusinessEventType | The type of event. Possible values: LoanAdvance; LoanPayment; LoanRefund; |
| StoreName | The store name where the event occurred |
| SwapReason | The reason for the network item swap |
| TaxAmount_CurrencyAmount | The monetary value |
| TaxAmount_CurrencyCode | The three-digit currency code in ISO 4217 format |
| TaxExclusiveAmount_CurrencyAmount | The monetary value |
| TaxExclusiveAmount_CurrencyCode | The three-digit currency code in ISO 4217 format |
| TaxTypeCGST_CurrencyAmount | The monetary value |
| TaxTypeCGST_CurrencyCode | The three-digit currency code in ISO 4217 format |
| TaxTypeIGST_CurrencyAmount | The monetary value |
| TaxTypeIGST_CurrencyCode | The three-digit currency code in ISO 4217 format |
| TaxTypeSGST_CurrencyAmount | The monetary value |
| TaxTypeSGST_CurrencyCode | The three-digit currency code in ISO 4217 format |
| TaxValue_CurrencyAmount | The monetary value |
| TaxValue_CurrencyCode | The three-digit currency code in ISO 4217 format |
| TotalAmount_CurrencyAmount | The monetary value |
| TotalAmount_CurrencyCode | The three-digit currency code in ISO 4217 format |
| TotalExpense_CurrencyAmount | The monetary value |
| TotalExpense_CurrencyCode | The three-digit currency code in ISO 4217 format |
| TransactionAmount_CurrencyAmount | The monetary value |
| TransactionAmount_CurrencyCode | The three-digit currency code in ISO 4217 format |
| TransactionCreationDate | The date and time that the credit transaction was created, in ISO 8601 date time format |
| TransactionPostedDate | The date and time when the payment transaction is posted. In ISO 8601 date time format |
| TransactionType | Indicates if the transaction is for a charge or a refund. Possible values: charge – Charge; refund – Refund; |
| TransactionValue_CurrencyAmount | The monetary value |
| TransactionValue_CurrencyCode | The three-digit currency code in ISO 4217 format |
Order data delivered by the fast reporting API, less detail than slow orders API
| Parameter | Description |
| AmazonOrderID | Amazon Order ID |
| MerchantOrderID | Merchant Order ID |
| PurchaseDate | Purchase Date |
| LastUpdatedDate | Last Updated Date |
| OrderStatus | Order Status |
| SalesChannel | Sales Channel |
| FulfillmentData_FulfillmentChannel | Fulfillment Channe lD |
| FulfillmentData_ShipServiceLevel | Fulfillment Data: Address City |
| FulfillmentData_Address_Country | Fulfillment Data: Address Country |
| FulfillmentData_Address_State | Fulfillment Data: Address State |
| FulfillmentData_Address_PostalCode | FulfillmentData Address PostalCode |
| FulfillmentData_Address_City | Fulfillment Data: Address City |
| IsBusinessOrder | Is Business Order |
| Parameter | Description |
| AmazonOrderId | An Amazon-defined order identifier, in 3-7-7 format |
| AssignedShipFromLocationAddress_AddressL… | The street address |
| AssignedShipFromLocationAddress_AddressL… | Additional street address information, if required |
| AssignedShipFromLocationAddress_AddressL… | Additional street address information, if required |
| AssignedShipFromLocationAddress_AddressT… | The address type of the shipping address |
| AssignedShipFromLocationAddress_City | The city |
| AssignedShipFromLocationAddress_CountryC… | The country code. A two-character country code, in ISO 3166-1 alpha-2 format |
| AssignedShipFromLocationAddress_County | The county |
| AssignedShipFromLocationAddress_District | The district |
| AssignedShipFromLocationAddress_Municipa… | The municipality |
| AssignedShipFromLocationAddress_Name | The name |
| AssignedShipFromLocationAddress_Phone | The phone number. Not returned for Fulfillment by Amazon (FBA) orders |
| AssignedShipFromLocationAddress_PostalCo… | The postal code |
| AssignedShipFromLocationAddress_StateOrR… | The state or region |
| CbaDisplayableShippingLabel | Custom ship label for Checkout by Amazon (CBA) |
| EarliestDeliveryDate | The start of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders |
| EarliestShipDate | The start of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders. Note: EarliestShipDate might not be returned for orders placed before February 1, 2013 |
| EasyShipShipmentStatus | The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders. Possible values: PendingPickUp, LabelCanceled, PickedUp, OutForDelivery, Damaged, Delivered, RejectedByBuyer, Undeliverable, ReturnedToSeller, ReturningToSeller |
| FulfillmentChannel | Whether the order was fulfilled by Amazon (AFN) or by the seller (MFN) |
| FulfillmentInstruction_FulfillmentSupply… | Denotes the recommended sourceId where the order should be fulfilled from |
| IsBusinessOrder | When true, the order is an Amazon Business order. An Amazon Business order is an order where the buyer is a Verified Business Buyer |
| IsEstimatedShipDateSet | When true, the estimated ship date is set for the order. Returned only for Sourcing on Demand orders |
| IsGlobalExpressEnabled | When true, the order is a GlobalExpress order |
| IsPremiumOrder | When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, see “Premium Shipping Options” in the Seller Central Help for your marketplace |
| IsPrime | When true, the order is a seller-fulfilled Amazon Prime order |
| IsReplacementOrder | When true, this is a replacement order |
| IsSoldByAB | When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller |
| LastUpdateDate | The date when the order was last updated. Note: LastUpdateDate is returned with an incorrect date for orders that were last updated before 2009-04-01 |
| LatestDeliveryDate | The end of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders that do not have a PendingAvailability, Pending, or Canceled status |
| LatestShipDate | The end of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders. Note: LatestShipDate might not be returned for orders placed before February 1, 2013 |
| MarketplaceId | The identifier for the marketplace where the order was placed |
| NumberOfItemsShipped | The number of items shipped |
| NumberOfItemsUnshipped | The number of items unshipped |
| OrderChannel | The order channel of the first item in the order |
| OrderStatus | The current order status |
| OrderTotal_Amount | The currency amount |
| OrderTotal_CurrencyCode | The three-digit currency code. In ISO 4217 format |
| OrderType | The type of the order |
| PaymentMethod | The payment method for the order. This property is limited to Cash On Delivery (COD) and Convenience Store (CVS) payment methods. Unless you need the specific COD payment information provided by the PaymentExecutionDetailItem object, we recommend using the PaymentMethodDetails property to get payment method information |
| PaymentMethodDetails | A list of payment methods for the order |
| PromiseResponseDueDate | Indicates the date by which the seller must respond to the buyer with an estimated ship date. Returned only for Sourcing on Demand orders |
| PurchaseDate | The date when the order was created |
| ReplacedOrderId | The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true |
| SalesChannel | The sales channel of the first item in the order |
| SellerOrderId | A seller-defined order identifier |
| ShipServiceLevel | The shipment service level of the order |
| ShipmentServiceLevelCategory | The shipment service level category of the order. Possible values: Expedited, FreeEconomy, NextDay, SameDay, SecondDay, Scheduled, Standard |
Recommendations on products to restock
| Parameter | Description |
| marketplace_id | The encrypted marketplace value |
| Country | Country in which your products are stored |
| Product_Name | Product Name |
| FNSKU | A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center |
| Merchant_SKU | Merchant SKU |
| ASIN | The Amazon Standard Identification Number of the item |
| Condition | The condition of your product |
| Supplier | Supplier |
| Supplier_part_no_ | Supplier part no |
| Currency_code | Currency code |
| Price | Price per item in the currency of the marketplace where you are listing the product. Do not include the currency symbol. This field is required. You must provide a price to make the product available for purchase on Amazon |
| Sales_last_30_days | Sales last 30 days |
| Units_Sold_Last_30_Days | Units Sold Last 30 Days |
| Total_Units | Total Units |
| Inbound | Inbound |
| Available | Available |
| FC_transfer | FC transfer |
| FC_Processing | FC Processing |
| Customer_Order | Customer Order |
| Unfulfillable | Unfulfillable |
| Fulfilled_by | Fulfilled by |
| Days_of_Supply | Days of Supply |
| Alert | Alert |
| Recommended_replenishment_qty | Recommended replenishment qty |
| Recommended_ship_date | Recommended ship date |
| Inventory_level_thresholds_published_Cur… | Inventory level threshold’s published – Current Month |
| Current_month_Very_low_inventory_thresho… | Current month – Very low inventory threshold |
| Current_month_Minimum_inventory_threshol… | Current month – Minimum inventory threshold |
| Current_month_Maximum_inventory_threshol… | Current month – Maximum inventory threshold |
| Current_month_Very_high_inventory_thresh… | Current month – Very high inventory threshold |
| Inventor_level_thresholds_published_Next… | Next month – Very low inventory threshold |
| Next_month_Very_low_inventory_threshold | Inventory level threshold’s published – Next Month |
| Next_month_Minimum_inventory_threshold | Next month – Minimum inventory threshold |
| Next_month_Maximum_inventory_threshold | Next month – Maximum inventory threshold |
| Next_month_Very_high_inventory_threshold | Next month – Very high inventory threshold |
| Utilization | Utilization |
| Maximum_shipment_quantity | Maximum shipment quantity |
| Parameter | Description |
| reportId | The identifier for the report. This identifier is unique only in combination with a seller ID |
| reportCreatedTime | The date and time when the report was created |
| order_id | Amazon’s unique, displayable identifier for an order. This is an alphanumeric value. Go to Manage Orders to search for an order ID that includes letters, as they are not searchable in all tools |
| posted_date | The date that the item (order, adjustment, misc or other) was debited or credited to the seller’s account. This is an alphanumeric value. The total number of characters is 25 |
| settlement_id | Amazon’s unique identifier for the settlement being reported. This is a numeric value. The minimum number of digits is 1 and the maximum number is 20 |
| settlement_start_date | The start date of the settlement period. This is an alphanumeric value. The total number of characters is 25. (Greenwich Mean Time) |
| settlement_end_date | The end date of the settlement period. This is an alphanumeric value. The total number of characters is 25. (Greenwich Mean Time) |
| deposit_date | The date that the fund transfer for the settlement period will be sent to the seller’s bank account. This is an alphanumeric value. The total number of characters is 25. (Greenwich Mean Time) |
| total_amount | The sales amount to be deposited into the seller’s bank account |
| currency | Currency code for the marketplace, which is also the currency code for all prices listed in the records |
| sku | The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product |
| adjustment_id | Transaction ID for Adjustments |
| direct_payment_amount | Direct payment amount |
| direct_payment_type | Direct payment type |
| fulfillment_id | Indicates how the order was fulfilled, via Amazon (AFN) or Merchant (MFN) |
| item_related_fee_amount | The amount of a particular fee charged in relation to this item |
| item_related_fee_type | The type of fee charged in the item-related-fee-amount column |
| marketplace_name | The name of the marketplace where the order was placed. This value is a string with a maximum length of 50 characters |
| merchant_adjustment_item_id | Merchant adjustment item id |
| merchant_order_id | ID assigned by Amazon or sellers |
| merchant_order_item_id | Merchant order item id |
| misc_fee_amount | No longer used |
| order_fee_amount | The amount of a particular fee charged for this order. This is a numeric value, with a maximum of 18 digits to the left of the decimal point and 2 digits to the right of the decimal point |
| order_fee_type | The type of fee charged in the order-fee-amount column |
| order_item_code | Amazon’s unique, displayable identifier for an item within the order. This is a numeric value. The total number of digits is 14 |
| other_amount | Additional charges or credits that do not fall under the Order or Adjustment transaction types. The transaction type for this amount will be specified in the transaction-type column |
| other_fee_amount | The amount of miscellaneous fees charged to your seller account |
| other_fee_reason_description | Miscellaneous fees that are not related to the monthly selling plan |
| price_amount | The amount that the buyer paid for the type of price specified in the price-type column. This is a numeric value with a maximum of 18 digits to the left of the decimal point and 2 digits to the right of the decimal point |
| price_type | The type of price specified in the price-amount column |
| promotion_amount | The amount of promotional discount applied to the item due to the promotion specified in the promotion-id column. This is a numeric value with a maximum of 18 digits to the left of the decimal point and 2 digits to the right of the decimal point |
| promotion_id | Seller-specified promotion ID. This is an alphanumeric value. The maximum number of characters is 50 |
| promotion_type | The type of promotion referred to by the values in the promotion-id and promotion-amount columns |
| quantity_purchased | The number of these items that were purchased. This is a numeric value. The maximum number of digits is 12 |
| shipment_fee_amount | The amount of the shipping fee |
| shipment_fee_type | The type of shipping Fee as Order, Adjustment, or MiscEvent |
| shipment_id | Order transaction type ID |
| transaction_type | Text description of transaction type |
SP-API best-practices template II: Fine order data, delivered via slow API
| Parameter | Description |
| AmazonOrderId | An Amazon-defined order identifier, in 3-7-7 format |
| AssignedShipFromLocationAddress_AddressL… | The street address |
| AssignedShipFromLocationAddress_AddressL… | Additional street address information, if required |
| AssignedShipFromLocationAddress_AddressL… | Additional street address information, if required |
| AssignedShipFromLocationAddress_AddressT… | The address type of the shipping address |
| AssignedShipFromLocationAddress_City | The city |
| AssignedShipFromLocationAddress_CountryC… | The country code. A two-character country code, in ISO 3166-1 alpha-2 format |
| AssignedShipFromLocationAddress_County | The county |
| AssignedShipFromLocationAddress_District | The district |
| AssignedShipFromLocationAddress_Municipa… | The municipality |
| AssignedShipFromLocationAddress_Name | The name |
| AssignedShipFromLocationAddress_Phone | The phone number. Not returned for Fulfillment by Amazon (FBA) orders |
| AssignedShipFromLocationAddress_PostalCo… | The postal code |
| AssignedShipFromLocationAddress_StateOrR… | The state or region |
| CbaDisplayableShippingLabel | Custom ship label for Checkout by Amazon (CBA) |
| EarliestDeliveryDate | The start of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders |
| EarliestShipDate | The start of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders. Note: EarliestShipDate might not be returned for orders placed before February 1, 2013 |
| EasyShipShipmentStatus | The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders. Possible values: PendingPickUp, LabelCanceled, PickedUp, OutForDelivery, Damaged, Delivered, RejectedByBuyer, Undeliverable, ReturnedToSeller, ReturningToSeller |
| FulfillmentChannel | Whether the order was fulfilled by Amazon (AFN) or by the seller (MFN) |
| FulfillmentInstruction_FulfillmentSupply… | Denotes the recommended sourceId where the order should be fulfilled from |
| IsBusinessOrder | When true, the order is an Amazon Business order. An Amazon Business order is an order where the buyer is a Verified Business Buyer |
| IsEstimatedShipDateSet | When true, the estimated ship date is set for the order. Returned only for Sourcing on Demand orders |
| IsGlobalExpressEnabled | When true, the order is a GlobalExpress order |
| IsPremiumOrder | When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, see “Premium Shipping Options” in the Seller Central Help for your marketplace |
| IsPrime | When true, the order is a seller-fulfilled Amazon Prime order |
| IsReplacementOrder | When true, this is a replacement order |
| IsSoldByAB | When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller |
| LastUpdateDate | The date when the order was last updated. Note: LastUpdateDate is returned with an incorrect date for orders that were last updated before 2009-04-01 |
| LatestDeliveryDate | The end of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders that do not have a PendingAvailability, Pending, or Canceled status |
| LatestShipDate | The end of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders. Note: LatestShipDate might not be returned for orders placed before February 1, 2013 |
| MarketplaceId | The identifier for the marketplace where the order was placed |
| NumberOfItemsShipped | The number of items shipped |
| NumberOfItemsUnshipped | The number of items unshipped |
| OrderChannel | The order channel of the first item in the order |
| OrderStatus | The current order status |
| OrderTotal_Amount | The currency amount |
| OrderTotal_CurrencyCode | The three-digit currency code. In ISO 4217 format |
| OrderType | The type of the order |
| PaymentMethod | The payment method for the order. This property is limited to Cash On Delivery (COD) and Convenience Store (CVS) payment methods. Unless you need the specific COD payment information provided by the PaymentExecutionDetailItem object, we recommend using the PaymentMethodDetails property to get payment method information |
| PaymentMethodDetails | A list of payment methods for the order |
| PromiseResponseDueDate | Indicates the date by which the seller must respond to the buyer with an estimated ship date. Returned only for Sourcing on Demand orders |
| PurchaseDate | The date when the order was created |
| ReplacedOrderId | The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true |
| SalesChannel | The sales channel of the first item in the order |
| SellerOrderId | A seller-defined order identifier |
| ShipServiceLevel | The shipment service level of the order |
| ShipmentServiceLevelCategory | The shipment service level category of the order. Possible values: Expedited, FreeEconomy, NextDay, SameDay, SecondDay, Scheduled, Standard |
Pipes is an official Software Partner and Service Partner of Amazon
Pipes enables Amazon Sellers and Vendors to access the Amazon SP-API to load all their Amazon data automatically into their data warehouse on a regular basis.
You may also interested in....
Play Video
