Amazon Marketplace Connector for CData Sync

Build 22.0.8538
  • Amazon Marketplace
    • Establishing a Connection
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Marketplace Data Model
        • Views
          • FeedSubmissionList
          • FeedSubmissionResult
          • InboundShipmentItems
          • InboundShipments
          • InventorySupply
          • OrderItems
          • Orders
          • Products
          • ReportList
          • ReportRequestList
      • Selling Partner Data Model
        • Tables
          • Destinations
          • ListingsItems
          • ListingsItemsAttributes
          • Subscriptions
          • VendorShippingLabels
        • Views
          • CatalogItems
          • CompetitivePricing
          • Feeds
          • InboundShipmentItems
          • InboundShipments
          • InventorySupply
          • ItemOffers
          • ListingOffers
          • ListingsItemsIssues
          • ListingsItemsOffers
          • ListingsItemsSummaries
          • OrderItems
          • Orders
          • ProductPricing
          • ReportList
          • ReportTypes
          • VendorCustomerInvoices
          • VendorOrders
          • VendorPackingSlips
    • Connection String Options
      • Authentication
        • Schema
        • AWSRegion
        • AWSAccessKeyId
        • Marketplace
        • MWSAuthToken
        • SellerId
        • AWSRoleARN
        • AppId
        • AWSSessionToken
        • AWSAccessKey
        • AWSSecretKey
        • SellingPartner
        • IncludeRestrictedData
        • UseSandbox
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • OAuthAppStatus
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • IncludeReports
        • MaxRows
        • Other
        • ProcedurePooling
        • PseudoColumns
        • ReportTypes
        • RowScanDepth
        • Timeout
        • TypeDetectionScheme
        • UserDefinedViews
        • UseSimpleNames

Amazon Marketplace Connector for CData Sync

Overview

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.

Amazon Marketplace Connector for CData Sync

Establishing a Connection

Create a connection to Amazon Marketplace by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Amazon Marketplace icon is not available, click the Add More icon to download and install the Amazon Marketplace connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Connecting to Amazon Marketplace

Amazon MWS API vs Selling Partner API

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.

Connecting to Selling Partner API

When using the Amazon Selling Partner API to connect to the Amazon Marketplace, the following properties are required:

  • Schema: Set this to SellingPartner.
  • InitiateOAuth: Set this to GETANDREFRESH.
  • Marketplace: Set this to the Marketplace region that you are registered to sell in.
Also, you can use the SellingPartner property to choose Seller or Vendor authentication.

Connecting to the MWS API

When using the Amazon MWS API to connect to the Amazon Marketplace, SellerId, Marketplace, Marketplace are required connection properties. Set Schema to Marketplace.

Configure Access to Amazon Marketplace

To connect to Amazon Marketplace first authorize CData developer. To do so follow the steps below:

  • Using the CData MWS developer id: 195280669143.
  • Go to the Manage your apps page in Seller Central and log into your Amazon seller account as the primary account holder.
  • Click the Authorize new developer button and follows the authorization workflow using the developer id provided by the Sync App.

Or you can go to Amazon Marketplace CData Driver and click Authorize Now on the right panel.

Obtaining the MWS Auth Token

To obtain the MWS Auth Token, follow the steps below:

  • Go to the Manage your apps page in Seller Central and log into your Amazon seller account as the primary account holder.
  • Find the CData App.
  • Under the MWS Auth Token Column click View.

Obtaining the Seller ID

To obtain the Seller ID follow the steps below:

  • Login to your seller account.
  • Select Settings, then Account Info on upper right of screen.
  • Under Business Information select "Your Merchant Token".

Authenticate to Amazon Marketplace

Amazon Marketplace Accounts

Set the following connection properties to connect:

  • SellerId: Set the Seller ID of Amazon marketplace web service settings.
  • Marketplace: Set Amazon marketplace location (United States, Canada, Japan etc.).
  • Schema: Set Schema to Marketplace.

OAuth

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. You can use a custom OAuth app to authenticate with a service account or a user account. See Creating a Custom OAuth App for more information.

Web Apps

When connecting via a Web application, you need to register a custom OAuth app with Amazon Marketplace. You can then use the Sync App to get and manage the OAuth token values.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

  • OAuthClientId: Set this to the Client Id in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.
  • Marketplace: Set this to the Marketplace region that you are registered to sell in.
  • Schema: Set this to SellingPartner to connect to SP-API.

You can then call stored procedures to complete the OAuth exchange:

  1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified in your app settings. The stored procedure returns the URL to the OAuth endpoint.
  2. Log in and authorize the application. You are redirected back to the callback URL.
  3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "spapi_oauth_code" parameter in the query string of the callback URL.

Refresh the OAuth Access Token

You can set InitiateOAuth to REFRESH to automatically refresh the OAuth access token when it expires, or you can call the RefreshOAuthAccessToken stored procedure to refresh the token manually.

Automatic Refresh

To refresh the token with InitiateOAuth, set the following on the first data connection:

  • OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
  • InitiateOAuth: Set this to REFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • OAuthSettingsLocation: Set this to the path where the Sync App saves the OAuth values. These values persist across connections.
  • OAuthClientId: Set this to the Client Id in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.
  • OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
  • Marketplace: Set this to the Marketplace region that you are registered to sell in.
  • AppId: Application Id for Selling Partner app you created.
  • Schema: Set this to SellingPartner to connect to SP-API.
  • AWSAccessKey: This is the Access Key tied to the AWS user that is associated with the OAuthClientId.
  • AWSSecretKey: This is the Secret Key tied to the AWS user that is associated with the OAuthClientId.

On subsequent data connections, set the following:

  • InitiateOAuth
  • OAuthSettingsLocation
  • Marketplace: Set this to the Marketplace region that you are registered to sell in.
  • AppId: Application Id for Selling Partner app you created.
  • Schema: Set this to SellingPartner to connect to SP-API.
  • AWSAccessKey: This is the Access Key tied to the AWS user that is associated with the OAuthClientId.
  • AWSSecretKey: This is the Secret Key tied to the AWS user that is associated with the OAuthClientId.

Manual Refresh

You can use the GetOAuthAccessTokenstored procedure to manually refresh the OAuthAccessToken. Call the stored procedure after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed. You need the following connection properties to be set:

  • OAuthClientId: Set this to the Client Id in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.
  • Marketplace: Set this to the Marketplace region that you are registered to sell in.
  • Schema: Set this to SellingPartner to connect to SP-API.

You can then call RefreshOAuthAccessToken with the following parameter set:

  • OAuthRefreshToken: Set this to the OAuthRefreshToken returned by GetOAuthAccessToken.

Amazon Marketplace Connector for CData Sync

Advanced Features

This section details a selection of advanced features of the Amazon Marketplace Sync App.

User Defined Views

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.

SSL Configuration

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.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

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.

Logging

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.

Amazon Marketplace Connector for CData Sync

SSL Configuration

Customizing the SSL Configuration

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.

Amazon Marketplace Connector for CData Sync

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

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.

Other Proxies

Set the following properties:

  • To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
  • To tunnel the connection, set FirewallType to TUNNEL.
  • To authenticate, specify FirewallUser and FirewallPassword.
  • To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Amazon Marketplace Connector for CData Sync

Data Model

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.

The Sync App offloads as much of the SELECT statement processing as possible to the Amazon Marketplace APIs and then processes the rest of the query in memory. See SupportEnhancedSQL for more information on how the Sync App circumvents API limitations with in-memory client-side processing.

Using Marketplace API

See Marketplace Data Model for the available entities in the Marketplace API.

Using SellingPartner API

See Selling Partner Data Model for the available entities in the Selling Partner API.

Amazon Marketplace Connector for CData Sync

Marketplace Data Model

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

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

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Using Reports

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.

Amazon Marketplace Connector for CData Sync

Views

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Amazon Marketplace Connector for CData Sync Views

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.

Amazon Marketplace Connector for CData Sync

FeedSubmissionList

The GetFeedSubmissionList operation returns a list of feed submissions.

Select

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_'

Columns

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.

Amazon Marketplace Connector for CData Sync

FeedSubmissionResult

The GetFeedSubmissionResult operation returns the feed processing report for a specific feed.

Select

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'

Columns

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.

Amazon Marketplace Connector for CData Sync

InboundShipmentItems

Returns a list of items in a specified inbound shipment.

Select

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'

Columns

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-Columns

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

Amazon Marketplace Connector for CData Sync

InboundShipments

Returns a list of inbound shipments based on criteria that you specify.

Select

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'

Columns

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-Columns

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

Amazon Marketplace Connector for CData Sync

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.

Select

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'

Columns

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-Columns

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.

Amazon Marketplace Connector for CData Sync

OrderItems

Returns order items based on the Amazon Order Id that you specify.

Select

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')

Columns

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-Columns

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.

Amazon Marketplace Connector for CData Sync

Orders

Returns orders created or updated during a time frame that you specify.

Select

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'

Columns

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.

Amazon Marketplace Connector for CData Sync

Products

The Products Table helps you get information to match your products to existing product listings on Amazon Marketplace websites.

Select

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}')

Columns

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.

Amazon Marketplace Connector for CData Sync

ReportList

Usage information for the operation ReportList.rsd.

Select

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'

Columns

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.

Amazon Marketplace Connector for CData Sync

ReportRequestList

Usage information for the operation ReportRequestList.rsd.

Select

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_')

Columns

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-Columns

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.

Amazon Marketplace Connector for CData Sync

Selling Partner Data Model

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

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

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Using Reports

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.

Amazon Marketplace Connector for CData Sync

Tables

The Sync App models the data in Amazon Marketplace into a list of tables that can be queried using standard SQL statements.

Generally, querying Amazon Marketplace tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Amazon Marketplace Connector for CData Sync Tables

Name Description
Destinations Returns information about all destinations.
ListingsItems Returns details about a listings item for a selling partner.
ListingsItemsAttributes The GetFeedSubmissionList operation returns a list of feed submissions.
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 CreatedDate column. The date range to search must not be more than 7 days.

Amazon Marketplace Connector for CData Sync

Destinations

Returns information about all destinations.

Columns

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).

Amazon Marketplace Connector for CData Sync

ListingsItems

Returns details about a listings item for a selling partner.

The following filters are required:

  • SKU
  • SellerId: You can either specify SellerId as a pseudo-column condition in WHERE filters, or in the connection string.
Some example queries:
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')

Columns

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-Columns

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.

Amazon Marketplace Connector for CData Sync

ListingsItemsAttributes

The GetFeedSubmissionList operation returns a list of feed submissions.

The following filters are required:

  • SKU
  • SellerId: You can either specify SellerId as a pseudo-column condition in WHERE filters, or in the connection string.
Some example queries:
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
)

Columns

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-Columns

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.

Amazon Marketplace Connector for CData Sync

Subscriptions

Returns information about subscriptions of the specified notification type.

Columns

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.

Amazon Marketplace Connector for CData Sync

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 CreatedDate column. The date range to search must not be more than 7 days.

Select

The following fields are filtered server-side:
  • PurchaseOrderNumber supports the '=' comparison
  • CreatedDate supports all the >, >=, =, <=, < comparisons

Some example queries:

SELECT * FROM VendorShippingLabels

SELECT * FROM VendorShippingLabels WHERE PurchaseOrderNumber = '12345'

SELECT * FROM VendorShippingLabels WHERE CreatedDate > '2022-09-10T12:00:00' AND CreatedDate < '2022-09-15T12:00:00'

Insert

When inserting, you can also use temp tables in order to insert fields for aggregate objects, as shown in the example below:
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 

Container temporary table schema info:

Column NameTypeRequiredDescription
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.

PackedItems temporary table schema info:

Column NameTypeRequiredDescription
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.

TaxRegistrationDetails temporary table schema info:

Column NameTypeRequiredDescription
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.

Address temporary table schema info:

Column NameType RequiredDescription
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.

Columns

Name Type ReadOnly References Description
PurchaseOrderNumber [KEY] String False

This field will contain the Purchase Order Number for this order.

LabelFormat String True

Format of the label.

The allowed values are PNG, ZPL.

LabelData String True

Provides the details of the packages in this shipment.

SellingPartyPartyId String False

Assigned Identification for the party.

SellingPartyAddressLine1 String False

First line of the address.

SellingPartyAddressLine2 String False

Additional street address information, if required.

SellingPartyAddressLine3 String False

Additional street address information, if required.

SellingPartyAddressCity String False

The city where the person, business or institution is located.

SellingPartyAddressCountryCode String False

The two digit country code in ISO 3166-1 alpha-2 format.

SellingPartyAddressCounty String False

The county where person, business or institution is located.

SellingPartyAddressDistrict String False

The district where person, business or institution is located.

SellingPartyAddressName String False

The name of the person, business or institution at that address.

SellingPartyAddressPhone String False

The phone number of the person, business or institution located at that address.

SellingPartyAddressPostalCode String False

The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.

SellingPartyAddressStateOrRegion String False

The state or region where person, business or institution is located.

SellingPartyTaxRegistrationDetails String False

Tax registration details of the entity. See: TaxRegistrationDetails temporary table schema.

ShipFromPartyPartyId String False

Assigned Identification for the party.

ShipFromPartyAddressLine1 String False

First line of the address.

ShipFromPartyAddressLine2 String False

Additional street address information, if required.

ShipFromPartyAddressLine3 String False

Additional street address information, if required.

ShipFromPartyAddressCity String False

The city where the person, business or institution is located.

ShipFromPartyAddressCountryCode String False

The two digit country code in ISO 3166-1 alpha-2 format.

ShipFromPartyAddressCounty String False

The county where person, business or institution is located.

ShipFromPartyAddressDistrict String False

The district where person, business or institution is located.

ShipFromPartyAddressName String False

The name of the person, business or institution at that address.

ShipFromPartyAddressPhone String False

The phone number of the person, business or institution located at that address.

ShipFromPartyAddressPostalCode String False

The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.

ShipFromPartyAddressStateOrRegion String False

The state or region where person, business or institution is located.

ShipFromPartyTaxRegistrationDetails String False

Tax registration details of the entity. See: TaxRegistrationDetails temporary table schema.

Pseudo-Columns

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.

Containers String

A list of the packages in this shipment. Only used for Insert statements. See: Container temporary table schema.

Amazon Marketplace Connector for CData Sync

Views

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Amazon Marketplace Connector for CData Sync Views

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.
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.
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.
Orders Returns orders created or updated during a time frame that you specify.
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.
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.

Amazon Marketplace Connector for CData Sync

CatalogItems

The Catalog Items table helps you retrieve item details for items in the catalog.

The following filters are required:

  • MarketplaceId
  • One of the following: Query, SellerSKU, UPC, EAN, ISBN, JAN
For example:
SELECT * FROM CatalogItems WHERE MarketplaceID = 'XXXXXXXXXXXXX' AND ISBN = 'XXXXXXXXXXXXX'

Columns

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.

Pseudo-Columns

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
Query String Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'.
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.
EAN String A European article number that uniquely identifies the catalog item, manufacturer, and its attributes.
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.
MarketplaceId String Specifies the marketplace for which items are returned.

Amazon Marketplace Connector for CData Sync

CompetitivePricing

Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN.

Columns

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.

Amazon Marketplace Connector for CData Sync

Feeds

The GetFeedSubmissionList operation returns a list of feed submissions.

Select

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.

  • FeedId supports the '=' comparison.
  • FeedType supports the '=' and 'IN' comparisons.
  • MarketplaceIds supports the '=' and 'IN' comparisons.
  • ProcessingStatus supports the '=' and 'IN' comparisons.
  • CreatedTime supports the '=', '<', '>', '<=' and '>=' comparisons.

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.

Columns

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.

Amazon Marketplace Connector for CData Sync

InboundShipmentItems

Returns a list of items in a specified inbound shipment.

Select

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.

  • MarketplaceId supports the '=' comparison.
  • LastUpdatedDate supports the '=', '<', '>', '<=', '>=' comparisons.
For example, the following query is processed server side:
SELECT * FROM InboundShipmentItems  WHERE MarketplaceId = 'ATVPDKIKX0DER'

SELECT * FROM InboundShipmentItems  WHERE LastUpdatedDate > '2020-01-01'

Columns

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.
PrepDetailsListPrepInstruction String Preparation instructions for shipping an item to Amazon's fulfillment network.
PrepDetailsListPrepOwner String Indicates who will prepare the item.
MarketplaceId String Marketplace identifier for the report.
ReleaseDate Date The date that a pre-order item will be available for sale.

Pseudo-Columns

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

Amazon Marketplace Connector for CData Sync

InboundShipments

Returns a list of inbound shipments based on criteria that you specify.

Select

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.

  • ShipmentId supports the '=' and 'IN' comparisons.
  • ShipmentStatus supports the '='and 'IN' comparisons.
  • MarketplaceId supports the '=' comparison.
  • LastUpdatedDate supports the '=', '<', '>', '<=', '>=' comparisons.
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 MarketplaceId = 'ATVPDKIKX0DER'

SELECT * FROM InboundShipments WHERE LastUpdatedDate >= '2016-12-12'

Columns

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.
ShipFromDistrictOrCounty String The State Or Province Code of the return address.
ShipFromStateOrProvinceCode String The State Or Province Code of the return address.
ShipFromAddressLine1 String The street address information of the return address.
ShipFromAddressLine2 String Additional street address information 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.
MarketplaceId String Marketplace identifier for the report.
BoxContentsSource String Where the seller provided box contents information for a shipment.
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-Columns

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

Amazon Marketplace Connector for CData Sync

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.

Select

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.

  • SellerSKU supports the '=', 'IN' comparisons.
  • GranularityType supports the '='comparison.
  • GranularityId supports the '=' comparison.
  • MarketplaceId supports the '=' comparison.
  • StartDateTime supports the '=', '<', '>', '<=', '>=' comparisons.

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'

Columns

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-Columns

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.

Amazon Marketplace Connector for CData Sync

ItemOffers

Returns the lowest priced offers for a single item based on ASIN.

Columns

Name Type References Description
ASIN [KEY] String Required. The Amazon Standard Identification Number (ASIN) of the item.
MarketplaceId String A marketplace identifier. Specifies the marketplace for which prices are returned.
SummaryLandedPriceAmount Decimal The landed price amount of the lowest price.
SummaryLandedPriceCurrencyCode String The landed price currency code of the lowest price.
SummaryListingPriceAmount Decimal The listing price amount of the lowest price.
SummaryListingPriceCurrencyCode String The listing price currency code of the lowest price.
ItemCondition String The condition of the lowest priced product listed.

The allowed values are New, Used, Collectible, Refurbished, Club.

FulfillmentChannel String The fulfillment channel for the lowest priced product listed.
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.
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.

Amazon Marketplace Connector for CData Sync

ListingOffers

Generated schema file.

Columns

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.
SummaryLandedPriceAmount Decimal The landed price amount of the lowest price.
SummaryLandedPriceCurrencyCode String The landed price currency code of the lowest price.
SummaryListingPriceAmount Decimal The listing price amount of the lowest price.
SummaryListingPriceCurrencyCode String The listing price currency code of the lowest price.
ItemCondition String The condition of the lowest priced product listed.

The allowed values are New, Used, Collectible, Refurbished, Club.

FulfillmentChannel String The fulfillment channel for the lowest priced product listed.
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.
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.
MyOffer Boolean The boolean value of the offer being the seller's.
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.

Amazon Marketplace Connector for CData Sync

ListingsItemsIssues

The GetFeedSubmissionList operation returns a list of feed submissions.

The following filters are required:

  • SKU
  • SellerId: You can either specify SellerId as a pseudo-column condition in WHERE filters, or in the connection string.
Some example queries:
SELECT * FROM ListingsItemsIssues WHERE SKU = '12345' AND SellerId='XXXXXXXXXXXXXX'

Columns

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-Columns

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.

Amazon Marketplace Connector for CData Sync

ListingsItemsOffers

The GetFeedSubmissionList operation returns a list of feed submissions.

The following filters are required:

  • SKU
  • SellerId: You can either specify SellerId as a pseudo-column condition in WHERE filters, or in the connection string.
Some example queries:
SELECT * FROM ListingsItemsOffers WHERE SKU = '12345' AND SellerId='XXXXXXXXXXXXXX'

Columns

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-Columns

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.

Amazon Marketplace Connector for CData Sync

ListingsItemsSummaries

The GetFeedSubmissionList operation returns a list of feed submissions.

The following filters are required:

  • SKU
  • SellerId: You can either specify SellerId as a pseudo-column condition in WHERE filters, or in the connection string.
Some example queries:
SELECT * FROM ListingsItemsSummaries WHERE SKU = '12345' AND SellerId='XXXXXXXXXXXXXX'

Columns

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-Columns

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.

Amazon Marketplace Connector for CData Sync

OrderItems

Returns order items based on the Amazon Order Id that you specify.

Select

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.

  • AmazonOrderId supports the '=' comparison.
For example, the following query is processed server side:
SELECT * FROM OrderItems WHERE AmazonOrderId = '503-9993250-1405404'

Columns

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-Columns

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.

Amazon Marketplace Connector for CData Sync

Orders

Returns orders created or updated during a time frame that you specify.

Select

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.

  • AmazonOrderId supports the '=' comparison.
  • SellerOrderId supports the '=' comparison.
  • PurchaseDate supports the '=', '<', '>', '<=', '>=' comparison.
  • LastUpdateDate supports the '=', '<', '>', '<=', '>=' comparison.
  • OrderStatus supports the '=', 'IN' comparison.
  • FulfillmentChannel supports the '=', 'IN' comparison.
  • PaymentMethod supports the '=', 'IN' comparison.
  • MarketplaceId supports the '=' comparison.
  • BuyerEmail supports the '=' comparison.
  • IsISPU supports the '=' comparison.
For example, the following query is processed server side:
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'

Columns

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.

Amazon Marketplace Connector for CData Sync

ProductPricing

Generated schema file.

Columns

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.

Amazon Marketplace Connector for CData Sync

ReportList

Returns report details for the reports that match the filters that you specify.

Select

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.

  • ReportId supports the '=' comparison.
  • ReportType supports the '=', 'IN' comparisons.
  • MarketplaceIds supports the '=', 'IN' comparisons.
  • ProcessingStatus supports the '=', 'IN' comparisons.
  • CreatedTime supports the '=', '<', '>', '<=', '>=' comparisons.

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.

Columns

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.

Amazon Marketplace Connector for CData Sync

ReportTypes

Returns report details for the reports that match the filters that you specify.

Select

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

Columns

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.

Amazon Marketplace Connector for CData Sync

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.

Select

The following fields are filtered server-side:
  • PurchaseOrderNumber supports the '=' comparison
  • CreatedDate supports all the >, >=, =, <=, < comparisons

Some example queries:

SELECT * FROM VendorCustomerInvoices

SELECT * FROM VendorCustomerInvoices WHERE PurchaseOrderNumber = '12345'

SELECT * FROM VendorCustomerInvoices WHERE CreatedDate > '2022-09-10T12:00:00' AND CreatedDate < '2022-09-15T12:00:00'

Columns

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-Columns

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.

Amazon Marketplace Connector for CData Sync

VendorOrders

The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.

Select

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.

  • PurchaseOrderNumber supports the '=' comparison.
  • PurchaseOrderState supports the '='comparison.
  • PurchaseOrderDate supports the '<', '>' comparisons and ORDER BY clause.
  • PurchaseOrderChangedDate supports the '<', '>' comparisons.
  • SellerPartyId supports the '=' comparison.

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'

Columns

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.

Amazon Marketplace Connector for CData Sync

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.

Select

The following fields are filtered server-side:
  • PurchaseOrderNumber supports the '=' comparison
  • CreatedDate supports all the >, >=, =, <=, < comparisons

Some example queries:

SELECT * FROM VendorPackingSlips

SELECT * FROM VendorPackingSlips WHERE PurchaseOrderNumber = '12345'

SELECT * FROM VendorPackingSlips WHERE CreatedDate > '2022-09-10T12:00:00' AND CreatedDate < '2022-09-15T12:00:00'

Columns

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-Columns

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

Amazon Marketplace Connector for CData Sync

Connection String Options

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.

Authentication


PropertyDescription
SchemaThe type of schema to use.
AWSRegionThe hosting region for your Amazon Web Services.
AWSAccessKeyIdThe AWS AccessKey Id that you received when you registered for Amazon MWS.
MarketplaceThe Marketplace region that you are registered to sell in.
MWSAuthTokenThe authorization token that you received when you registered for Amazon MWS.
SellerIdThe Seller ID that you received when you registered for Amazon MWS.
AWSRoleARNThe Amazon Resource Name of the role to use when authenticating.
AppIdApplication Id for Selling Partner app you created.
AWSSessionTokenAWS Session Token for Selling Partner app you created.
AWSAccessKeyYour AWS access key.
AWSSecretKeyYour AWS secret key.
SellingPartnerSpecifies the type of Selling Partner.
IncludeRestrictedDataDeterminies if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII).
UseSandboxA boolean determining if the connection should be made to the Selling Partner sandbox account.

OAuth


PropertyDescription
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuthAppStatusSpecifies whether the specified SellingPartner OAuth App is in Draft status or Published Status.

SSL


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectThis 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.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging


PropertyDescription
LogModulesCore modules to be included in the log file.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous


PropertyDescription
IncludeReportsSet this connection property to true to expose already created reports as views, this property is avaible for both schemes (Marketplace and SellingPartner).
MaxRowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
OtherThese hidden properties are used only in specific use cases.
ProcedurePoolingWhether or not to get feed results after an execution of a stored procedure.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
ReportTypesSet this connection property to one or more report types to filter reports.
RowScanDepthThe maximum number of rows to scan to look for the columns datatype in a report.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionSchemeSpecifies how to determine the data types of columns when selecting from Reports.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
UseSimpleNamesBoolean determining if simple names should be used for tables and columns.
Amazon Marketplace Connector for CData Sync

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.


PropertyDescription
SchemaThe type of schema to use.
AWSRegionThe hosting region for your Amazon Web Services.
AWSAccessKeyIdThe AWS AccessKey Id that you received when you registered for Amazon MWS.
MarketplaceThe Marketplace region that you are registered to sell in.
MWSAuthTokenThe authorization token that you received when you registered for Amazon MWS.
SellerIdThe Seller ID that you received when you registered for Amazon MWS.
AWSRoleARNThe Amazon Resource Name of the role to use when authenticating.
AppIdApplication Id for Selling Partner app you created.
AWSSessionTokenAWS Session Token for Selling Partner app you created.
AWSAccessKeyYour AWS access key.
AWSSecretKeyYour AWS secret key.
SellingPartnerSpecifies the type of Selling Partner.
IncludeRestrictedDataDeterminies if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII).
UseSandboxA boolean determining if the connection should be made to the Selling Partner sandbox account.
Amazon Marketplace Connector for CData Sync

Schema

The type of schema to use.

Remarks

The available schemas are Marketplace and SellingPartner.

Amazon Marketplace Connector for CData Sync

AWSRegion

The hosting region for your Amazon Web Services.

Remarks

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.

Amazon Marketplace Connector for CData Sync

AWSAccessKeyId

The AWS AccessKey Id that you received when you registered for Amazon MWS.

Remarks

Use this connection property to override the embedded AWSAccessKeyId.

Amazon Marketplace Connector for CData Sync

Marketplace

The Marketplace region that you are registered to sell in.

Remarks

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.

Amazon Marketplace Connector for CData Sync

MWSAuthToken

The authorization token that you received when you registered for Amazon MWS.

Remarks

The authorization token that you received when you registered for Amazon MWS.

Amazon Marketplace Connector for CData Sync

SellerId

The Seller ID that you received when you registered for Amazon MWS.

Remarks

If Seller ID not specified, then the Merchant identifier is required to authenticate.

Amazon Marketplace Connector for CData Sync

AWSRoleARN

The Amazon Resource Name of the role to use when authenticating.

Remarks

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.

Amazon Marketplace Connector for CData Sync

AppId

Application Id for Selling Partner app you created.

Remarks

Application Id for Selling Partner app you created.

Amazon Marketplace Connector for CData Sync

AWSSessionToken

AWS Session Token for Selling Partner app you created.

Remarks

AWS Session Token can be obtained from AssumeRole request to AWS. AWSAccessKeyId and AWSSecretKey should also be provided when setting AWSSessionToken.

Amazon Marketplace Connector for CData Sync

AWSAccessKey

Your AWS access key.

Remarks

This is the Access Key tied to the AWS user that is associated with the the OAuthClientId.

Amazon Marketplace Connector for CData Sync

AWSSecretKey

Your AWS secret key.

Remarks

This is the Secret Key tied to the AWS user that is associated with the the OAuthClientId.

Amazon Marketplace Connector for CData Sync

SellingPartner

Specifies the type of Selling Partner.

Remarks

Specifies the type of Selling Partner, which can be Seller or Vendor.

Amazon Marketplace Connector for CData Sync

IncludeRestrictedData

Determinies if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII).

Remarks

Determinies if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII)

Amazon Marketplace Connector for CData Sync

UseSandbox

A boolean determining if the connection should be made to the Selling Partner sandbox account.

Remarks

A boolean determining if the connection should be made to the Selling Partner sandbox account.

Note: To use Sandbox account, set Schema to 'SellingPartner'.

Amazon Marketplace Connector for CData Sync

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.


PropertyDescription
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuthAppStatusSpecifies whether the specified SellingPartner OAuth App is in Draft status or Published Status.
Amazon Marketplace Connector for CData Sync

OAuthClientId

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

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.

Amazon Marketplace Connector for CData Sync

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

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.

Amazon Marketplace Connector for CData Sync

OAuthAppStatus

Specifies whether the specified SellingPartner OAuth App is in Draft status or Published Status.

Remarks

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.

Amazon Marketplace Connector for CData Sync

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.
Amazon Marketplace Connector for CData Sync

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

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.

Amazon Marketplace Connector for CData Sync

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.
Amazon Marketplace Connector for CData Sync

FirewallType

The protocol used by a proxy-based firewall.

Remarks

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.

Amazon Marketplace Connector for CData Sync

FirewallServer

The name or IP address of a proxy-based firewall.

Remarks

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.

Amazon Marketplace Connector for CData Sync

FirewallPort

The TCP port for a proxy-based firewall.

Remarks

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.

Amazon Marketplace Connector for CData Sync

FirewallUser

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

Amazon Marketplace Connector for CData Sync

FirewallPassword

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

Amazon Marketplace Connector for CData Sync

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.


PropertyDescription
ProxyAutoDetectThis 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.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Amazon Marketplace Connector for CData Sync

ProxyAutoDetect

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.

Remarks

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.

Amazon Marketplace Connector for CData Sync

ProxyServer

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

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.

Amazon Marketplace Connector for CData Sync

ProxyPort

The TCP port the ProxyServer proxy is running on.

Remarks

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.

Amazon Marketplace Connector for CData Sync

ProxyAuthScheme

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

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:

  • BASIC: The Sync App performs HTTP BASIC authentication.
  • DIGEST: The Sync App performs HTTP DIGEST authentication.
  • NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

Amazon Marketplace Connector for CData Sync

ProxyUser

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

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

Amazon Marketplace Connector for CData Sync

ProxyPassword

A password to be used to authenticate to the ProxyServer proxy.

Remarks

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.

Amazon Marketplace Connector for CData Sync

ProxySSLType

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

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:

AUTODefault 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.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe 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.

Amazon Marketplace Connector for CData Sync

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

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.

Amazon Marketplace Connector for CData Sync

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.


PropertyDescription
LogModulesCore modules to be included in the log file.
Amazon Marketplace Connector for CData Sync

LogModules

Core modules to be included in the log file.

Remarks

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.

Amazon Marketplace Connector for CData Sync

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Amazon Marketplace Connector for CData Sync

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

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:

Amazon Marketplace Connector for CData Sync

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Amazon Marketplace Connector for CData Sync

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

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.

Amazon Marketplace Connector for CData Sync

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

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.

Amazon Marketplace Connector for CData Sync

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
IncludeReportsSet this connection property to true to expose already created reports as views, this property is avaible for both schemes (Marketplace and SellingPartner).
MaxRowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
OtherThese hidden properties are used only in specific use cases.
ProcedurePoolingWhether or not to get feed results after an execution of a stored procedure.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
ReportTypesSet this connection property to one or more report types to filter reports.
RowScanDepthThe maximum number of rows to scan to look for the columns datatype in a report.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionSchemeSpecifies how to determine the data types of columns when selecting from Reports.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
UseSimpleNamesBoolean determining if simple names should be used for tables and columns.
Amazon Marketplace Connector for CData Sync

IncludeReports

Set this connection property to true to expose already created reports as views, this property is avaible for both schemes (Marketplace and SellingPartner).

Remarks

Set this connection property to true to expose already created reports as views, this property is avaible for both schemes (Marketplace and SellingPartner).

Amazon Marketplace Connector for CData Sync

MaxRows

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Amazon Marketplace Connector for CData Sync

Other

These hidden properties are used only in specific use cases.

Remarks

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.

Integration and Formatting

DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMTDetermines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

Amazon Marketplace Connector for CData Sync

ProcedurePooling

Whether or not to get feed results after an execution of a stored procedure.

Remarks

Set this to False if you do not want to wait to get the results of a stored procedure.

Amazon Marketplace Connector for CData Sync

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

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, "*=*".

Amazon Marketplace Connector for CData Sync

ReportTypes

Set this connection property to one or more report types to filter reports.

Remarks

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.

Amazon Marketplace Connector for CData Sync

RowScanDepth

The maximum number of rows to scan to look for the columns datatype in a report.

Remarks

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.

Amazon Marketplace Connector for CData Sync

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

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.

Amazon Marketplace Connector for CData Sync

TypeDetectionScheme

Specifies how to determine the data types of columns when selecting from Reports.

Remarks

When IncludeReports is set to True, this property specifies how to determine the data types.

NoneSetting TypeDetectionScheme to None will return all columns as the string type.
RowScanSetting TypeDetectionScheme to RowScan will scan rows to heuristically determine the data type.

Amazon Marketplace Connector for CData Sync

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

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:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

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.json"

Amazon Marketplace Connector for CData Sync

UseSimpleNames

Boolean determining if simple names should be used for tables and columns.

Remarks

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.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8538