The CData Sync App provides a straightforward way to continuously pipeline your Amazon Marketplace data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Amazon Marketplace connector can be used from the CData Sync application to pull data from Amazon Marketplace and move it to any of the supported destinations.
The Sync App leverages the Amazon Marketplace API to enable bidirectional access to Amazon Marketplace Web Services (MWS) API and Amazon Selling Partner (SP) API.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
Amazon MWS (Marketplace Web Services) API is the older API for the Amazon Marketplace while Selling Partner (SP) API provides number of improvements over MWS API including JSON-based REST API design standards and OAuth 2.0. SP-API includes all functionality available in Amazon MWS API.
You may specify which API to connect to by setting Schema. Please be aware that each API has different available connection options as described below.
When using the Amazon Selling Partner API to connect to the Amazon Marketplace, the following properties are required:
When using the Amazon MWS API to connect to the Amazon Marketplace, SellerId, Marketplace, Marketplace are required connection properties. Set Schema to Marketplace.
To connect to Amazon Marketplace first authorize CData developer. To do so follow the steps below:
Or you can go to Amazon Marketplace CData Driver and click Authorize Now on the right panel.
To obtain the MWS Auth Token, follow the steps below:
To obtain the Seller ID follow the steps below:
Set the following connection properties to connect:
Amazon Marketplace uses the OAuth authentication standard.
To authenticate using OAuth, you must either use the embedded application or create a new custom OAuth app. The embedded application supports desktop applications and headless machines. Web applications require that you create a custom OAuth application.
You can use a custom OAuth application to authenticate with a service account or a user account. See Creating a Custom OAuth App for more information.
Because Amazon Marketplace requires that embedded credentials rotate every six months, CData credentials are hosted on oa.cdata.com. If you do not specify custom credentials, the embedded credentials are downloaded from our web service and saved in the location specified in OAuthClientLocation by default. NOTE:Make sure your firewall does not block oa.cdata.com.
This section details a selection of advanced features of the Amazon Marketplace Sync App.
The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Sync App offloads as much of the SELECT statement processing as possible to Amazon Marketplace and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
The CData Sync App models Amazon Marketplace objects as relational tables and views. An Amazon Marketplace object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Amazon Marketplace APIs.
Schemas for most database objects are defined in simple, text-based configuration files.
See Marketplace Data Model for the available entities in the Marketplace API.
See Selling Partner Data Model for the available entities in the Selling Partner API.
The CData Sync App models the Amazon Marketplace API as relational views, and stored procedures.
To use Marketplace Data Model, simply set Schema to Marketplace.
Views are tables that cannot be modified, such as Orders, Products. Typically, model data that is read-only and cannot be updated are shown as views.
Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.
Created reports can be exposed as views by setting IncludeReports connection property to true. Reports can be created with the RequestReport stored procedure.
After a report has been created and finished processing with a status _DONE_ it will be exposed as a view with the name "Report{ReportType}{ReportID}".
Only Tab-Delimited reports can be used as views. You can find a full list of reports here: Report Types.
In order to avoid API throttling, it is suggested to use the CreateSchema stored procedure to create report table schemas.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Name | Description |
FeedSubmissionList | The GetFeedSubmissionList operation returns a list of feed submissions. |
FeedSubmissionResult | The GetFeedSubmissionResult operation returns the feed processing report for a specific feed. |
InboundShipmentItems | Returns a list of items in a specified inbound shipment. |
InboundShipments | Returns a list of inbound shipments based on criteria that you specify. |
InventorySupply | Returns information about the availability of inventory that a seller has in Amazon's fulfillment network and in current inbound shipments. You can check the current availability status for your Fulfillment by Amazon inventory as well as discover when availability status changes. |
OrderItems | Returns order items based on the Amazon Order Id that you specify. |
Orders | Returns orders created or updated during a time frame that you specify. |
Products | The Products Table helps you get information to match your products to existing product listings on Amazon Marketplace websites. |
ReportList | Usage information for the operation ReportList.rsd. |
ReportRequestList | Usage information for the operation ReportRequestList.rsd. |
The GetFeedSubmissionList operation returns a list of feed submissions.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM FeedSubmissionList WHERE FeedSubmissionId = '50377017868'
SELECT * FROM FeedSubmissionList WHERE FeedType = '_POST_PRODUCT_DATA_
SELECT * FROM FeedSubmissionList WHERE SubmittedDate = '2018-12-03T09:42:06'
SELECT * FROM FeedSubmissionList WHERE FeedProcessingStatus = '_DONE_'
Name | Type | References | Description |
FeedSubmissionId [KEY] | String | The Id of the FeedSubmission. | |
FeedType | String | The Type of the feed. | |
SubmittedDate | Datetime | The Date when the feed is submitted. | |
FeedProcessingStatus | String | The Status of the Feed.
The allowed values are _AWAITING_ASYNCHRONOUS_REPLY_, _CANCELLED_, _DONE_, _IN_PROGRESS_, _IN_SAFETY_NET_, _SUBMITTED_, _UNCONFIRMED_. | |
StartedProcessingDate | Datetime | The Date when the feed started processing. | |
CompletedProcessingDate | Datetime | The Date when the feed stopped processing. |
The GetFeedSubmissionResult operation returns the feed processing report for a specific feed.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM FeedSubmissionResult WHERE FeedSubmissionId = '50377017868'
Name | Type | References | Description |
DocumentTransactionID [KEY] | String | The Transaction ID of the Document. | |
FeedSubmissionId | String | The Feed Submission Id. | |
StatusCode | String | The status code of the feed. | |
MessagesProcessed | Integer | The number of messages processed. | |
MessagesSuccessful | Integer | The number of messages processed successfully. | |
MessagesWithError | Integer | The number of messages processed with errors. | |
MessagesWithWarning | Integer | The number of messages processed with warnings. | |
MessageID [KEY] | String | The Message ID. | |
ResultCode | String | The Result Code. | |
ResultMessageCode | String | The Result Message Code. | |
ResultDescription | String | The result description. | |
AdditionalInfo_SKU | String | The SKU. | |
AdditionalInfo_FulfillmentCenterID | String | The Fulfillment Center Id. | |
AdditionalInfo_AmazonOrderID | String | The Amazon Order Id. | |
AdditionalInfo_AmazonOrderItemCode | String | The Amazon Order Item Code. |
Returns a list of items in a specified inbound shipment.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM InboundShipments WHERE ShipmentId = '503-9993250-1405404'
Name | Type | References | Description |
ShipmentId [KEY] | String |
InboundShipments.ShipmentId | The ID of the shipment. |
SellerSKU [KEY] | String | The Seller SKU of the item. | |
QuantityShipped | Int | The item quantity that you are shipping. | |
QuantityInCase | Int | The item quantity in each case, for case-packed items. | |
QuantityReceived | Int | The item quantity that has been received at an Amazon fulfillment center. | |
FulfillmentNetworkSKU | String | Amazon's fulfillment network SKU of the item. | |
PrepDetailsListPrepInstruction | String | Preparation instructions for shipping an item to Amazon's fulfillment network. | |
PrepDetailsListPrepOwner | String | Indicates who will prepare the item. | |
ReleaseDate | Date | The date that a pre-order item will be available for sale. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
LastUpdatedDate | Datetime |
Returns a list of inbound shipments based on criteria that you specify.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM InboundShipments WHERE ShipmentStatus = 'Working'
SELECT * FROM InboundShipments WHERE ShipmentStatus IN ('Working', 'SHIPPED', 'IN_TRANSIT')
SELECT * FROM InboundShipments WHERE ShipmentId = '503-9993250-1405404'
SELECT * FROM InboundShipments WHERE LastUpdatedDate >= '2016-12-12'
Name | Type | References | Description |
ShipmentId [KEY] | String | The ID of the shipment. | |
ShipmentStatus | String | The status of your inbound shipment. Possible values are WORKING, SHIPPED, IN_TRANSIT, DELIVERED, CHECKED_IN, RECEIVING, CLOSED, CANCELLED, DELETED, and ERROR. | |
ShipmentName | String | The unique name of the inbound shipment. | |
ShipFromPostalCode | String | The PostalCode of the return address. | |
ShipFromName | String | The Name of the return address. | |
ShipFromCountryCode | String | The CountryCode of the return address. | |
ShipFromStateOrProvinceCode | String | The State Or Province Code of the return address. | |
ShipFromAddressLine1 | String | The AddressLine of the return address. | |
ShipFromCity | String | The City of the return address. | |
LabelPrepType | String | The type of label preparation. | |
AreCasesRequired | Boolean | Boolean that indicates whether or not an inbound shipment contains case-packed boxes. | |
DestinationFulfillmentCenterId | String | The Amazon fulfillment center identifier created by Amazon. | |
ConfirmedNeedByDate | Date | Date that the shipment must arrive at an Amazon fulfillment center for pre-ordered items. | |
EstimatedBoxContentsFeeTotalUnits | Int | The number of units to ship for an estimate of the manual processing fee charged by Amazon for boxes without box content information. | |
EstimatedBoxContentsFeePerUnitCurrencyCode | String | The currency code for an estimate of the manual processing fee charged by Amazon for boxes without box content information. | |
EstimatedBoxContentsFeePerUnitValue | Decimal | The manual processing fee per unit for an estimate of the manual processing fee charged by Amazon for boxes without box content information. | |
EstimatedBoxContentsTotalFeeCurrencyCode | String | The Total fee currency code for an estimate of the manual processing fee charged by Amazon for boxes without box content information. | |
EstimatedBoxContentsTotalFeeValue | Decimal | The Total fee value for an estimate of the manual processing fee charged by Amazon for boxes without box content information. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
LastUpdatedDate | Datetime |
Returns information about the availability of inventory that a seller has in Amazon's fulfillment network and in current inbound shipments. You can check the current availability status for your Fulfillment by Amazon inventory as well as discover when availability status changes.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM InventorySupply WHERE SellerSKU = 'Stest'
SELECT * FROM InventorySupply WHERE QueryStartDateTime = '2016-03-16'
Name | Type | References | Description |
UID [KEY] | String | Auto Generated Primary Key field. | |
FNSKU | String | The Fulfillment Network SKU (FNSKU) of the item. The FNSKU is a unique identifier for each inventory item stored in an Amazon fulfillment center. | |
SellerSKU | String | The Seller SKU of the item. Required if the QueryStartDateTime is not specified. | |
ASIN | String | The Amazon Standard Identification Number (ASIN) of the item. | |
Condition | String | The condition of the item. | |
TotalSupplyQuantity | Integer | The total item quantity that a seller has in Amazon's fulfillment network supply chain. This includes inventory that is available for shipping, inventory in inbound shipments, and inventory being transferred between Amazon fulfillment centers. | |
InStockSupplyQuantity | Integer | The item quantity that a seller has in Amazon fulfillment centers that is available for shipping. | |
EarliestAvailability_TimepointType | String | Indicates whether inventory is immediately available for picking, whether inventory availability is unknown, or whether inventory is expected to be available for picking by a specific date. | |
EarliestAvailability_DateTime | Datetime | The date and time by which inventory is expected to be available for picking. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
QueryStartDateTime | Datetime | A date used for selecting items that have had changes in inventory availability after (or at) a specified time. Required if SellerSKU is not specified. |
Returns order items based on the Amazon Order Id that you specify.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App. OrderItems table supports server side filtering with = and IN operators for AmazonOrderId field.
For example, the following query is processed server side:
SELECT * FROM OrderItems WHERE AmazonOrderId = '503-9993250-1405404'
SELECT * FROM OrderItems WHERE AmazonOrderId IN ('503-9993250-1405404', '503-9993250-1405404')
Name | Type | References | Description |
OrderItemId [KEY] | String | The item ID of the order. | |
AmazonOrderId | String |
Orders.AmazonOrderId | The Amazon ID of the order. |
ASIN | String | The ASIN Code. | |
SellerSKU | String | The SellerSKU. | |
BuyerCustomizedInfoCustomizedURL | String | The Buyer CustomizedURL. | |
Title | String | Title. | |
QuantityOrdered | Integer | The quantity of items ordered. | |
QuantityShipped | Integer | The quantity of items shipped. | |
GrantedPointsNumber | Integer | The Granted Points Number. | |
GrantedPointsMonetaryValueAmount | Decimal | The Granted Points Amount. | |
GrantedPointsMonetaryValueCurrencyCode | String | The Granted Points CurrencyCode. | |
NumberOfItems | Integer | The Number Of Items. | |
ItemPriceAmount | Decimal | The Item Price Amount. | |
ItemPriceCurrencyCode | String | The Item Price Currency Code. | |
ShippingPriceAmount | Decimal | The Shipping Price Amount. | |
ShippingPriceCurrencyCode | String | The Shipping Price Currency Code. | |
GiftWrapPriceAmount | String | The Gift Wrap Price Amount. | |
GiftWrapPriceCurrencyCode | String | The Gift Wrap Price Currency Code. | |
TaxCollectionName | String | The TaxCollection Name. | |
TaxCollectionValue | String | The TaxCollection Value. | |
ItemTaxAmount | Decimal | The Item Tax Amount. | |
ItemTaxCurrencyCode | String | The Item Tax Currency Code. | |
ShippingTaxAmount | String | The Shipping Tax Amount. | |
ShippingTaxCurrencyCode | String | The ShippingTax Currency Code. | |
GiftWrapTaxAmount | Decimal | The Gift Wrap Tax Amount. | |
GiftWrapTaxCurrencyCode | String | The Gift Wrap Tax Currency Code. | |
ShippingDiscountAmount | String | The Shipping Discount Amount. | |
ShippingDiscountCurrencyCode | String | The Shipping Discount Currency Code. | |
PromotionDiscountAmount | Decimal | The Promotion Discount Amount. | |
PromotionDiscountCurrencyCode | String | The Promotion Discount Currency Code. | |
PromotionIds | String | The IDs of Promotions. | |
CODFeeAmount | Decimal | The COD FeeAmount. | |
CODFeeCurrencyCode | String | The COD FeeCurrency Code. | |
CODFeeDiscountAmount | String | The COD FeeDiscount Amount. | |
CODFeeDiscountCurrencyCode | String | The COD FeeDiscount Currency Code. | |
IsGift | Boolean | Boolean specifying if the item is gift. | |
GiftMessageText | String | The Gift Message Text. | |
GiftWrapLevel | String | The Gift Wrap Level. | |
InvoiceDataInvoiceRequirement | String | The requirement of InvoiceData. | |
InvoiceDataBuyerSelectedInvoiceCategory | String | The selected categories of the InvoiceData. | |
InvoiceDataInvoiceTitle | String | The Title of the InvoiceData. | |
InvoiceDataInvoiceInformation | String | The Information of the InvoiceData. | |
ConditionNote | String | The Condition Note. | |
ConditionId | String | The Condition Id. | |
ConditionSubtypeId | String | The Condition Subtype Id. | |
ScheduledDeliveryStartDate | Datetime | The Scheduled Delivery StartDate. | |
ScheduledDeliveryEndDate | Datetime | The Scheduled Delivery EndDate. | |
PriceDesignation | String | The Price Designation. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
LastUpdateDate | Datetime | The last time the order is updated. |
Returns orders created or updated during a time frame that you specify.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Orders WHERE AmazonOrderId = '249-7638334-8161403'
SELECT * FROM Orders WHERE LastUpdateDate >= '2016-12-12'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND OrderStatus = 'Canceled'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND FulfillmentChannel = 'MFN'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND BuyerEmail = '[email protected]'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND PaymentMethod = 'Other'
Name | Type | References | Description |
AmazonOrderId [KEY] | String | The Amazon ID of the order. | |
SellerOrderId | String | The Seller ID of the order. | |
PurchaseDate | Datetime | The date of the purchase. | |
LastUpdateDate | Datetime | The last update date. | |
OrderStatus | String | Status of the order. | |
FulfillmentChannel | String | The Fulfillment Channel. | |
SalesChannel | String | The Sales Channel. | |
OrderChannel | String | The Order Channel. | |
ShipServiceLevel | String | The level of the Ship Service. | |
ShippingAddressName | String | The Shipping Address Name. | |
ShippingAddressAddressLine1 | String | The Shipping Address AddressLine. | |
ShippingAddressAddressLine2 | String | The Shipping Address AddressLine. | |
ShippingAddressAddressLine3 | String | The Shipping Address AddressLine. | |
ShippingAddressCity | String | The Shipping Address City. | |
ShippingAddressCountry | String | The Shipping Address Country. | |
ShippingAddressDistrict | String | The Shipping Address District. | |
ShippingAddressStateOrRegion | String | The Shipping Address State Or Region. | |
ShippingAddressPostalCode | String | The Shipping Address Postal Code. | |
ShippingAddressCountryCode | String | The Shipping Address Country Code. | |
ShippingAddressPhone | String | The Shipping Address Phone. | |
ShippingAddress_AddressType | String | The Shipping Address Type. | |
OrderTotalCurrencyCode | String | The Order Currency Code. | |
OrderTotalAmount | Decimal | The Order Amount. | |
NumberOfItemsShipped | Integer | The Number Of Items Shipped. | |
NumberOfItemsUnshipped | Integer | The Number Of Items Unshipped. | |
PaymentExecutionDetail | String | The Payment Execution Detail. | |
PaymentMethod | String | The Payment Method. | |
PaymentMethodDetail | String | The Details of payment method. | |
IsReplacementOrder | Boolean | Boolean specifying if it is a replacement order. | |
ReplacedOrderId | String | The Replaced OrderId. | |
MarketplaceId | String | The MarketplaceId. | |
BuyerEmail | String | The Buyer Email. | |
BuyerName | String | The Buyer Name. | |
BuyerCounty | String | The Buyer Country. | |
BuyerTaxInfo | String | The Buyer Tax Info. | |
ShipmentServiceLevelCategory | String | The Shipment Service Level Category. | |
ShippedByAmazonTFM | Boolean | The Shipped By Amazon TFM. | |
TFMShipmentStatus | String | The TFM Shipment Status. | |
CbaDisplayableShippingLabel | String | The Cba Displayable Shipping Label. | |
OrderType | String | The Type of Order. | |
EarliestShipDate | Datetime | The Earliest Ship Date. | |
LatestShipDate | Datetime | The Latest Ship Date. | |
EarliestDeliveryDate | Datetime | The Earliest Delivery Date. | |
LatestDeliveryDate | Datetime | The Latest Delivery Date. | |
IsBusinessOrder | Boolean | Boolean specifying if it is a Business Order. | |
IsIBA | Boolean | When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). | |
PurchaseOrderNumber | String | The Purchase Order Number. | |
IsPrime | Boolean | Boolean specifying if it is a Prime Order. | |
IsPremiumOrder | Boolean | Boolean specifying if it is a Premium Order. |
The Products Table helps you get information to match your products to existing product listings on Amazon Marketplace websites.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Products WHERE SearchTerms = '249-7638334-8161403'
SELECT * FROM Products WHERE idType = 'SellerSKU' AND idlist = '{SellerSku code}'
SELECT * FROM Products WHERE idType = 'ASIN' AND idlist = '{ASIN code}'
SELECT * FROM Products WHERE idType = 'GCID' AND idlist = '{GCID code}'
SELECT * FROM Products WHERE idType = 'UPC' AND idlist = '{UPC code}'
SELECT * FROM Products WHERE idType = 'EAN' AND idlist = '{EAN code}'
SELECT * FROM Products WHERE idType = 'ISBN' AND idlist = '{ISBN code}'
SELECT * FROM Products WHERE idType = 'JAN' AND idlist = '{JAN code}'
SELECT * FROM Products WHERE idType = 'JAN' AND idlist IN ('{JAN code}', '{ISBN code}', '{GCID code}')
Name | Type | References | Description |
MarketplaceASIN [KEY] | String | The Marketplace ASIN. | |
MarketplaceASINMarketplaceId | String | The MarketplaceId of Marketplace ASIN. | |
SKUIdentifierMarketplaceId | String | The SKUIdentifier of MarketplaceId. | |
SKUIdentifierSelerId | String | The MarketplaceId of SellerId. | |
SKUIdentifierSellerSKU | String | The MarketplaceId of SellerSKU. | |
AttributeSets | String | The product attributes. | |
Relationships | String | The product relationships. | |
SalesRankings | String | The product sales rankings. | |
SearchTerms | String | ||
IdType | String | The product ID type.
The allowed values are ASIN, GCID, SellerSKU, UPC, EAN, ISBN, JAN. | |
IdList | String | A list of product IDs. |
Usage information for the operation ReportList.rsd.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ReportList WHERE ReportType IN '_GET_MERCHANT_LISTINGS_INACTIVE_DATA_'
SELECT * FROM ReportList WHERE ReportRequestId = '50566018029'
SELECT * FROM ReportList WHERE ReportRequestId IN ('50566018029', '50564018026')
SELECT * FROM ReportList WHERE AvailableDate > '2016-12-12' AND AvailableDate < '2018-11-12 12:00:00'
SELECT * FROM ReportList WHERE AvailableDate >= '2016-12-12' AND Acknowledged = 'true'
Name | Type | References | Description |
ReportId [KEY] | String | Report ID. | |
ReportType | String | The type of the Report. | |
ReportRequestId | String | The Report Request ID. | |
Acknowledged | Boolean | A boolean value that indicates whether the order report has been acknowledged. | |
AvailableDate | Datetime | Date on which the report was available. By default, reports available from the last 90 days will be returned. |
Usage information for the operation ReportRequestList.rsd.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ReportRequestList WHERE ReportType = '_GET_MERCHANT_LISTINGS_INACTIVE_DATA_'
SELECT * FROM ReportRequestList WHERE ReportType IN ('_GET_MERCHANT_LISTINGS_INACTIVE_DATA_', '_GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_')
SELECT * FROM ReportRequestList WHERE ReportRequestId = '50566018029'
SELECT * FROM ReportRequestList WHERE ReportRequestId IN ('50566018029', '50564018026')
SELECT * FROM ReportRequestList WHERE RequestedDate > '2016-12-12'
SELECT * FROM ReportRequestList WHERE RequestedDate > '2016-12-12' AND RequestedDate > '2018-12-12 13:00'
SELECT * FROM ReportRequestList WHERE RequestedDate <= '2016-12-12' AND ReportProcessingStatus = '_DONE_'
SELECT * FROM ReportRequestList WHERE ReportProcessingStatus IN ('_DONE_', '_SUBMITTED_', '_CANCELLED_')
Name | Type | References | Description |
ReportRequestId [KEY] | String | The Report Request Id. | |
ReportType | String | The type of the Report. | |
StartDate | Datetime | The start date of the request. | |
EndDate | Datetime | The end date of the request. | |
Scheduled | Boolean | A boolean value that indicates whether the report request was scheduled. | |
SubmittedDate | Datetime | The date and time the report was submitted. | |
ReportProcessingStatus | String | Processing status of the report. Possible values are: _SUBMITTED_, _IN_PROGRESS_, _CANCELLED_, _DONE_, _DONE_NO_DATA_ | |
GeneratedReportId | String | The report id generated from Amazon MWS. | |
StartedProcessingDate | Datetime | The date and time that the report stated to be processed. | |
CompletedDate | Datetime | The date and time that the report was completed. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
RequestedDate | Datetime | The date and time that the report was requested. By default, reports requested within the range of the last 90 days will be returned. |
The CData Sync App models the Selling Partner API as relational views, and stored procedures.
To use Amazon Selling Partner Data Model, simply set Schema to SellingPartner.
Views are tables that cannot be modified, such as Orders, Products. Typically, data that are read-only and cannot be updated are shown as views.
Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.
For each report type there is a view exposed. For example, report type FEE_DISCOUNTS_REPORT will be exposed as a view named REPORT_FEE_DISCOUNTS_REPORT. These views can then be queried by using 'DataStartTime' and 'DataEndTime' optional datetime parameters. When both datetime parameters are specified, the driver automatically searches for an existing report that matches the specified interval, and if not found a new report is created. Reports can be manually created with the RequestReport stored procedure. You can also use ReportOptions JSON-aggregate pseudo-column to specify additional fields that may be required depending on report type. For more details about report options please check Amazon Selling-Partner API Documentation
After a report has been created and pushed to the result set, the next time you query this report type with the 'DataStartTime' and 'DataEndTime' same filters, the previously created report is downloaded instead of creating a new report.
The Sync App models the data in Amazon Marketplace as a list of tables in a relational database that can be queried using standard SQL statements.
Name | Description |
Destinations | Returns information about all destinations. |
InboundShipments | Returns a list of inbound shipments based on criteria that you specify. |
InboundShipmentTransportDetails | Inbound shipment information, including carrier details, shipment status, and the workflow status for a request for shipment with an Amazon-partnered carrier. |
ListingsItems | Returns details about a listings item for a selling partner. |
ListingsItemsAttributes | The GetFeedSubmissionList operation returns a list of feed submissions. |
OutboundFulfillmentOrders | Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. |
Subscriptions | Returns information about subscriptions of the specified notification type. |
VendorShippingLabels | This table is part of Vendor Direct Fulfillment Shipping API. Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. The date range to search must not be more than 7 days. |
Returns information about all destinations.
Name | Type | ReadOnly | References | Description |
DestinationId [KEY] | String | False |
The destination identifier generated when you created the destination. | |
Name | String | False |
The developer-defined name for this destination. | |
ResourceSqsArn | String | False |
The Amazon Resource Name (ARN) associated with the SQS queue (Amazon Simple Queue Service queue destination). | |
ResourceEventBridgeName | String | False |
The name of the partner event source associated with the destination (Amazon EventBridge destination). | |
ResourceEventBridgeRegion | String | False |
The AWS region in which you will be receiving the notifications (Amazon EventBridge destination). | |
ResourceEventBridgeAccountId | String | False |
The identifier for the AWS account that is responsible for charges related to receiving notifications (Amazon EventBridge destination). |
Returns a list of inbound shipments based on criteria that you specify.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM InboundShipments WHERE ShipmentStatus = 'Working'
SELECT * FROM InboundShipments WHERE ShipmentStatus IN ('Working', 'SHIPPED', 'IN_TRANSIT')
SELECT * FROM InboundShipments WHERE ShipmentId = '503-9993250-1405404'
SELECT * FROM InboundShipments WHERE MarketplaceId = 'ATVPDKIKX0DER'
SELECT * FROM InboundShipments WHERE LastUpdatedDate >= '2016-12-12'
Name | Type | ReadOnly | References | Description |
ShipmentId [KEY] | String | False |
The ID of the shipment. | |
ShipmentStatus | String | False |
The status of your inbound shipment. | |
ShipmentName | String | False |
The unique name of the inbound shipment. | |
ShipFromPostalCode | String | False |
The PostalCode of the return address. | |
ShipFromName | String | False |
The Name of the return address. | |
ShipFromCountryCode | String | False |
The CountryCode of the return address. | |
ShipFromDistrictOrCounty | String | False |
The district or county of the return address. | |
ShipFromStateOrProvinceCode | String | False |
The State Or Province Code of the return address. | |
ShipFromAddressLine1 | String | False |
The street address information of the return address. | |
ShipFromAddressLine2 | String | False |
Additional street address information of the return address. | |
ShipFromCity | String | False |
The City of the return address. | |
LabelPrepType | String | False |
The type of label preparation. | |
AreCasesRequired | Boolean | False |
Boolean that indicates whether or not an inbound shipment contains case-packed boxes. | |
DestinationFulfillmentCenterId | String | False |
The Amazon fulfillment center identifier created by Amazon. | |
ConfirmedNeedByDate | Date | False |
Date that the shipment must arrive at an Amazon fulfillment center for pre-ordered items. | |
MarketplaceId | String | False |
Marketplace identifier for the report. | |
BoxContentsSource | String | False |
Where the seller provided box contents information for a shipment. | |
EstimatedBoxContentsFeeTotalUnits | Int | False |
The number of units to ship for an estimate of the manual processing fee charged by Amazon for boxes without box content information. | |
EstimatedBoxContentsFeePerUnitCurrencyCode | String | False |
The currency code for an estimate of the manual processing fee charged by Amazon for boxes without box content information. | |
EstimatedBoxContentsFeePerUnitValue | Decimal | False |
The manual processing fee per unit for an estimate of the manual processing fee charged by Amazon for boxes without box content information. | |
EstimatedBoxContentsTotalFeeCurrencyCode | String | False |
The Total fee currency code for an estimate of the manual processing fee charged by Amazon for boxes without box content information. | |
EstimatedBoxContentsTotalFeeValue | Decimal | False |
The Total fee value for an estimate of the manual processing fee charged by Amazon for boxes without box content information. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
LastUpdatedDate | Datetime |
A date used for selecting inbound shipments that were last updated before/after a specified time. |
InboundShipmentItemList | String |
A list of inbound shipment item information. |
Inbound shipment information, including carrier details, shipment status, and the workflow status for a request for shipment with an Amazon-partnered carrier.
Name | Type | ReadOnly | References | Description |
ShipmentId [KEY] | String | True |
A shipment identifier originally returned by the createInboundShipmentPlan operation. | |
PartneredSmallParcelData | String | False |
Information that is required by an Amazon-partnered carrier to ship a Small Parcel inbound shipment. | |
NonPartneredSmallParcelData | String | False |
Information that you provide to Amazon about a Small Parcel shipment shipped by a carrier that has not partnered with Amazon. | |
PartneredLtlData | String | False |
Information that is required by an Amazon-partnered carrier to ship a Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. | |
NonPartneredLtlData | String | False |
Information that you provide to Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by a carrier that has not partnered with Amazon. | |
IsPartnered | Boolean | False |
Indicates whether a putTransportDetails request is for a partnered carrier. | |
SellerId | String | False |
The Amazon seller identifier. | |
ShipmentType | String | False |
Specifies the carrier shipment type in a putTransportDetails request. | |
ErrorCode | String | False |
An error code that identifies the type of error that occured. | |
ErrorDescription | String | False |
A message that describes the error condition. | |
TransportStatus | String | False |
Indicates the status of the Amazon-partnered carrier shipment. |
Returns details about a listings item for a selling partner.
The following filters are required:
SELECT * FROM ListingsItems WHERE SKU = '12345' AND SellerId = 'XXXXXXXXXXXXXX'
INSERT INTO ListingsItems (ProductType, Requirements, Attributes, SKU, SellerId)
VALUES ('product_type', 'LISTING', '{\"AttributeName\": \"test_attribute\", \"AttributeValue\": \"value\"}', '12345', 'XXXXXXXXXXXXXX')
DELETE FROM ListingsItems WHERE SKU = '12345' AND SellerId = 'XXXXXXXXXXXXXX'
When inserting, you can also use temp tables in order to insert multiple attributes, as shown in the example below:
INSERT INTO Attributes#TEMP (AttributeName, AttributeValue) VALUES ('attr1', 'val1')
INSERT INTO Attributes#TEMP (AttributeName, AttributeValue) VALUES ('attr2', 'val2')
INSERT INTO Attributes#TEMP (AttributeName, AttributeValue) VALUES ('attr3', 'val3')
INSERT INTO ListingsItems (ProductType, Requirements, Attributes, SKU, SellerId)
VALUES ('product_type', 'LISTING', 'Attributes#TEMP', '12345', 'XXXXXXXXXXXXXX')
*The temporary table must be defined and used within the same connection. Closing the connection will clear out any temporary tables in memory.
Name | Type | ReadOnly | References | Description |
SKU [KEY] | String | True |
A selling partner provided identifier for an Amazon listing. | |
FulfillmentAvailability | String | False |
Fulfillment availability for the listings item. | |
ProcurementCostCurrency | String | True |
The price (ISO4217 currency code) that you want Amazon to pay you for this product. | |
ProcurementCostAmount | String | True |
The price (numeric value) that you want Amazon to pay you for this product. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Attributes | String |
This field is required for INSERT statements. Aggregate field containing structured 'AttributeName' and 'AttributeValue' fields. |
SellerId | String |
A selling partner identifier, such as a merchant account or vendor code. |
Requirements | String |
This field can be specified for INSERT statements. The allowed values are LISTING, LISTING_PRODUCT_ONLY, LISTING_OFFER_ONLY. |
ProductType | String |
This field is required for INSERT statements. |
The GetFeedSubmissionList operation returns a list of feed submissions.
The following filters are required:
SELECT * FROM ListingsItemsAttributes WHERE SKU = '12345' AND SellerId = 'XXXXXXXXXXXXXX'
UPDATE ListingsItemsAttributes SET AttributeValue = 'test_value', ProductType = 'LUGGAGE'
WHERE SKU = '12345' AND AttributeName = 'item_name_value'
You can also retrieve all SKU fields from another sub-query, for example:
SELECT * FROM ListingsItems WHERE SellerId = 'XXXXXXXXXXXXXX' AND SKU IN (
SELECT DISTINCT(SKUIdentifierSellerSKU) FROM CatalogItems WHERE MarketplaceId = 'XXXXXXXXXXXXXX' AND Query = 'test' AND SkuIdentifierSellerSku IS NOT NULL
)
Name | Type | ReadOnly | References | Description |
SKU [KEY] | String | True |
A selling partner provided identifier for an Amazon listing. | |
AttributeName [KEY] | String | False |
The attribute name for the listings item. | |
AttributeValue | String | False |
The attribute value for the listings item. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
ProductType | String |
The Amazon product type of the listings item. Required for Updating an attribute. |
SellerId | String |
A selling partner identifier, such as a merchant account or vendor code. |
Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter.
Name | Type | ReadOnly | References | Description |
SellerFulfillmentOrderId [KEY] | String | False |
The fulfillment order identifier. | |
DisplayableOrderId | String | False |
A fulfillment order identifier submitted when creating a fulfillment order. Displays as the order identifier in recipient-facing materials such as the packing slip. | |
DisplayableOrderComment | String | False |
A text block submitted when creating a fulfillment order. Displays in recipient-facing materials such as the packing slip. | |
DisplayableOrderDate | Datetime | False |
A date and time submitted when creating a fulfillment order. Displays as the order date in recipient-facing materials such as the packing slip. | |
FeatureConstraints | String | False |
A list of features and their fulfillment policies to apply to the order. | |
FulfillmentAction | String | False |
Specifies whether the fulfillment order should ship now or have an order hold put on it. | |
FulfillmentOrderStatus | String | False |
The current status of the fulfillment order. | |
FulfillmentPolicy | String | False |
The FulfillmentPolicy value specified when creating a fulfillment order. | |
ReceivedDate | Datetime | False |
The date and time that the fulfillment order was received by an Amazon fulfillment center. | |
ShippingSpeedCategory | String | False |
The shipping method used for the fulfillment order. | |
StatusUpdatedDate | Datetime | False |
The date and time that the status of the fulfillment order last changed, in ISO 8601 date time format. | |
AddressLine1 | String | False |
The first line of the address. | |
AddressLine2 | String | False |
Additional address information. | |
AddressLine3 | String | False |
Additional address information. | |
City | String | False |
The city where the person, business, or institution is located. This property is required in all countries except Japan. It should not be used in Japan. | |
CountryCode | String | False |
The two digit country code. In ISO 3166-1 alpha-2 format. | |
DistrictOrCounty | String | False |
The district or county where the person, business, or institution is located. | |
AddressName | String | False |
The name of the person, business or institution at the address. | |
PostalCode | String | False |
The postal code of the address. | |
StateOrRegion | String | False |
The state or region where the person, business or institution is located. | |
Phone | String | False |
The phone number of the person, business, or institution located at the address. | |
ReturnAuthorizations | String | False |
A JSON object of return authorization information. | |
ReturnItems | String | False |
A JSON object of items that Amazon accepted for return. Returns empty if no items were accepted for return. | |
FulfillmentShipments | String | False |
A JSON object of fulfillment shipment information. | |
FulfillmentOrderItems | String | False |
A JSON object of fulfillment order item information. | |
MarketplaceId | String | False |
The marketplace identifier. | |
QueryStartDate | String | False |
A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order. |
Returns information about subscriptions of the specified notification type.
Name | Type | ReadOnly | References | Description |
SubscriptionId [KEY] | String | False |
The subscription identifier generated when the subscription is created. | |
NotificationType [KEY] | String | False |
The type of notification. The allowed values are ACCOUNT_STATUS_CHANGED, ANY_OFFER_CHANGED, B2B_ANY_OFFER_CHANGED, BRANDED_ITEM_CONTENT_CHANGE, FBA_INVENTORY_AVAILABILITY_CHANGES, FBA_OUTBOUND_SHIPMENT_STATUS, FEE_PROMOTION, FEED_PROCESSING_FINISHED, FULFILLMENT_ORDER_STATUS, ITEM_PRODUCT_TYPE_CHANGE, LISTINGS_ITEM_STATUS_CHANGE, LISTINGS_ITEM_ISSUES_CHANGE, ORDER_STATUS_CHANGE, PRICING_HEALTH, PRODUCT_TYPE_DEFINITIONS_CHANGE, REPORT_PROCESSING_FINISHED. | |
PayloadVersion | String | False |
The version of the payload object to be used in the notification. | |
DestinationId | String | False |
The identifier for the destination where notifications will be delivered. | |
MarketplaceIds | String | False |
A list of marketplace identifiers to subscribe to (e.g. ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list. | |
AggregationTimePeriod | String | False |
The supported time period to use to perform marketplace-ASIN level aggregation. The allowed values are FiveMinutes, TenMinutes. | |
EventFilterType | String | False |
An eventFilterType value that is supported by the specific notificationType. This is used by the subscription service to determine the type of event filter. |
This table is part of Vendor Direct Fulfillment Shipping API. Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. The date range to search must not be more than 7 days.
Some example queries:
SELECT * FROM VendorShippingLabels WHERE PurchaseOrderNumber = '12345'
SELECT * FROM VendorShippingLabels WHERE CreatedDate > '2022-09-10T12:00:00' AND CreatedDate < '2022-09-15T12:00:00'
INSERT INTO Items#TEMP (ItemSequenceNumber, BuyerProductIdentifier, VendorProductIdentifier, Amount, UnitOfMeasure)
VALUES ( 1, 'item_id', 'prod_id', 10, 'unit');
INSERT INTO Container#TEMP (ContainerType, ContainerIdentifier, TrackingNumber, PackedItems)
VALUES ( 'carton', 'container_id', 'string', 'Items#TEMP');
INSERT INTO Address1#TEMP ( Name, AddressLine1, City, County, CountryCode)
VALUES ('Name', 'Fayettville NC', 'Fayettville', 'North Carolina', 'NC');
INSERT INTO TaxTest#TEMP (RegistrationType, RegistrationNumber, RegistrationMessages, RegistrationAddress)
VALUES ( 'VAT', 'string', 'string', 'Address1#TEMP');
INSERT INTO VendorShippingLabels (PurchaseOrderNumber, SellingPartyPartyId, SellingPartyTaxRegistrationDetails, ShipFromPartyPartyId, Containers)
VALUES ('1234567890', '11111', 'TaxTest#TEMP', '22222', 'Container#TEMP');
In order to get the Transaction ID returned from the API for the INSERT statement, you can issue a select statement from the LastResultInfo temp table, as shown below:
SELECT * FROM LastResultInfo#TEMP
*The temporary table must be defined and used within the same connection. Closing the connection will clear out any temporary tables in memory.
Column Name | Type | Required | Description |
ContainerType | String | True | The type of container. |
ContainerIdentifier | String | True | The container identifier. |
TrackingNumber | String | False | The tracking number. |
ContainerSequenceNumber | Integer | False | An integer that must be submitted for multi-box shipments only, where one item may come in separate packages. |
ManifestId | String | False | The manifest identifier. |
ManifestDate | String | False | The date of the manifest. |
ShipMethod | String | False | The shipment method. |
ScacCode | String | False | SCAC code required for NA VOC vendors only. |
Carrier | String | False | Carrier required for EU VOC vendors only. |
Length | String | False | Physical dimensional measurements of a container. |
Width | String | False | Physical dimensional measurements of a container. |
Height | String | False | Physical dimensional measurements of a container. |
DimensionUnit | String | False | Physical dimensional measurements of a container. |
Value | String | False | The weight. |
WeightUnit | String | False | The weight. |
PackedItems | Aggregate | True | A list of packed items. See: PackedItems table schema. |
Column Name | Type | Required | Description |
ItemSequenceNumber | Integer | True | Item Sequence Number for the item. This must be the same value as sent in the order for a given item. |
BuyerProductIdentifier | String | False | Buyer's Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required. |
VendorProductIdentifier | String | False | The vendor selected product identification of the item. Should be the same as was sent in the Purchase Order, like SKU Number. |
Amount | Decimal | True | Quantity of units shipped for a specific item at a shipment level. If the item is present only in certain packages or pallets within the shipment, please provide this at the appropriate package or pallet level. |
UnitOfMeasure | String | True | Unit of measure for the shipped quantity. |
Column Name | Type | Required | Description |
RegistrationType | String | True | Tax registration type for the entity. Allowed Values: VAT, GST. |
RegistrationNumber | String | True | Tax registration number for the party. For example, VAT ID. |
RegistrationMessages | String | False | Tax registration message that can be used for additional tax related details |
RegistrationAddress | Aggregate | False | Address of the party. See: AddressDetails table schema. |
Column Name | Type | Required | Description |
Name | String | True | The name of the person, business or institution at that address. |
AddressLine1 | String | True | First line of street address. |
AddressLine2 | String | False | Additional address information, if required. |
AddressLine3 | String | False | Additional address information, if required. |
City | String | False | The city where the person, business or institution is located. |
County | String | False | The county where person, business or institution is located. |
District | String | False | The district where person, business or institution is located. |
StateOrRegion | String | False | The state or region where person, business or institution is located. |
PostalOrZipCode | String | False | The postal or zip code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. |
CountryCode | String | True | The two digit country code. In ISO 3166-1 alpha-2 format. |
Phone | String | False | The phone number of the person, business or institution located at that address. |
Name | Type | ReadOnly | References | Description |
PurchaseOrderNumber [KEY] | String | False | ||
LabelFormat | String | True |
The allowed values are PNG, ZPL. | |
LabelData | String | True | ||
SellingPartyPartyId | String | False | ||
SellingPartyAddressLine1 | String | False | ||
SellingPartyAddressLine2 | String | False | ||
SellingPartyAddressLine3 | String | False | ||
SellingPartyAddressCity | String | False | ||
SellingPartyAddressCountryCode | String | False | ||
SellingPartyAddressCounty | String | False | ||
SellingPartyAddressDistrict | String | False | ||
SellingPartyAddressName | String | False | ||
SellingPartyAddressPhone | String | False | ||
SellingPartyAddressPostalCode | String | False | ||
SellingPartyAddressStateOrRegion | String | False | ||
SellingPartyTaxRegistrationDetails | String | False | ||
ShipFromPartyPartyId | String | False | ||
ShipFromPartyAddressLine1 | String | False | ||
ShipFromPartyAddressLine2 | String | False | ||
ShipFromPartyAddressLine3 | String | False | ||
ShipFromPartyAddressCity | String | False | ||
ShipFromPartyAddressCountryCode | String | False | ||
ShipFromPartyAddressCounty | String | False | ||
ShipFromPartyAddressDistrict | String | False | ||
ShipFromPartyAddressName | String | False | ||
ShipFromPartyAddressPhone | String | False | ||
ShipFromPartyAddressPostalCode | String | False | ||
ShipFromPartyAddressStateOrRegion | String | False | ||
ShipFromPartyTaxRegistrationDetails | String | False |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
CreatedDate | String | |
Containers | String |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Name | Description |
CatalogItems | The Catalog Items table helps you retrieve item details for items in the catalog. |
CompetitivePricing | Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN. |
Feeds | The GetFeedSubmissionList operation returns a list of feed submissions. |
FeesEstimate | Returns the estimated fees for the listed products. |
InboundItemsGuidance | Returns a list of items in a specified inbound shipment. |
InboundPreparationInstructions | Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network. |
InboundShipmentItems | Returns a list of items in a specified inbound shipment. |
InboundShipmentPreorders | Returns a list of items in a specified inbound shipment. |
InventorySupply | Returns information about the availability of inventory that a seller has in Amazon's fulfillment network and in current inbound shipments. You can check the current availability status for your Fulfillment by Amazon inventory as well as discover when availability status changes. |
ItemOffers | Returns the lowest priced offers for a single item based on ASIN. |
ListingOffers | Generated schema file. |
ListingsItemsIssues | The GetFeedSubmissionList operation returns a list of feed submissions. |
ListingsItemsOffers | The GetFeedSubmissionList operation returns a list of feed submissions. |
ListingsItemsSummaries | The GetFeedSubmissionList operation returns a list of feed submissions. |
OrderItems | Returns order items based on the Amazon Order Id that you specify. |
OrderMetrics | Returns aggregated order metrics for a given interval, broken down by granularity, for a given buyer type. |
Orders | Returns orders created or updated during a time frame that you specify. |
OrderScheduleDetailsListInternal | Usage information for the operation OrderScheduleDetailsListInternal.rsd. |
OutboundFeatures | Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. |
OutboundFulfillmentOrderItems | Returns the fulfillment order items indicated by the specified order identifier. |
OutboundFulfillmentsPreview | Returns a list of fulfillment order previews based on shipping criteria that you specify. |
OutboundPackageTracking | Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. |
OutboundReturnItems | An array of items that Amazon accepted for return. Returns empty if no items were accepted for return. |
OutboundReturnReasons | Returns a list of return reason codes for a seller SKU in a given marketplace. |
PackageItemsInternal | Usage information for the operation PackageItemsInternal.rsd. |
ProductPricing | Generated schema file. |
ReportList | Returns report details for the reports that match the filters that you specify. |
ReportTypes | Returns report details for the reports that match the filters that you specify. |
ShippingDocuments | Returns the shipping documents associated with a package in a shipment. |
ShippingRates | Returns the available shipping service offerings. |
ShippingTracking | Returns tracking information for a purchased shipment. |
UpdatePackageDetailsListInternal | Usage information for the operation UpdatePackageDetailsListInternal.rsd. |
VendorCustomerInvoices | This view is part of Vendor Direct Fulfillment Shipping API. Returns a list of customer invoices created during a time frame that you specify. The date range to search must be no more than 7 days. |
VendorOrders | The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. |
VendorPackingSlips | This view is part of Vendor Direct Fulfillment Shipping API. Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. |
The Catalog Items table helps you retrieve item details for items in the catalog.
The following filters are required:
SELECT * FROM CatalogItems WHERE MarketplaceID = 'XXXXXXXXXXXXX' AND ISBN = 'XXXXXXXXXXXXX'
Name | Type | References | Description |
MarketplaceASIN [KEY] | String | The Marketplace ASIN. | |
AdultProduct | Boolean | Identifies an Amazon catalog item is intended for an adult audience or is sexual in nature. | |
Autographed | Boolean | Identifies an Amazon catalog item is autographed by a player or celebrity. | |
Brand | String | Name of the brand associated with an Amazon catalog item. | |
BrowseClassificationClassificationId | String | Classification Id (browse node) associated with an Amazon catalog item. | |
BrowseClassificationDisplayName | String | Classification Name (browse node) associated with an Amazon catalog item. | |
Color | String | Name of the color associated with an Amazon catalog item. | |
ContributorsRole | String | Role of an individual contributor in the creation of an item, such as author or actor. | |
ContributorsName | String | Name of the contributor. | |
ItemClassification | String | Classification type associated with the Amazon catalog item. | |
ItemName | String | Name, or title, associated with an Amazon catalog item. | |
Manufacturer | String | Name of the manufacturer associated with an Amazon catalog item. | |
Memorabilia | Boolean | Identifies an Amazon catalog item is memorabilia valued for its connection with historical events, culture, or entertainment. | |
ModelNumber | String | Model number associated with an Amazon catalog item. | |
PackageQuantity | Integer | Quantity of an Amazon catalog item in one package. | |
PartNumber | String | Part number associated with an Amazon catalog item. | |
ReleaseDate | String | First date on which an Amazon catalog item is shippable to customers. | |
Size | String | Name of the size associated with an Amazon catalog item. | |
Style | String | Name of the style associated with an Amazon catalog item. | |
TradeInEligible | Boolean | Identifies an Amazon catalog item is eligible for trade-in. | |
WebsiteDisplayGroup | String | Identifier of the website display group associated with an Amazon catalog item. | |
WebsiteDisplayGroupName | String | Display name of the website display group associated with an Amazon catalog item. | |
Attributes | String | A JSON object containing structured item attribute data keyed by attribute name. Catalog item attributes conform to the related Amazon product type definitions available in the Selling Partner API for Product Type Definitions. | |
Dimensions | String | A JSON object of the dimensions for an item in the Amazon catalog. | |
Identifiers | String | A JSON object of the identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers. | |
Images | String | A JSON object of the images for an item in the Amazon catalog. | |
ProductTypes | String | A JSON object of the product types associated with the Amazon catalog item. | |
Relationships | String | A JSON object of the relationship details of an Amazon catalog item (for example, variations). | |
SalesRankings | String | A JSON object of the sales ranks of an Amazon catalog item. | |
VendorDetails | String | A JSON object of the vendor details associated with an Amazon catalog item. Vendor details are available to vendors only. | |
ASIN | String | Amazon Standard Identification Number that identifies a product. | |
EAN | String | A European Article Number that uniquely identifies the catalog item, manufacturer, and its attributes. | |
GTIN | String | A Global Trade Item Number that uniquely identifies a product. | |
ISBN | String | The unique commercial book identifier used to identify books internationally. | |
JAN | String | A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. | |
MINSAN | String | A Minsan Code that uniquely identifies an item. | |
SellerSKU | String | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId | |
UPC | String | A 12-digit bar code used for retail packaging. | |
IncludedData | String | A comma-delimited list of item details to request. If none are specified, will default to returning summaries data. Values: attributes, dimensions, identifiers, images, productTypes, relationships, salesRanks, summaries, vendorDetails. | |
Locale | String | Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | |
SellerId | String | A selling partner identifier, such as a seller account or vendor code. Note: Required when setting identifier SellerSKU. | |
PageSize | String | Number of results to be returned per page. | |
Query | String | Keyword(s) to use to search for items in the catalog. | |
BrandNames | String | A comma-delimited list of brand names to limit the search for keywords-based queries. Note: Cannot be used with identifiers. | |
ClassificationIds | String | A comma-delimited list of classification identifiers to limit the search for keywords-based queries. Note: Cannot be used with identifiers. | |
KeywordsLocale | String | The language of the keywords provided for keywords-based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers. | |
MarketplaceId | String | Specifies the marketplace for which items are returned. |
Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN.
Name | Type | References | Description |
ASIN [KEY] | String | The value of Amazon Standard Identification Number for the product. | |
SellerSKU | String | Stock Keeping Unit that identifies a product in the Amazon catalog. | |
MarketplaceId | String | A marketplace identifier. Specifies the marketplace for which prices are returned. | |
CompetitivePriceId | String | The competitive price Id of the product. | |
LandedPriceAmount | Decimal | The landed price amount of the price. | |
LandedPriceCurrencyCode | String | The landed price currency code of the price. | |
ListingPriceAmount | Decimal | The listing price amount of the price. | |
ListingPriceCurrencyCode | String | The listing price currency code of the price. | |
PointsNumber | Integer | The points number of the price. | |
PointsMonetaryValueAmount | Decimal | The points monetary value amount of the price. | |
PointsMonetaryValueCurrencyCode | String | The points monetary value currency code of the price. | |
ShippingAmount | Decimal | The shipping amount of the buyying price. | |
ShippingCurrencyCode | String | The shipping currency code of the buyying price. | |
TradeInValueAmount | Decimal | The trade-in value amount of the buyying price. | |
TradeInValueCurrencyCode | String | The trade-in value currency code of the buyying price. | |
ProductCategoryId | String | The product category Id. | |
Rank | Integer | The value of the sales rankings. | |
BelongsToRequester | Boolean | The boolean value if the product belongs to the requester. | |
Condition | String | The condition of the product. | |
Status | String | The status of the product. | |
ItemType | String | Required. Indicates whether ASIN values or seller SKU values are used to identify items.
The allowed values are Asin, Sku. | |
CustomerType | String | Indicates whether to request pricing information from the point of view of consumer or business buyers. Default is Consumer.
The allowed values are Consumer, Business. |
The GetFeedSubmissionList operation returns a list of feed submissions.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
Note: 'FeedType' attribute is required to query the view. You can view available values for 'FeedType' here.
Following are example queries that are processed server side:
SELECT * FROM Feeds WHERE FeedId = '50950018754'
SELECT * FROM Feeds WHERE FeedType = 'POST_PRODUCT_PRICING_DATA'
SELECT * FROM Feeds WHERE FeedType IN ( 'POST_PRODUCT_PRICING_DATA', 'POST_INVENTORY_AVAILABILITY_DATA' )
SELECT * FROM Feeds WHERE FeedType = 'POST_PRODUCT_PRICING_DATA' AND MarketplaceIds = 'A1VC38T7YXB528'
SELECT * FROM Feeds WHERE FeedType = 'POST_PRODUCT_PRICING_DATA' AND ProcessingStatus = 'DONE'
SELECT * FROM Feeds WHERE FeedType = 'POST_PRODUCT_PRICING_DATA' AND CreatedTime > '2021-06-20' AND CreatedTime < '2021-08-01 12:00:00'
Note: When filtering with CreatedTime, values older than 90 days will not be accepted.
Name | Type | References | Description |
FeedId [KEY] | String | The Id of the Feed. This identifier is unique only in combination with a seller ID. | |
FeedType | String | The Type of the feed. FeedType is not required when UseSandbox=True. | |
MarketplaceIds | String | A list of marketplace identifiers for the report. | |
CreatedTime | Datetime | The date and time when the feed was created. While filtering, CreatedTime value is only accepted till 90 days old. | |
ProcessingStatus | String | The processing status of the report. | |
ProcessingStartTime | Datetime | The Date when the feed processing started. | |
ProcessingEndTime | Datetime | The Date when the feed processing completed. | |
ResultFeedDocumentId | String | The identifier for the feed document. This identifier is unique only in combination with a seller ID. |
Returns the estimated fees for the listed products.
Name | Type | References | Description |
IdValue [KEY] | String | Required. The item identifier. | |
SellerID | String | The seller identifier. | |
TimeOfFeesEstimation | Datetime | The time at which the fees were estimated. | |
TotalFeesEstimateAmount | Decimal | Total estimated fees for a given item, price and fulfillment channel. | |
TotalFeesEstimateCurrencyCode | String | The currency code for the total estimated fees. | |
FeeType | String | The type of fee charged to a seller. | |
FeeAmount | Decimal | The amount charged for a given fee. | |
FeeAmountCurrencyCode | String | The currency code for the charged amount. | |
FeePromotionAmount | Decimal | The promotion amount for a given fee. | |
FeePromotionCurrencyCode | String | The currency code for the promotion amount. | |
TaxAmount | Decimal | The tax amount for a given fee. | |
TaxCurrencyCode | String | The currency code for the tax amount . | |
FinalFeeAmount | Decimal | The final fee amount for a given fee. | |
FinalFeeCurrencyCode | String | The currency code for the final fee amount. | |
MarketplaceId | String | Required. The marketplace identifier. | |
IdType | String | Required. The item type.
The allowed values are ASIN, SellerSku. | |
Identifier | String | Required. The unique identifier provided by the caller to track this request. | |
IsAmazonFulfilled | Boolean | When true, the offer is fulfilled by Amazon. | |
ListingPriceAmount | Decimal | Required. The price of the item. | |
ListingPriceCurrencyCode | String | Required. The currency code for the price of the item. | |
ShippingAmount | Decimal | Required. The shipping cost. | |
ShippingCurrencyCode | String | Required. The currency code for the shipping cost. | |
PointsNumber | Decimal | Required. The number of Amazon Points offered with the purchase of an item. | |
PointsAmount | Decimal | Required. The monetary value for points. | |
PointsCurrencyCode | String | Required. The currency code for points. |
Returns a list of items in a specified inbound shipment.
Name | Type | References | Description |
ASIN [KEY] | String | The Amazon Standard Identification Number (ASIN) of the item. | |
SellerSKU [KEY] | String | The seller SKU of the item. | |
MarketplaceId | String | Required. Marketplace identifier for the report. | |
GuidanceReasonList | String | A list of reasons for the current inbound guidance for this item. | |
InboundGuidance | String | Specific inbound guidance for an item. | |
ErrorReason | String | The reason why the seller SKU or ASIN is invalid. |
Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network.
Name | Type | References | Description |
ASIN [KEY] | String | The Amazon Standard Identification Number (ASIN) of the item. | |
SellerSKU [KEY] | String | The seller SKU of the item. | |
ShipToCountryCode | String | Required. The country code of the country to which the items will be shipped. | |
BarcodeInstruction | String | Labeling requirements for the item. For more information about FBA labeling requirements, see the Seller Central Help for your marketplace. | |
PrepGuidance | String | Item preparation instructions. | |
PrepInstructionList | String | A list of preparation instructions to help with item sourcing decisions. | |
PrepInstruction | String | Preparation instructions for shipping an item to Amazon's fulfillment network. | |
FeePerUnitCurrencyCode | String | The fee currency code for Amazon to prepare 1 unit. | |
FeePerUnitValue | Decimal | The fee amount for Amazon to prepare 1 unit. | |
ErrorReason | String | The reason why the SellerSKU/ASIN is invalid. |
Returns a list of items in a specified inbound shipment.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM InboundShipmentItems WHERE MarketplaceId = 'ATVPDKIKX0DER'
SELECT * FROM InboundShipmentItems WHERE ShipmentId = 'FBA8J3K9LZPX'
SELECT * FROM InboundShipmentItems WHERE LastUpdatedDate > '2020-01-01'
Name | Type | References | Description |
ShipmentId [KEY] | String | The ID of the shipment. | |
SellerSKU [KEY] | String | The Seller SKU of the item. | |
QuantityShipped | Int | The item quantity that you are shipping. | |
QuantityInCase | Int | The item quantity in each case, for case-packed items. | |
QuantityReceived | Int | The item quantity that has been received at an Amazon fulfillment center. | |
FulfillmentNetworkSKU | String | Amazon's fulfillment network SKU of the item. | |
PrepDetailsList | String | A JSON aggregate of preparation instructions and who is responsible for that preparation. | |
MarketplaceId | String | Marketplace identifier for the report. | |
ReleaseDate | Date | The date that a pre-order item will be available for sale. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
LastUpdatedDate | Datetime | A date used for selecting inbound shipments that were last updated before/after a specified time. |
Returns a list of items in a specified inbound shipment.
Name | Type | References | Description |
MarketplaceId [KEY] | String | Required. A marketplace identifier. Specifies the marketplace the shipment is tied to. | |
ShipmentId [KEY] | String | Requried. A shipment identifier originally returned by the createInboundShipmentPlan operation. | |
ShipmentContainsPreorderableItems | Boolean | Indicates whether the shipment contains items that have been enabled for pre-order. For more information about enabling items for pre-order, see the Seller Central Help. | |
ShipmentConfirmedForPreorder | Boolean | Indicates whether this shipment has been confirmed for pre-order. | |
NeedByDate | Date | Date that the shipment would need to arrive at an Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items if this shipment is later confirmed for pre-order. In YYYY-MM-DD format. | |
ConfirmedFulfillableDate | Date | Date in YYYY-MM-DD format that determines which pre-order items in the shipment are eligible for pre-order. If this shipment is confirmed for pre-order with a subsequent call to the confirmPreorder operation, the pre-order Buy Box will appear for any pre-order items in the shipment with a release date on or after this date. |
Returns information about the availability of inventory that a seller has in Amazon's fulfillment network and in current inbound shipments. You can check the current availability status for your Fulfillment by Amazon inventory as well as discover when availability status changes.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
Note: Attributes 'GranularityType' and 'GranularityId' are required to query the view. You must set GranularityId to the MarketplaceId from the API matching your region.
Following are example queries which are processed server side:
SELECT * FROM InventorySupply WHERE GranularityType = 'Marketplace' AND GranularityId = 'ATVPDKIKX0DER' AND SellerSKU = '123'
SELECT * FROM InventorySupply WHERE GranularityType = 'Marketplace' AND GranularityId = 'ATVPDKIKX0DER' AND StartDateTime > '2020-01-01'
Name | Type | References | Description |
UID [KEY] | String | Auto Generated Primary Key field. | |
FNSKU | String | The Fulfillment Network SKU (FNSKU) of the item. The FNSKU is a unique identifier for each inventory item stored in an Amazon fulfillment center. | |
SellerSKU | String | The Seller SKU of the item. Required if the QueryStartDateTime is not specified. | |
ASIN | String | The Amazon Standard Identification Number (ASIN) of the item. | |
Condition | String | The condition of the item. | |
GranularityType | String | ||
GranularityId | String | ||
TotalQuantity | Integer | The total number of units in an inbound shipment or in Amazon fulfillment centers. | |
ProductName | String | The localized language product title of the item within the specific marketplace. | |
LastUpdatedTime | String | The date and time that any quantity was last updated. | |
FulfillableQuantity | Integer | The item quantity that can be picked, packed, and shipped. | |
InboundWorkingQuantity | Integer | The item quantity that can be picked, packed, and shipped. | |
InboundShippedQuantity | Integer | The item quantity that can be picked, packed, and shipped. | |
InboundReceivingQuantity | Integer | The item quantity that can be picked, packed, and shipped. | |
TotalReservedQuantity | Integer | The total number of units in Amazon's fulfillment network that are currently being picked, packed, and shipped. | |
PendingCustomerOrderQuantity | Integer | The number of units reserved for customer orders. | |
PendingTransshipmentQuantity | Integer | The number of units being transferred from one fulfillment center to another. | |
FcProcessingQuantity | Integer | The number of units that have been sidelined at the fulfillment center for additional processing. | |
TotalUnfulfillableQuantity | Integer | The total number of units in Amazon's fulfillment network in unsellable condition. | |
CustomerDamagedQuantity | Integer | The number of units in customer damaged disposition. | |
WarehouseDamagedQuantity | Integer | The number of units in warehouse damaged disposition. | |
DistributorDamagedQuantity | Integer | The number of units in distributor damaged disposition. | |
CarrierDamagedQuantity | Integer | The number of units in carrier damaged disposition. | |
DefectiveQuantity | Integer | The number of units in defective disposition. | |
ExpiredQuantity | Integer | The number of units in expired disposition. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
StartDateTime | Datetime | A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the current date and time. | |
MarketplaceId | String | The marketplace ID for the marketplace for which to return inventory summaries. |
Returns the lowest priced offers for a single item based on ASIN.
Name | Type | References | Description |
ASIN | String | Required. The Amazon Standard Identification Number (ASIN) of the item. | |
MarketplaceId | String | A marketplace identifier. Specifies the marketplace for which prices are returned. | |
ItemCondition | String | The condition of the lowest priced product listed.
The allowed values are New, Used, Collectible, Refurbished, Club. | |
OffersListingPriceAmount | Decimal | The listing price amount of the offered price. | |
OffersListingPriceCurrencyCode | String | The listing price currency code of the offered price. | |
OffersShippingAmount | Decimal | The shipping amount of the offered price. | |
OffersShippingCurrencyCode | String | The shipping currency code of the offered price. | |
FeedbackCount | Integer | The feedback count. | |
SellerPositiveFeedbackRating | Double | The positive feedback rating of the seller. | |
SellerId [KEY] | String | The seller Id. | |
ShippingTimeAvailabilityType | String | The shipping time availability type. | |
ShippingTimeMaximumHours | Integer | The maximum hours of shipping time. | |
ShippingTimeMinimumHours | Integer | The minimum hours of shipping time. | |
ShippingTimeAvailableDate | String | The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping. | |
QuantityDiscountPrices | String | Contains pricing information that includes special pricing when buying in bulk. | |
PointsNumber | Integer | The number of points. | |
PointsMonetaryValueCurrencyCode | String | The currency code in ISO 4217 format. | |
PointsMonetaryValueAmount | String | The monetary value. | |
IsBuyBoxWinner | Boolean | When true, the offer is currently in the Buy Box. There can be up to two Buy Box winners at any time per ASIN, one that is eligible for Prime and one that is not eligible for Prime. | |
IsPrime | Boolean | Indicates whether the offer is an Amazon Prime offer. | |
IsNationalPrime | Boolean | Indicates whether the offer is an Amazon Prime offer throughout the entire marketplace where it is listed. | |
ShipsFromCountry | String | The country from where the product is shipped. | |
ShipsFromState | String | The state from where the product is shipped. | |
IsFeaturedMerchant | Boolean | The boolean value of the merchant being featured. | |
IsFulfilledByAmazon | Boolean | The boolean value of the merchant being fulfilled by Amazon. | |
CustomerType | String | Indicates whether to request pricing information from the point of view of consumer or business buyers. Default is Consumer.
The allowed values are Consumer, Business. | |
MyOffer | Boolean | When true, this is the seller's offer. | |
OfferType | String | Indicates the type of customer that the offer is valid for. | |
SubCondition | String | The subcondition of the item. Subcondition values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other. | |
ConditionNotes | String | Information about the condition of the item. |
Generated schema file.
Name | Type | References | Description |
SellerSKU [KEY] | String | Identifies an item in the given marketplace. | |
MarketplaceId | String | A marketplace identifier. Specifies the marketplace for which prices are returned. | |
ItemCondition | String | The condition of the lowest priced product listed.
The allowed values are New, Used, Collectible, Refurbished, Club. | |
OffersListingPriceAmount | Decimal | The listing price amount of the offered price. | |
OffersListingPriceCurrencyCode | String | The listing price currency code of the offered price. | |
OffersShippingAmount | Decimal | The shipping amount of the offered price. | |
OffersShippingCurrencyCode | String | The shipping currency code of the offered price. | |
FeedbackCount | Integer | The feedback count. | |
SellerPositiveFeedbackRating | Double | The positive feedback rating of the seller. | |
SellerId | String | The seller Id. | |
ShippingTimeAvailabilityType | String | The shipping time availability type. | |
ShippingTimeMaximumHours | Integer | The maximum hours of shipping time. | |
ShippingTimeMinimumHours | Integer | The minimum hours of shipping time. | |
ShippingTimeAvailableDate | String | The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping. | |
QuantityDiscountPrices | String | Contains pricing information that includes special pricing when buying in bulk. | |
PointsNumber | Integer | The number of points. | |
PointsMonetaryValueCurrencyCode | String | The currency code in ISO 4217 format. | |
PointsMonetaryValueAmount | String | The monetary value. | |
IsBuyBoxWinner | Boolean | When true, the offer is currently in the Buy Box. There can be up to two Buy Box winners at any time per ASIN, one that is eligible for Prime and one that is not eligible for Prime. | |
IsPrime | Boolean | Indicates whether the offer is an Amazon Prime offer. | |
IsNationalPrime | Boolean | Indicates whether the offer is an Amazon Prime offer throughout the entire marketplace where it is listed. | |
ShipsFromCountry | String | The country from where the product is shipped. | |
ShipsFromState | String | The state from where the product is shipped. | |
IsFeaturedMerchant | Boolean | The boolean value of the merchant being featured. | |
IsFulfilledByAmazon | Boolean | The boolean value of the merchant being fulfilled by Amazon. | |
CustomerType | String | Indicates whether to request pricing information from the point of view of consumer or business buyers. Default is Consumer.
The allowed values are Consumer, Business. | |
MyOffer | Boolean | When true, this is the seller's offer. | |
OfferType | String | Indicates the type of customer that the offer is valid for. | |
SubCondition | String | The subcondition of the item. Subcondition values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other. | |
ConditionNotes | String | Information about the condition of the item. |
The GetFeedSubmissionList operation returns a list of feed submissions.
The following filters are required:
SELECT * FROM ListingsItemsIssues WHERE SKU = '12345' AND SellerId = 'XXXXXXXXXXXXXX'
Name | Type | References | Description |
SKU | String | A selling partner provided identifier for an Amazon listing. | |
Code | String | An issue code that identifies the type of issue. | |
Message | String | A message that describes the issue. | |
Severity | String | The severity of the issue.
The allowed values are INFO, WARNING, ERROR. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
SellerId | String | A selling partner identifier, such as a merchant account or vendor code. |
The GetFeedSubmissionList operation returns a list of feed submissions.
The following filters are required:
SELECT * FROM ListingsItemsOffers WHERE SKU = '12345' AND SellerId = 'XXXXXXXXXXXXXX'
Name | Type | References | Description |
SKU | String | A selling partner provided identifier for an Amazon listing | |
MarketplaceId | String | A marketplace identifier. Identifies the Amazon marketplace for the listings item. | |
OfferType | String | Type of offer for the listings item.
The allowed values are B2B, B2C. | |
PriceAmount | String | Purchase price amount of the listings item. | |
PriceCurrency | String | Purchase price currency of the listings item. | |
Points | String | The number of Amazon Points offered with the purchase of an item, and their monetary value. Note that the Points element is only returned in Japan (JP). |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
SellerId | String | A selling partner identifier, such as a merchant account or vendor code. |
The GetFeedSubmissionList operation returns a list of feed submissions.
The following filters are required:
SELECT * FROM ListingsItemsSummaries WHERE SKU = '12345' AND SellerId = 'XXXXXXXXXXXXXX'
Name | Type | References | Description |
SKU | String | A selling partner provided identifier for an Amazon listing. | |
Asin | String | Amazon Standard Identification Number (ASIN) of the listings item. | |
ConditionType | String | Identifies the condition of the listings item.
The allowed values are new_new, new_open_box, new_oem, refurbished_refurbished, used_like_new, used_very_good, used_good, used_acceptable, collectible_like_new, collectible_very_good, collectible_good, collectible_acceptable, club_club. | |
CreatedDate | Datetime | Date the listings item was created, in ISO 8601 format. | |
ItemName | String | Name, or title, associated with an Amazon catalog item. | |
LastUpdatedDate | Datetime | Date the listings item was last updated, in ISO 8601 format. | |
MainImageLink | String | Link, or URL, for the main image. | |
MainImageHeight | Integer | Height of the main image in pixels. | |
MainImageWidth | Integer | Width of the main image in pixels. | |
MarketplaceId | String | A marketplace identifier. Identifies the Amazon marketplace for the listings item. | |
ProductType | String | The Amazon product type of the listings item. | |
Status | String | Statuses that apply to the listings item. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
SellerId | String | A selling partner identifier, such as a merchant account or vendor code. |
Returns order items based on the Amazon Order Id that you specify.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App. OrderItems table supports server side filtering with = and IN operators for AmazonOrderId field.
SELECT * FROM OrderItems WHERE AmazonOrderId = '503-9993250-1405404'
Name | Type | References | Description |
OrderItemId [KEY] | String | An Amazon-defined order item identifier. | |
AmazonOrderId | String |
Orders.AmazonOrderId | The Amazon ID of the order. |
ASIN | String | The Amazon Standard Identification Number (ASIN) of the item. | |
SellerSKU | String | The seller stock keeping unit (SKU) of the item. | |
BuyerCustomizedInfoCustomizedURL | String | The Buyer CustomizedURL. | |
Title | String | The name of the item. | |
QuantityOrdered | Integer | The quantity of items ordered. | |
QuantityShipped | Integer | The quantity of items shipped. | |
GrantedPointsNumber | Integer | The Granted Points Number. | |
GrantedPointsMonetaryValueAmount | Decimal | The Granted Points Amount. | |
GrantedPointsMonetaryValueCurrencyCode | String | The Granted Points CurrencyCode. | |
NumberOfItems | Integer | The total number of items that are included in the ASIN. | |
ItemPriceAmount | Decimal | The Item Price Amount. | |
ItemPriceCurrencyCode | String | The Item Price Currency Code. | |
ShippingPriceAmount | Decimal | The Shipping Price Amount. | |
ShippingPriceCurrencyCode | String | The Shipping Price Currency Code. | |
ItemTaxAmount | Decimal | The Item Tax Amount. | |
ItemTaxCurrencyCode | String | The Item Tax Currency Code. | |
ShippingTaxAmount | String | The Shipping Tax Amount. | |
ShippingTaxCurrencyCode | String | The ShippingTax Currency Code. | |
ShippingDiscountAmount | String | The Shipping Discount Amount. | |
ShippingDiscountCurrencyCode | String | The Shipping Discount Currency Code. | |
ShippingDiscountTaxAmount | String | The Shipping Discount Tax Amount. | |
ShippingDiscountTaxCurrencyCode | String | The Shipping Discount Tax Currency Code. | |
PromotionDiscountAmount | Decimal | The Promotion Discount Amount. | |
PromotionDiscountCurrencyCode | String | The Promotion Discount Currency Code. | |
PromotionDiscountTaxAmount | Decimal | The Promotion Discount Tax Amount. | |
PromotionDiscountTaxCurrencyCode | String | The Promotion Discount Tax Currency Code. | |
PromotionIds | String | The IDs of Promotions. | |
CODFeeAmount | Decimal | The COD FeeAmount. | |
CODFeeCurrencyCode | String | The COD FeeCurrency Code. | |
CODFeeDiscountAmount | String | The COD FeeDiscount Amount. | |
CODFeeDiscountCurrencyCode | String | The COD FeeDiscount Currency Code. | |
IsGift | Boolean | Boolean specifying if the item is gift. | |
ConditionNote | String | The Condition Note. | |
ConditionId | String | The Condition Id. | |
ConditionSubtypeId | String | The Condition Subtype Id. | |
ScheduledDeliveryStartDate | Datetime | The Scheduled Delivery StartDate. | |
ScheduledDeliveryEndDate | Datetime | The Scheduled Delivery EndDate. | |
PriceDesignation | String | The Price Designation. | |
TaxCollectionModel | String | The tax collection model applied to the item. | |
TaxCollectionResponsibleParty | String | The party responsible for withholding the taxes and remitting them to the taxing authority. | |
SerialNumberRequired | Boolean | When true, the product type for this item has a serial number. Returned only for Amazon Easy Ship orders. | |
IsTransparency | Boolean | When true, transparency codes are required. | |
IossNumber | String | The IOSS number for the marketplace. | |
StoreChainStoreId | String | The store chain store identifier. Linked to a specific store in a store chain. | |
DeemedResellerCategory | String | Applies to selling partners that are not based in the EU and is used to help them meet the VAT Deemed Reseller tax laws in the EU and UK. | |
IsBuyerRequestedCancel | Boolean | When true, the buyer has requested cancellation. | |
BuyerCancelReason | String | The reason that the buyer requested cancellation. | |
BuyerCustomizedInfoURL | String | The location of a zip file containing Amazon Custom data. | |
GiftWrapPriceAmount | String | The Gift Wrap Price Amount. | |
GiftWrapPriceCurrencyCode | String | The Gift Wrap Price Currency Code. | |
GiftWrapTaxAmount | String | The Gift Wrap Tax Amount. | |
GiftWrapTaxCurrencyCode | String | The Gift Wrap Tax Currency Code. | |
GiftMessageText | String | A gift message provided by the buyer. | |
GiftWrapLevel | String | The gift wrap level specified by the buyer. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
LastUpdateDate | Datetime | The last time the order is updated. |
Returns aggregated order metrics for a given interval, broken down by granularity, for a given buyer type.
Name | Type | References | Description |
IntervalTime | String | A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). Example: 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 requests order metrics for Sept 1st, 2nd and 3rd in the -07:00 zone. | |
UnitCount | String | The number of units in orders based on the specified filters. | |
OrderItemCount | String | The number of order items based on the specified filters. | |
OrderCount | String | The number of orders based on the specified filters. | |
AverageUnitPriceCurrencyCode | String | Three-digit currency code. In ISO 4217 format. | |
AverageUnitPriceAmount | String | The currency amount. | |
TotalSalesCurrencyCode | String | Three-digit currency code. In ISO 4217 format. | |
TotalSalesAmount | String | The currency amount. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
GranularityTimeZone | String | An IANA-compatible time zone for determining the day boundary. Required when specifying a granularity value greater than Hour. The granularityTimeZone value must align with the offset of the specified interval value. | |
Granularity | String | The granularity of the grouping of order metrics, based on a unit of time. Specifying granularity=Hour results in a successful request only if the interval specified is less than or equal to 30 days from now. For all other granularities, the interval specified must be less or equal to 2 years from now. | |
MarketplaceId | String | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | |
BuyerType | String | Filters the results by the buyer type that you specify, B2B (business to business) or B2C (business to customer). Example: B2B, if you want the response to include order metrics for only B2B buyers. | |
FulfillmentNetwork | String | Filters the results by the fulfillment network that you specify, MFN (merchant fulfillment network) or AFN (Amazon fulfillment network). Do not include this filter if you want the response to include order metrics for all fulfillment networks. | |
FirstDayOfWeek | String | Specifies the day that the week starts on when granularity=Week, either Monday or Sunday. Default: Monday. | |
Asin | String | Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. | |
Sku | String | Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. |
Returns orders created or updated during a time frame that you specify.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Orders WHERE AmazonOrderId = '249-7638334-8161403'
SELECT * FROM Orders WHERE SellerOrderId = '249-7638334' AND purchasedate > '2010-01-01'
SELECT * FROM Orders WHERE LastUpdateDate >= '2016-12-12'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12'
SELECT * FROM Orders WHERE MarketplaceId = 'ATVPDKIKX0DER'
SELECT * FROM Orders WHERE BuyerEmail = '[email protected]'
SELECT * FROM Orders WHERE IsISPU = false
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND OrderStatus = 'Canceled'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND FulfillmentChannel = 'MFN'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND BuyerEmail = '[email protected]'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND PaymentMethod = 'Other'
Name | Type | References | Description |
AmazonOrderId [KEY] | String | The Amazon ID of the order. | |
SellerOrderId | String | The Seller ID of the order. | |
PurchaseDate | Datetime | The date of the purchase. | |
LastUpdateDate | Datetime | The last update date. | |
OrderStatus | String | Status of the order. | |
FulfillmentChannel | String | The Fulfillment Channel. | |
SalesChannel | String | The Sales Channel. | |
OrderChannel | String | The Order Channel. | |
ShipServiceLevel | String | The level of the Ship Service. | |
ShippingAddressName | String | The Shipping Address Name. | |
ShippingAddressAddressLine1 | String | The Shipping Address AddressLine. | |
ShippingAddressAddressLine2 | String | The Shipping Address AddressLine. | |
ShippingAddressAddressLine3 | String | The Shipping Address AddressLine. | |
ShippingAddressCity | String | The Shipping Address City. | |
ShippingAddressCounty | String | The Shipping Address County. | |
ShippingAddressDistrict | String | The Shipping Address District. | |
ShippingAddressStateOrRegion | String | The Shipping Address State Or Region. | |
ShippingAddressPostalCode | String | The Shipping Address Postal Code. | |
ShippingAddressCountryCode | String | The Shipping Address Country Code. | |
ShippingAddressPhone | String | The Shipping Address Phone. | |
ShippingAddressMunicipality | String | The Shipping Municipality. | |
ShippingAddress_AddressType | String | The Shipping Address Type. | |
DefaultShipAddressName | String | The Shipping Address Name. | |
DefaultShipAddressLine1 | String | Default Ship From Location Address AddressLine. | |
DefaultShipAddressLine2 | String | Default Ship From Location Address AddressLine. | |
DefaultShipAddressLine3 | String | Default Ship From Location Address AddressLine. | |
DefaultShipCity | String | Default Ship From Location Address City. | |
DefaultShipCounty | String | Default Ship From Location Address County. | |
DefaultShipDistrict | String | Default Ship From Location Address District. | |
DefaultShipStateOrRegion | String | Default Ship From Location Address State Or Region. | |
DefaultShipPostalCode | String | Default Ship From Location Address Postal Code. | |
DefaultShipCountryCode | String | Default Ship From Location Address Country Code. | |
DefaultShipPhone | String | Default Ship From Location Address Phone. | |
DefaultShipMunicipality | String | The Default Ship Municipality. | |
DefaultShip_AddressType | String | Default Ship From Location Address Type. | |
OrderTotalCurrencyCode | String | The Order Currency Code. | |
OrderTotalAmount | Decimal | The Order Amount. | |
NumberOfItemsShipped | Integer | The Number Of Items Shipped. | |
NumberOfItemsUnshipped | Integer | The Number Of Items Unshipped. | |
PaymentExecutionDetail | String | The Payment Execution Detail. | |
PaymentMethod | String | The Payment Method. | |
PaymentMethodDetails | String | The Details of payment method. | |
IsReplacementOrder | Boolean | Boolean specifying if it is a replacement order. | |
ReplacedOrderId | String | The Replaced OrderId. | |
MarketplaceId | String | The MarketplaceId. | |
BuyerEmail | String | The Buyer Email. | |
BuyerName | String | The Buyer Name. | |
BuyerCounty | String | The Buyer Country. | |
BuyerTaxInfo | String | The Buyer Tax Info. | |
BuyerInvoicePreference | String | Can be individual or business. | |
ShipmentServiceLevelCategory | String | The Shipment Service Level Category. | |
ShippedByAmazonTFM | Boolean | The Shipped By Amazon TFM. | |
TFMShipmentStatus | String | The TFM Shipment Status. | |
CbaDisplayableShippingLabel | String | The Cba Displayable Shipping Label. | |
OrderType | String | The Type of Order. | |
HasAutomatedShippingSettings | Boolean | If true, this order has automated shipping settings generated by Amazon. This order could be identified as an SSA order. | |
AutomatedCarrier | String | Auto-generated carrier for SSA orders | |
AutomatedShipMethod | String | Auto-generated ship method for SSA orders. | |
EarliestShipDate | Datetime | The Earliest Ship Date. | |
EasyShipShipmentStatus | String | The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders. | |
HasRegulatedItems | Boolean | Whether the order contains regulated items which may require additional approval steps before being fulfilled. | |
PromiseResponseDueDate | Datetime | Indicates the date by which the seller must respond to the buyer with an estimated ship date. Returned only for Sourcing on Demand orders. | |
LatestShipDate | Datetime | The Latest Ship Date. | |
EarliestDeliveryDate | Datetime | The Earliest Delivery Date . | |
LatestDeliveryDate | Datetime | The Latest Delivery Date. | |
IsBusinessOrder | Boolean | Boolean specifying if it is a Business Order. | |
IsEstimatedShipDateSet | Boolean | When true, the estimated ship date is set for the order. Returned only for Sourcing on Demand orders. | |
IsSoldByAB | Boolean | When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). | |
IsIBA | Boolean | When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). | |
IsISPU | Boolean | When true, this order is marked to be picked up from a store rather than delivered. | |
IsGlobalExpressEnabled | Boolean | When true, the order is a GlobalExpress order. | |
PurchaseOrderNumber | String | The Purchase Order Number. | |
IsPrime | Boolean | Boolean specifying if it is a Prime Order. | |
IsPremiumOrder | Boolean | Boolean specifying if it is a Premium Order. |
Usage information for the operation OrderScheduleDetailsListInternal.rsd.
Name | Type | References | Description |
AmazonOrderId | String | ||
PackageIdentifier | String | ||
Slotid | String | ||
StartTime | Datetime | ||
EndTime | Datetime | ||
HandoverMethod | String |
Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature.
Name | Type | References | Description |
MarketplaceId [KEY] | String | Required. The marketplace identifier. | |
FeatureName | String | The feature name. | |
FeatureDescription | String | The feature description. | |
SellerEligible | Boolean | Indicates whether the seller is eligible to use the feature. | |
SellerSku | String | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | |
FnSku | String | The unique SKU used by Amazon's fulfillment network. | |
Asin | String | The Amazon Standard Identification Number (ASIN) of the item. | |
SkuCount | String | The number of SKUs available for this service. | |
OverlappingSkus | String | Other seller SKUs that are shared across the same inventory. | |
IneligibleReasons | String | A list of one or more reasons that the seller SKU is ineligible for the feature. |
Returns the fulfillment order items indicated by the specified order identifier.
Name | Type | References | Description |
SellerFulfillmentOrderId [KEY] | String | The fulfillment order identifier | |
SellerFulfillmentOrderItemId [KEY] | String | A fulfillment order item identifier submitted with a call to the createFulfillmentOrder operation. | |
SellerSku | String | The seller SKU of the item. | |
CancelledQuantity | Integer | The item quantity that was cancelled by the seller. | |
EstimatedArrivalDate | Datetime | The estimated arrival date and time of the item quantity. Note that this value can change over time. If the shipment that contains the item quantity has been cancelled, estimatedArrivalDate is not returned. | |
EstimatedShipDate | Datetime | The estimated date and time that the item quantity is scheduled to ship from the fulfillment center. Note that this value can change over time. If the shipment that contains the item quantity has been cancelled, estimatedShipDate is not returned. | |
FulfillmentNetworkSku | String | Amazon's fulfillment network SKU of the item. | |
OrderItemDisposition | String | Indicates whether the item is sellable or unsellable. | |
Quantity | Integer | The item quantity. | |
UnfulfillableQuantity | Integer | The item quantity that is unfulfillable. | |
GiftMessage | String | A message to the gift recipient, if applicable. | |
DisplayableComment | String | Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip. | |
PerUnitDeclaredValue | Decimal | The monetary value assigned by the seller to this item. | |
PerUnitDeclaredCurrencyCode | String | The currency code of the monetary value assigned by the seller to this item. | |
PerUnitTaxValue | Decimal | The tax on the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order. | |
PerUnitTaxCurrencyCode | String | The currency code of the tax on the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order. | |
PerUnitPriceValue | Decimal | The amount to be collected from the recipient for this item in a COD (Cash On Delivery) order. | |
PerUnitPriceCurrencyCode | String | The currency code of the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order. |
Returns a list of fulfillment order previews based on shipping criteria that you specify.
Name | Type | References | Description |
SellerFulfillmentOrderItemId [KEY] | String | A fulfillment order item identifier that the seller created with a call to the createFulfillmentOrder operation. | |
EarliestArrivalDate | Datetime | The earliest date that the shipment is expected to arrive at its destination. | |
EarliestShipDate | Datetime | The earliest date that the shipment is expected to be sent from the fulfillment center, in ISO 8601 date time format. | |
EstimatedShippingWeightUnit | String | The estimated shipping unit weight of the item quantity for a single item, as identified by sellerSku, in a shipment. | |
EstimatedShippingWeightValue | String | The estimated shipping weight value of the item quantity for a single item, as identified by sellerSku, in a shipment. | |
IsCodCapable | Boolean | Indicates whether this fulfillment order preview is for COD (Cash On Delivery). | |
IsFulfillable | Boolean | Indicates whether this fulfillment order preview is fulfillable. | |
LatestArrivalDate | Datetime | The latest date that the shipment is expected to arrive at its destination, in ISO 8601 date time format. | |
LatestShipDate | Datetime | The latest date that the shipment is expected to be sent from the fulfillment center, in ISO 8601 date time format. | |
MarketplaceId | String | The marketplace the fulfillment order is placed against. | |
Quantity | Integer | The item quantity. | |
SellerSku | String | The seller SKU of the item. | |
ShippingSpeedCategory | String | The shipping method used for the fulfillment order. When this value is ScheduledDelivery, choose Ship for the fulfillmentAction. Hold is not a valid fulfillmentAction value when the shippingSpeedCategory value is ScheduledDelivery. | |
ScheduledDeliveryInfo | String | Provides additional insight into the shipment timeline when exact delivery dates are not able to be precomputed. | |
ShippingWeightCalculationMethod | String | The method used to calculate the estimated shipping weight. | |
UnfulfilledItemQuantity | Integer | The item quantity of the unfulfillable item. | |
UnfulfilledItemSellerFulfillmentOrderItemId | String | The fulfillment order item identifier of the unfulfillable item. | |
UnfulfilledItemUnfulfillableReasons | String | Error codes associated with the fulfillment order preview that indicate why the item is unfulfillable. | |
AddressLine1 | String | The first line of the address. | |
AddressLine2 | String | Additional address information. | |
AddressLine3 | String | Additional address information. | |
City | String | The city where the person, business, or institution is located. This property is required in all countries except Japan. It should not be used in Japan. | |
CountryCode | String | The two digit country code. In ISO 3166-1 alpha-2 format. | |
DistrictOrCounty | String | The district or county where the person, business, or institution is located. | |
AddressName | String | The name of the person, business or institution at the address. | |
PostalCode | String | The postal code of the address. | |
StateOrRegion | String | The state or region where the person, business or institution is located. | |
Phone | String | The phone number of the person, business, or institution located at the address. | |
IncludeCODFulfillmentPreview | Boolean | When true, returns all fulfillment order previews both for COD and not for COD. Otherwise, returns only fulfillment order previews that are not for COD. | |
IncludeDeliveryWindows | Boolean | When true, returns the ScheduledDeliveryInfo response object, which contains the available delivery windows for a Scheduled Delivery. The ScheduledDeliveryInfo response object can only be returned for fulfillment order previews with ShippingSpeedCategories = ScheduledDelivery. |
Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.
Name | Type | References | Description |
PackageNumber [KEY] | Integer | Required.The package identifier. | |
AdditionalLocationInfo | String | Additional location information. | |
CarrierCode | String | The name of the carrier. | |
CarrierPhoneNumber | String | The phone number of the carrier. | |
CarrierURL | String | The URL of the carrier's website. | |
CustomerTrackingLink | String | Link on swiship.com that allows customers to track the package. | |
CurrentStatus | String | The current delivery status of the package. | |
CurrentStatusDescription | String | Description corresponding to the CurrentStatus value. | |
EstimatedArrivalDate | Datetime | The estimated arrival date. | |
ShipDate | Datetime | The shipping date for the package. | |
ShipToAddressCity | String | The destination city address information for tracking the package. | |
ShipToAddressCountry | String | The destination state address information for tracking the package. | |
ShipToAddressState | String | The destination country address information for tracking the package. | |
SignedForBy | String | The name of the person who signed for the package. | |
EventAddressCity | String | The city address information where the delivery event took place. | |
EventAddressCountry | String | The country address information where the delivery event took place. | |
EventAddressState | String | The state address information where the delivery event took place. | |
EventCode [KEY] | String | The event code where the delivery event took place. | |
EventDate | Datetime | The date and time that the delivery event took place, in ISO 8601 date time format. | |
EventDescription | String | A description for the corresponding event code. | |
TrackingNumber | String | The tracking number for the package. |
An array of items that Amazon accepted for return. Returns empty if no items were accepted for return.
Name | Type | References | Description |
SellerFulfillmentOrderId [KEY] | String | The fulfillment order identifier. | |
SellerReturnItemId | String | An identifier assigned by the seller to the return item. | |
RmaPageURL | String | A URL for a web page that contains the return authorization barcode and the mailing label. This does not include pre-paid shipping. | |
ReturnAuthorizationId | String | An identifier for the return authorization. This identifier associates return items with the return authorization used to return them. | |
SellerFulfillmentOrderItemId | String | The identifier assigned to the item by the seller when the fulfillment order was created. | |
AmazonReturnReasonCode | String | The return reason code that the Amazon fulfillment center assigned to the return item. | |
AmazonShipmentId | String | The identifier for the shipment that is associated with the return item. | |
ReturnComment | String | An optional comment about the return item. | |
Status | String | Indicates if the return item has been processed by an Amazon fulfillment center. | |
StatusChangedDate | Datetime | Indicates when the status last changed. | |
AmazonRmaId | String | The return merchandise authorization (RMA) that Amazon needs to process the return. | |
FulfillmentCenterId | String | An identifier for the Amazon fulfillment center that the return items should be sent to. | |
ReturnToAddressAddressLine1 | String | The first line of the address. | |
ReturnToAddressAddressLine2 | String | Additional address information. | |
ReturnToAddressAddressLine3 | String | Additional address information. | |
ReturnToAddressCity | String | The city where the person, business, or institution is located. This property is required in all countries except Japan. It should not be used in Japan. | |
ReturnToAddressCountryCode | String | The two digit country code. In ISO 3166-1 alpha-2 format. | |
ReturnToAddressDistrictOrCounty | String | The district or county where the person, business, or institution is located. | |
ReturnToAddressName | String | The name of the person, business or institution at the address. | |
ReturnToAddressPostalCode | String | The postal code of the address. | |
ReturnToAddressStateOrRegion | String | The state or region where the person, business or institution is located. |
Returns a list of return reason codes for a seller SKU in a given marketplace.
Name | Type | References | Description |
ReturnReasonCode [KEY] | String | A code that indicates a valid return reason. | |
Description | String | A human readable description of the return reason code. | |
TranslatedDescription | String | A translation of the description. The translation is in the language specified in the Language request parameter. | |
SellerSku | String | Required. The seller SKU for which return reason codes are required. | |
MarketplaceId | String | The marketplace for which the seller wants return reason codes. | |
Language | String | The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into. | |
SellerFulfillmentOrderId | String | Required. The fulfillment order identifier. |
Usage information for the operation PackageItemsInternal.rsd.
Name | Type | References | Description |
orderItemId | String | ||
orderItemSerialNumbers | String |
Generated schema file.
Name | Type | References | Description |
ASIN [KEY] | String | The value of Amazon Standard Identification Number for the product. | |
SellerSKU | String | Stock Keeping Unit that identifies a product in the Amazon catalog. | |
MarketplaceId | String | A marketplace identifier. Specifies the marketplace for which prices are returned. | |
LandedPriceAmount | Decimal | The landed price amount of the buying price. | |
LandedPriceCurrencyCode | String | The landed price currency code of the buying price. | |
ListingPriceAmount | Decimal | The listing price amount of the buying price. | |
ListingPriceCurrencyCode | String | The listing price currency code of the buying price. | |
ShippingAmount | Decimal | The shipping amount of the buying price. | |
ShippingCurrencyCode | String | The shipping currency code of the buying price. | |
FulfillmentChannel | String | The fulfillment channel for the product listed. | |
ItemCondition | String | The condition of the product listed. | |
ItemSubCondition | String | The sub-condition of the product listed. | |
RegularPriceAmount | Decimal | The regular price amount of the product. | |
RegularPriceCurrencyCode | String | The regular price currecny code for the product. | |
Status | String | The status of the product. | |
ItemType | String | Required. Indicates whether ASIN values or seller SKU values are used to identify items.
The allowed values are Asin, Sku. | |
CustomerType | String | Indicates whether to request pricing information from the point of view of consumer or business buyers. Default is Consumer.
The allowed values are Consumer, Business. | |
OfferType | String | Indicates whether to request pricing information for the seller's B2C (business-to-consumer) or B2B (business-to-business) offers. Default is B2C.
The allowed values are B2C, B2B. |
Returns report details for the reports that match the filters that you specify.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
Note: 'ReportType' attribute is required to query the view. You can view available values for 'ReportType' in Amazon Selling-Partner API Documentation, or you can query the 'ReportTypes' view.
Following are example queries that are processed server side:
SELECT * FROM ReportList WHERE ReportId = '51013018828'
SELECT * FROM ReportList WHERE ReportType = 'GET_FLAT_FILE_OPEN_LISTINGS_DATA'
SELECT * FROM ReportList WHERE ReportType = 'GET_FLAT_FILE_OPEN_LISTINGS_DATA' AND CreatedTime > '2021-06-12' AND CreatedTime < '2021-08-01 12:00:00'
SELECT * FROM ReportList WHERE ReportType = 'GET_FLAT_FILE_OPEN_LISTINGS_DATA' AND MarketplaceIds = 'A1VC38T7YXB528'
SELECT * FROM ReportList WHERE ReportType = 'GET_FLAT_FILE_OPEN_LISTINGS_DATA' AND ProcessingStatus = 'DONE'
Note: When filtering with CreatedTime, values older than 90 days will not be accepted.
Name | Type | References | Description |
ReportId [KEY] | String | Report Id. | |
ReportType | String | The type of the Report. ReportType is not required when UseSandbox=True. | |
ReportDocumentId | String | The identifier for the report document. | |
CreatedTime | Datetime | The date and time when the report was created. While filtering, CreatedTime value is only accepted till 90 days old. | |
DataStartTime | Datetime | The start of a date and time range used for selecting the data to report. | |
DataEndTime | Datetime | The end of a date and time range used for selecting the data to report. | |
MarketplaceIds | String | A list of marketplace identifiers for the report. | |
ProcessingStartTime | Datetime | The date and time when the report processing started. | |
ProcessingEndTime | Datetime | The date and time when the report processing completed. | |
ProcessingStatus | String | The processing status of the report. |
Returns report details for the reports that match the filters that you specify.
This view lists all the available Report Types of Selling Partner API and their respective format (JSON, XML, CSV, TSV, PDF, XLSX).
SELECT * FROM ReportTypes
Name | Type | References | Description |
ReportTypeId [KEY] | String | Sequential id of the report type. | |
ReportTypeValue | String | Enumeration value of the report type. | |
ReportFormat | String | The download format of the report type
The allowed values are JSON, XML, CSV, TSV, PDF, XLSX. | |
Category | String | Report format category. | |
Description | String | Report format description. | |
URL | String | Amazon Selling-Partner API Documentation link of the report type. |
Returns the shipping documents associated with a package in a shipment.
Name | Type | References | Description |
ShipmentId [KEY] | String | Required. The unique shipment identifier provided by a shipping service. | |
PackageClientReferenceId | String | Required. A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation. | |
PackageDocumentType | String | The type of shipping document. | |
PackageDocumentFormat | String | The file format of the document. | |
PackageDocumentContents | String | A Base64 encoded string of the file contents. | |
PackageDocumentDPI | Long | The resolution of the document (for example, 300 means 300 dots per inch). | |
TrackingId | String | The carrier generated identifier for a package in a purchased shipment. | |
ShippingBusinessId | String | Amazon shipping business to assume for this request. The default is AmazonShipping_UK. Refer X-amzn-shipping-business-id for other marketplaces. |
Returns the available shipping service offerings.
Name | Type | References | Description |
ServiceId [KEY] | String | An identifier for the shipping service. | |
IsEligible | Boolean | A boolean value that indicates whether the shipping service offering is eligible. | |
RequestToken | String | A unique token generated to identify a getRates operation. | |
AvailableValueAddedServiceGroups | String | A JSON format of value-added services available for a shipping service offering. | |
BilledWeightUnit | String | The weight unit. | |
BilledWeightValue | Decimal | The weight value. | |
CarrierId | String | The carrier identifier for the offering, provided by the carrier. | |
CarrierName | String | The carrier name for the offering. | |
DeliveryWindowStartTime | Datetime | The promised start time of delivery. | |
DeliveryWindowEndTime | Datetime | The promised end time of delivery. | |
PickupWindowStartTime | Datetime | The promised start time of pickup. | |
PickupWindowEndTime | Datetime | The promised end time of pickup. | |
RequiresAdditionalInputs | Boolean | When true, indicates that additional inputs are required to purchase this shipment service. | |
RateId | String | An identifier for the rate (shipment offering) provided by a shipping service provider. | |
ServiceName | String | The name of the shipping service. | |
SupportedDocumentSpecifications | String | A JSON format of the document specifications supported for a shipment service offering. | |
TotalChargeUnit | String | The currency code of the total charge. | |
TotalChargeValue | Decimal | The monetary value of the total charge. | |
IneligibilityReasons | String | A JSON aggregate of reasons why a shipping service offering is ineligible. | |
ShipTo | String | Required. The ship to address. | |
ShipFrom | String | The ship from address. | |
ReturnTo | String | The return to address. | |
ShipDate | Datetime | The ship date and time (the requested pickup). This defaults to the current date and time. | |
Packages | String | A list of packages to be shipped through a shipping service offering. | |
ValueAddedServicesValue | Decimal | A collection's monetary value of supported value-added services. | |
ValueAddedServicesUnit | String | A collection's currency code of supported value-added services. | |
TaxDetailsType | String | Indicates the type of tax. | |
TaxDetailsRegistrationNumber | String | The shipper's tax registration number associated with the shipment for customs compliance purposes in certain regions. | |
ChannelType | String | The shipment source channel type.
The allowed values are AMAZON, EXTERNAL. The default value is AMAZON. | |
AmazonOrderDetails | String | The Amazon order ID associated with the Amazon order fulfilled by this shipment.. This is required if the shipment source channel is Amazon. | |
AmazonShipmentDetails | String | The encrypted shipment ID. This attribute is required only for a Direct Fulfillment shipment. | |
ShippingBusinessId | String | Amazon shipping business to assume for this request. The default is AmazonShipping_UK. Refer X-amzn-shipping-business-id for other marketplaces. |
Returns tracking information for a purchased shipment.
Name | Type | References | Description |
TrackingId [KEY] | String | A carrier-generated tracking identifier originally returned by the purchaseShipment operation. | |
CarrierId | String | A carrier identifier originally returned by the getRates operation for the selected rate. | |
AlternateLegTrackingId | String | The carrier generated reverse identifier for a returned package in a purchased shipment. | |
PromisedDeliveryDate | Datetime | The date and time by which the shipment is promised to be delivered. | |
SummaryStatus | String | A package status summary. | |
EventCode | String | The tracking event type. | |
EventTime | Datetime | The ISO 8601 formatted timestamp of the event. | |
City | String | The city or town where the event is located. | |
CountryCode | String | The two digit country code. Follows ISO 3166-1 alpha-2 format. | |
PostalCode | String | The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. | |
StateOrRegion | String | The state, county or region where the event is located. | |
ShippingBusinessId | String | Amazon shipping business to assume for this request. The default is AmazonShipping_UK. Refer X-amzn-shipping-business-id for other marketplaces. |
Usage information for the operation UpdatePackageDetailsListInternal.rsd.
Name | Type | References | Description |
AmazonOrderId | String | ||
PackageId | String | ||
SlotId | String | ||
StartTime | String | ||
EndTime | String | ||
HandoverMethod | String |
This view is part of Vendor Direct Fulfillment Shipping API. Returns a list of customer invoices created during a time frame that you specify. The date range to search must be no more than 7 days.
Some example queries:
SELECT * FROM VendorCustomerInvoices WHERE PurchaseOrderNumber = '12345'
SELECT * FROM VendorCustomerInvoices WHERE CreatedDate > '2022-09-10T12:00:00' AND CreatedDate < '2022-09-15T12:00:00'
Name | Type | References | Description |
PurchaseOrderNumber [KEY] | String | This field will contain the Purchase Order Number for this order. | |
Content | String | The Base64encoded customer invoice. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
CreatedDate | String | Filters for created date. If left empty the default specified range is from 6 days earlier to today. |
The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
Following are example queries which are processed server side:
SELECT * FROM VendorOrders
SELECT * FROM VendorOrders WHERE PurchaseOrderNumber = '123456789'
SELECT * FROM VendorOrders WHERE PurchaseOrderState = 'New'
SELECT * FROM VendorOrders ORDER BY PurchaseOrderDate DESC
SELECT * FROM VendorOrders WHERE PurchaseOrderDate > '2022-06-01T12:00:00' AND PurchaseOrderDate < '2022-06-10T12:00:00'
SELECT * FROM VendorOrders WHERE PurchaseOrderChangedDate > '2022-06-01T12:00:00' AND PurchaseOrderChangedDate < '2022-06-10T12:00:00'
SELECT * FROM VendorOrders WHERE SellerPartyId = '123456789'
Name | Type | References | Description |
PurchaseOrderNumber | String | The purchase order number for this order. | |
PurchaseOrderState | String | The current state of the purchase order.
The allowed values are New, Acknowledged, Closed. | |
DealCode | String | If requested by the recipient, this field will contain a promotional/deal number. | |
DeliveryWindow | String | This indicates the delivery window. Format is start and end date separated by double hyphen (--) | |
ShipWindow | String | This indicates the ship window. Format is start and end date separated by double hyphen (--). | |
Items | String | A list of items in this purchase order. | |
PaymentMethod | String | Payment method used.
The allowed values are Prepaid, CreditCard, Consignment, Invoice. | |
PurchaseOrderDate | Datetime | The date the purchase order was placed. | |
PurchaseOrderChangedDate | Datetime | The date when purchase order was last changed by Amazon after the order was placed. | |
PurchaseOrderStateChangedDate | Datetime | The date when current purchase order state was changed. | |
PurchaseOrderType | String | Type of purchase order.
The allowed values are RushOrder, NewProductIntroduction, ConsignedOrder, RegularOrder. | |
BillPartyId | String | Assigned identification for the party. For example, warehouse code or vendor code. | |
BillAddressAddressLine1 | String | First line of the address. | |
BillAddressAddressLine2 | String | Additional address information, if required. | |
BillAddressAddressLine3 | String | Additional address information, if required. | |
BillAddressCity | String | The city where the person, business or institution is located. | |
BillAddressCountryCode | String | The two digit country code in ISO 3166-1 alpha-2 format. | |
BillAddressCounty | String | The county where person, business or institution is located. | |
BillAddressDistrict | String | The district where person, business or institution is located. | |
BillAddressName | String | The name of the address of the person, business or institution. | |
BillAddressPhone | String | The phone number of the person, business or institution located at that address. | |
BillAddressPostalCode | String | The postal code of that address. It contains a series of letters or digits or both. | |
BillAddressStateOrRegion | String | The state or region where person, business or institution is located. | |
BillTaxRegistrationNumber | String | Tax registration number for the entity. For example, VAT ID. | |
BillTaxRegistrationType | String | Tax registration type for the entity.
The allowed values are VAT, GST. | |
ShipPartyId | String | Assigned identification for the party. For example, warehouse code or vendor code. | |
ShipAddressAddressLine1 | String | First line of the address. | |
ShipAddressAddressLine2 | String | Additional address information, if required. | |
ShipAddressAddressLine3 | String | Additional address information, if required. | |
ShipAddressCity | String | The city where the person, business or institution is located. | |
ShipAddressCountryCode | String | The two digit country code in ISO 3166-1 alpha-2 format. | |
ShipAddressCounty | String | The county where person, business or institution is located. | |
ShipAddressDistrict | String | The district where person, business or institution is located. | |
ShipAddressName | String | The name of the address of the person, business or institution. | |
ShipAddressPhone | String | The phone number of the person, business or institution located at that address. | |
ShipAddressPostalCode | String | The postal code of that address. It contains a series of letters or digits or both. | |
ShipAddressStateOrRegion | String | The state or region where person, business or institution is located. | |
ShipTaxRegistrationNumber | String | Tax registration number for the entity. For example, VAT ID. | |
ShipTaxRegistrationType | String | Tax registration type for the entity. | |
BuyerPartyId | String | Assigned identification for the party. For example, warehouse code or vendor code. | |
BuyerAddressAddressLine1 | String | First line of the address. | |
BuyerAddressAddressLine2 | String | Additional address information, if required. | |
BuyerAddressAddressLine3 | String | Additional address information, if required. | |
BuyerAddressCity | String | The city where the person, business or institution is located. | |
BuyerAddressCountryCode | String | The two digit country code in ISO 3166-1 alpha-2 format. | |
BuyerAddressCounty | String | The county where person, business or institution is located. | |
BuyerAddressDistrict | String | The district where person, business or institution is located. | |
BuyerAddressName | String | The name of the address of the person, business or institution. | |
BuyerAddressPhone | String | The phone number of the person, business or institution located at that address. | |
BuyerAddressPostalCode | String | The postal code of that address. It contains a series of letters or digits or both. | |
BuyerAddressStateOrRegion | String | The state or region where person, business or institution is located. | |
BuyerTaxRegistrationNumber | String | Tax registration number for the entity. For example, VAT ID. | |
BuyerTaxRegistrationType | String | Tax registration type for the entity. | |
SellerPartyId | String | Assigned identification for the party. For example, warehouse code or vendor code. | |
SellerAddressAddressLine1 | String | First line of the address. | |
SellerAddressAddressLine2 | String | Additional address information, if required. | |
SellerAddressAddressLine3 | String | Additional address information, if required. | |
SellerAddressCity | String | The city where the person, business or institution is located. | |
SellerAddressCountryCode | String | The two digit country code in ISO 3166-1 alpha-2 format. | |
SellerAddressCounty | String | The county where person, business or institution is located. | |
SellerAddressDistrict | String | The district where person, business or institution is located. | |
SellerAddressName | String | The name of the address of the person, business or institution. | |
SellerAddressPhone | String | The phone number of the person, business or institution located at that address. | |
SellerAddressPostalCode | String | The postal code of that address. It contains a series of letters or digits or both. | |
SellerAddressStateOrRegion | String | The state or region where person, business or institution is located. | |
SellerTaxRegistrationNumber | String | Tax registration number for the entity. For example, VAT ID. | |
SellerTaxRegistrationType | String | Tax registration type for the entity. | |
ImportContainers | String | Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. | |
InternationalCommercialTerms | String | Incoterms (International Commercial Terms) are used to divide transaction costs and responsibilities between buyer and seller and reflect state-of-the-art transportation practices. | |
MethodOfPayment | String | If the recipient requests, contains the shipment method of payment. This is for import PO's only.
The allowed values are PaidBySeller, PrepaidBySeller, FOBPortOfCall, DefinedByBuyerAndSeller, CollectOnDelivery, PaidByBuyer. | |
PortOfDelivery | String | The port where goods on an import purchase order must be delivered by the vendor. | |
ShippingInstructions | String | Special instructions regarding the shipment. |
This view is part of Vendor Direct Fulfillment Shipping API. Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days.
Some example queries:
SELECT * FROM VendorPackingSlips WHERE PurchaseOrderNumber = '12345'
SELECT * FROM VendorPackingSlips WHERE CreatedDate > '2022-09-10T12:00:00' AND CreatedDate < '2022-09-15T12:00:00'
Name | Type | References | Description |
PurchaseOrderNumber [KEY] | String | This field will contain the Purchase Order Number for this order. | |
Content | String | A Base64encoded string of the packing slip PDF. | |
ContentType | String | The format of the file such as PDF, JPEG etc |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
CreatedDate | String | Filters for created date. If left empty the default specified range is from 6 days earlier to today |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
Property | Description |
Schema | The type of schema to use. |
AWSRegion | The hosting region for your Amazon Web Services. |
AWSAccessKeyId | The AWS AccessKey Id that you received when you registered for Amazon MWS. |
Marketplace | The Marketplace region that you are registered to sell in. |
MWSAuthToken | The authorization token that you received when you registered for Amazon MWS. |
SellerId | The Seller ID that you received when you registered for Amazon MWS. |
AWSRoleARN | The Amazon Resource Name of the role to use when authenticating. |
AppId | Application Id for Selling Partner app you created. |
AWSSessionToken | AWS Session Token for Selling Partner app you created. |
AWSAccessKey | Your AWS access key. |
AWSSecretKey | Your AWS secret key. |
SellingPartner | Specifies the type of Selling Partner. |
IncludeRestrictedData | Determinies if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII). |
UseSandbox | A boolean determining if the connection should be made to the Selling Partner sandbox account. |
Property | Description |
OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAppStatus | Specifies whether the specified SellingPartner OAuth App is in Draft status or Published Status. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
Property | Description |
LogModules | Core modules to be included in the log file. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
Property | Description |
IncludeReports | Set this connection property to true to expose already created reports as views, this property is avaible for both schemes (Marketplace and SellingPartner). |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
ProcedurePooling | Whether or not to get feed results after an execution of a stored procedure. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
ReportTypes | Set this connection property to one or more report types to filter reports. |
RowScanDepth | The maximum number of rows to scan to look for the columns datatype in a report. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
TypeDetectionScheme | Specifies how to determine the data types of columns when selecting from Reports. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
Property | Description |
Schema | The type of schema to use. |
AWSRegion | The hosting region for your Amazon Web Services. |
AWSAccessKeyId | The AWS AccessKey Id that you received when you registered for Amazon MWS. |
Marketplace | The Marketplace region that you are registered to sell in. |
MWSAuthToken | The authorization token that you received when you registered for Amazon MWS. |
SellerId | The Seller ID that you received when you registered for Amazon MWS. |
AWSRoleARN | The Amazon Resource Name of the role to use when authenticating. |
AppId | Application Id for Selling Partner app you created. |
AWSSessionToken | AWS Session Token for Selling Partner app you created. |
AWSAccessKey | Your AWS access key. |
AWSSecretKey | Your AWS secret key. |
SellingPartner | Specifies the type of Selling Partner. |
IncludeRestrictedData | Determinies if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII). |
UseSandbox | A boolean determining if the connection should be made to the Selling Partner sandbox account. |
The type of schema to use.
The available schemas are Marketplace and SellingPartner.
The hosting region for your Amazon Web Services.
The hosting region for your Amazon Web Services. Available values are OHIO, NORTHERNVIRGINIA, NORTHERNCALIFORNIA, OREGON, CAPETOWN, HONGKONG, MUMBAI, OSAKA, SEOUL, SINGAPORE, SYDNEY, TOKYO, CENTRAL, BEIJING, NINGXIA, FRANKFURT, IRELAND, LONDON, MILAN, PARIS, STOCKHOLM, BAHRAIN, SAOPAULO, GOVCLOUDEAST, and GOVCLOUDWEST.
The AWS AccessKey Id that you received when you registered for Amazon MWS.
Use this connection property to override the embedded AWSAccessKeyId.
The Marketplace region that you are registered to sell in.
Available regions are United States, Canada, Mexico, Brazil, Spain, United Kingdom, France, Belgium, Netherlands, Germany, Italy, Sweden, Poland, Egypt, Turkey, Saudi Arabia, United Arab Emirates, India, China, Singapore, Japan, and Australia.
The authorization token that you received when you registered for Amazon MWS.
The authorization token that you received when you registered for Amazon MWS.
The Seller ID that you received when you registered for Amazon MWS.
If Seller ID not specified, then the Merchant identifier is required to authenticate.
The Amazon Resource Name of the role to use when authenticating.
When authenticating outside of AWS, it is common to use a Role for authentication instead of your direct AWS account credentials. Entering the AWSRoleARN will cause the CData Sync App to perform a role based authentication instead of using the AWSAccessKey and AWSSecretKey directly. The AWSAccessKey and AWSSecretKey must still be specified to perform this authentication. You cannot use the credentials of an AWS root user when setting RoleARN. The AWSAccessKey and AWSSecretKey must be those of an IAM user.
Application Id for Selling Partner app you created.
Application Id for Selling Partner app you created.
AWS Session Token for Selling Partner app you created.
AWS Session Token can be obtained from AssumeRole request to AWS. AWSAccessKeyId and AWSSecretKey should also be provided when setting AWSSessionToken.
Your AWS access key.
This is the Access Key tied to the AWS user that is associated with the the OAuthClientId.
Your AWS secret key.
This is the Secret Key tied to the AWS user that is associated with the the OAuthClientId.
Specifies the type of Selling Partner.
Specifies the type of Selling Partner, which can be Seller or Vendor.
Determinies if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII).
Determinies if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII)
A boolean determining if the connection should be made to the Selling Partner sandbox account.
A boolean determining if the connection should be made to the Selling Partner sandbox account.
Note: To use Sandbox account, set Schema to 'SellingPartner'.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
Property | Description |
OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAppStatus | Specifies whether the specified SellingPartner OAuth App is in Draft status or Published Status. |
The client Id assigned when you register your application with an OAuth authorization server.
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
The client secret assigned when you register your application with an OAuth authorization server.
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
Specifies whether the specified SellingPartner OAuth App is in Draft status or Published Status.
Specifies whether the specified SellingPartner OAuth App is in Draft status or Published Status.
If you set this property to 'Draft', the version=beta parameter is added to OAuth authorization URI, and the workflow authorizes an application in Draft state. Otherwise, the workflow authorizes an application published on the Amazon Seller Central Partner Network.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
Type | Default Port | Description |
TUNNEL | 80 | When this is set, the Sync App opens a connection to Amazon Marketplace and traffic flows back and forth through the proxy. |
SOCKS4 | 1080 | When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
SOCKS5 | 1080 | When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
The name or IP address of a proxy-based firewall.
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
This indicates whether to use the system proxy settings or not.
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of a proxy to route HTTP traffic through.
The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication type to use to authenticate to the ProxyServer proxy.
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
A user name to be used to authenticate to the ProxyServer proxy.
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
A password to be used to authenticate to the ProxyServer proxy.
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
AUTO | Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
ALWAYS | The connection is always SSL enabled. |
NEVER | The connection is not SSL enabled. |
TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
LogModules | Core modules to be included in the log file. |
Core modules to be included in the log file.
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\AmazonMarketplace Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Linux | ~/.config |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
IncludeReports | Set this connection property to true to expose already created reports as views, this property is avaible for both schemes (Marketplace and SellingPartner). |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
ProcedurePooling | Whether or not to get feed results after an execution of a stored procedure. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
ReportTypes | Set this connection property to one or more report types to filter reports. |
RowScanDepth | The maximum number of rows to scan to look for the columns datatype in a report. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
TypeDetectionScheme | Specifies how to determine the data types of columns when selecting from Reports. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
Set this connection property to true to expose already created reports as views, this property is avaible for both schemes (Marketplace and SellingPartner).
Set this connection property to true to expose already created reports as views, this property is avaible for both schemes (Marketplace and SellingPartner).
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
These hidden properties are used only in specific use cases.
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Whether or not to get feed results after an execution of a stored procedure.
Set this to False if you do not want to wait to get the results of a stored procedure.
This property indicates whether or not to include pseudo columns as columns to the table.
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
Set this connection property to one or more report types to filter reports.
Set this connection property to one or more comma-separated report types to filter reports. This property decides which report types to expose as views when IncludeReports = True and Schema = Marketplace.
The maximum number of rows to scan to look for the columns datatype in a report.
The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.
Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.
The value in seconds until the timeout error is thrown, canceling the operation.
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Sync App throws an exception.
Specifies how to determine the data types of columns when selecting from Reports.
When IncludeReports is set to True, this property specifies how to determine the data types.
None | Setting TypeDetectionScheme to None will return all columns as the string type. |
RowScan | Setting TypeDetectionScheme to RowScan will scan rows to heuristically determine the data type. |
A filepath pointing to the JSON configuration file containing your custom views.
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.
This User Defined View configuration file is formatted as follows:
For example:
{ "MyView": { "query": "SELECT * FROM Orders WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.jsonNote that the specified path is not embedded in quotation marks.
Boolean determining if simple names should be used for tables and columns.
Amazon Marketplace tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Sync App easier to use with traditional database tools.
Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.