Amazon Marketplace Connection Details¶
Introduction¶
Connector Version
This documentation is based on version 21.0.8662 of the connector.
Important
We recommend using the Amazon Marketplace v2 connector to connect to Amazon Marketplace as it allows for additional configuration properties.
Get Started¶
Amazon Marketplace Version Support
The connector leverages the Amazon Marketplace API to enable bidirectional access to Amazon Marketplace.
Establish a Connection¶
Connect 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.
Connect 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 toSellingPartner
.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.
Connect 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 developer. To do so follow the steps below:
- Using the 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 connector.
Or you can go to Amazon Marketplace Driver and click Authorize Now
on the right panel.
Obtain 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 App.
- Under the MWS Auth Token Column click
View
.
Obtain the Seller ID¶
To obtain the Seller ID follow the steps below:
- Login to your seller account.
- Select
Settings
, thenAccount Info
on upper right of screen. - Under
Business Information
select "Your Merchant Token".
Authenticate an Amazon Marketplace Account¶
Set the following connection properties to connect:
SellerId
: Set the Seller ID of Amazon marketplace web service settings.Marketplace
: Set Amazon market place location (United States, Canada, Japan etc.).Schema
: Set Schema toMarketplace
.
Authenticate Using OAuth Authentication¶
Amazon Marketplace uses the OAuth authentication standard.
To authenticate using OAuth, you will either need to use the Embedded Credentials or create a new custom OAuth app (see Creating a Custom OAuth App).
Amazon Marketplace Data Retention Policy¶
For security, Amazon Marketplace restricts access to PII (Personally Identifiable Information). You can only retain PII for 30 days after order delivery and only for the purpose of, and as long as is necessary to
- fulfill orders
- calculate and remit taxes
- produce tax invoices
- meet legal requirements, including tax or regulatory requirements.
If you are required by law to retain archival copies of PII for tax or other regulatory purposes, you must store PII as a "cold" or offline encrypted backup (e.g., not available for immediate or interactive use).
This means, for example, that the Amazon Marketplace driver no longer displays customer shipping address information after 30 days. See the Amazon documentation for more information:
Amazon Marketplace Data Protection Policy
Use OAuth Authentication¶
Use the OAuth authentication standard to connect to Amazon Marketplace. You can authenticate with a user account or a service account. The connector facilitates this as described below.
Use a User Account to Authenticate to Amazon Marketplace¶
The user account flow requires the authenticating user to interact with Amazon Marketplace via the browser.
Embedded Credentials¶
See Embedded Credentials to connect with the connector's embedded credentials and skip creating a custom OAuth app.
Custom Credentials¶
Instead of connecting with the connector's embedded credentials, you can register an app to obtain the OAuthClientId
and OAuthClientSecret
. You can also use the OAuthAppStatus
property to choose draft
or published
status. You must specify this property when using custom credentials.
When to Create a Custom OAuth App¶
Creating a custom OAuth app is optional as the connector is already registered with Amazon Marketplace and you can connect with its embedded credentials. You might want to create a custom OAuth app to change the information displayed when users log into the Amazon Marketplace OAuth endpoint to grant permissions to the connector.
Create a Custom OAuth App¶
See Creating a Custom OAuth App for a procedure.
Embedded Credentials¶
Authenticate using the Embedded OAuth Credentials¶
Desktop Authentication with the Embedded OAuth App¶
You can connect without setting any connection properties for your user credentials. After setting the following, you are ready to connect:
InitiateOAuth
: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
.Marketplace
: Set this to the The Marketplace region that you are registered to sell in.Schema
: Set this to 'SellingPartner' to connect to SP-API.
When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process.
- Extracts the access token from the callback URL and authenticates requests.
- Obtains a new access token when the old one expires.
- Saves OAuth values in
OAuthSettingsLocation
to be persisted across connections.
Custom Credentials¶
You can use a custom OAuth app to authenticate with a service account or a user account. See Using OAuth Authentication for more information.
Authenticate with a User Account¶
Desktop Authentication with a Custom OAuth App¶
Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.
Get and Refresh the OAuth Access Token
After setting the following, you are ready to connect:
OAuthClientId
: Set this to the client ID assigned when you registered your app.OAuthClientSecret
: Set this to the client secret assigned when you registered your app.InitiateOAuth
: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
.Marketplace
: Set this to the 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 theOAuthClientId
.AWSSecretKey
: This is the Secret Key tied to the AWS user that is associated with the theOAuthClientId
.
When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:
- Extracts the access token from the callback URL and authenticates requests.
- Refreshes the access token when it expires.
- Saves OAuth values in
OAuthSettingsLocation
to be persisted across connections.
Headless Machines¶
Use OAuth on a Headless Machine¶
The following sections show how to authenticate a headless server or another machine on which the connector cannot open a browser. You can authenticate with a user account or with a service account.
Authenticate with a User Account¶
To authenticate with a user account, you need to authenticate from another machine. Authentication is a two-step process.
- Instead of installing the connector on another machine, you can follow the steps below to obtain the
OAuthVerifier
value. Or, you can install the connector on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow. - You can then configure the connector to automatically refresh the access token from the headless machine.
You can follow the headless OAuth authentication flow using the connector's embedded OAuth credentials or using the OAuth credentials for your custom OAuth app.
Use the Embedded OAuth Credentials¶
Obtain a Verifier Code
Follow the steps below to authenticate from another machine and obtain the OAuthVerifier
connection property:
- Click the following link to open the Amazon Marketplace OAuth endpoint in your browser.
- Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code as value for 'spapi_oauth_code'.
- Save the value of the verifier code. You will set this in the
OAuthVerifier
connection property.
On the headless machine, set the following connection properties to obtain the OAuth authentication values.
OAuthVerifier
: Set this to the verifier code.InitiateOAuth
: Set this to REFRESH.OAuthSettingsLocation
: Set this to persist the encrypted OAuth authentication values to the specified file.
After the OAuth settings file is generated, set the following properties to connect to data:
OAuthSettingsLocation
: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.InitiateOAuth
: Set this to REFRESH.Marketplace
: Set this to the The Marketplace region that you are registered to sell in.Schema
: Set this to 'SellingPartner' to connect to SP-API.AppId
: Application ID for Selling Partner app you created.AWSAccessKey
: This is the Access Key tied to the AWS user that is associated with the theOAuthClientId
.AWSSecretKey
: This is the Secret Key tied to the AWS user that is associated with the theOAuthClientId
.
Transfer OAuth Settings
Follow the steps below to install the connector on another machine, authenticate, and then transfer the resulting OAuth values.
On a second machine, install the connector and connect with the following properties set:
OAuthSettingsLocation
: Set this to a writable text file.InitiateOAuth
: Set this to GETANDREFRESH.
Test the connection to authenticate in the browser. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation
. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.
On the headless machine, set the following connection properties to connect to data:
OAuthSettingsLocation
: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.Marketplace
: Set this to the The Marketplace region that you are registered to sell in.Schema
: Set this to 'SellingPartner' to connect to SP-API.AppId
: Application ID for Selling Partner app you created.AWSAccessKey
: This is the Access Key tied to the AWS user that is associated with the theOAuthClientId
.AWSSecretKey
: This is the Secret Key tied to the AWS user that is associated with the theOAuthClientId
.
Use the Credentials for a Custom OAuth App¶
Create a Custom OAuth App
Creating a custom OAuth app is optional in the headless OAuth flow; you can skip creating an app by connecting with the connector's embedded OAuth credentials. You might want to create a custom OAuth app to change the information displayed when users log into Amazon Marketplace to grant permissions to the connector.
See Creating a Custom OAuth App for a procedure. You can then follow the procedures below to authenticate and connect to data.
Obtain a Verifier Code
Set the following properties on the headless machine:
InitiateOAuth
: Set this to OFF.OAuthClientId
: Set this to the Client ID in your app settings.OAuthClientSecret
: Set this to the Client Secret in your app settings.
You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier
connection property.
- Call the GetOAuthAuthorizationURL stored procedure with the CallbackURL input parameter set to the exact Redirect URI you specified in your app settings.
- Open the returned URL in a browser. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code as value for 'spapi_oauth_code'.
- Save the value of the verifier code. You will set this in the
OAuthVerifier
connection property.
On the headless machine, set the following connection properties to obtain the OAuth authentication values:
OAuthClientId
: Set this to the consumer key in your app settings.OAuthClientSecret
: Set this to the consumer secret in your app settings.OAuthVerifier
: Set this to the verifier code.OAuthSettingsLocation
: Set this to persist the encrypted OAuth authentication values to the specified file.InitiateOAuth
: Set this to REFRESH.
After the OAuth settings file is generated, set the following properties to connect to data:
OAuthClientId
: Set this to the consumer key in your app settings.OAuthClientSecret
: Set this to the consumer secret in your app settings.OAuthSettingsLocation
: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.InitiateOAuth
: Set this to REFRESH.Marketplace
: Set this to the The Marketplace region that you are registered to sell in.Schema
: Set this to 'SellingPartner' to connect to SP-API.AppId
: Application ID for Selling Partner app you created.AWSAccessKey
: This is the Access Key tied to the AWS user that is associated with the theOAuthClientId
.AWSSecretKey
: This is the Secret Key tied to the AWS user that is associated with the theOAuthClientId
.
Transfer OAuth Settings
Follow the steps below to install the connector on another machine, authenticate, and then transfer the resulting OAuth values.
On a second machine, install the connector and connect with the following properties set:
OAuthSettingsLocation
: Set this to a writable text file.InitiateOAuth
: Set this to GETANDREFRESH.OAuthClientId
: Set this to the client ID assigned when you registered your app.OAuthClientSecret
: Set this to the client secret assigned when you registered your app.
Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation
. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:
InitiateOAuth
: Set this to REFRESH.OAuthClientId
: Set this to the consumer key in your app settings.OAuthClientSecret
: Set this to the consumer secret in your app settings.OAuthSettingsLocation
: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.Marketplace
: Set this to the The Marketplace region that you are registered to sell in.Schema
: Set this to 'SellingPartner' to connect to SP-API.AppId
: Application ID for Selling Partner app you created.AWSAccessKey
: This is the Access Key tied to the AWS user that is associated with the theOAuthClientId
.AWSSecretKey
: This is the Secret Key tied to the AWS user that is associated with the theOAuthClientId
.
Create a Custom OAuth App¶
You can use a custom OAuth app to authenticate a service account or a user account. See Using OAuth Authentication for more information.
Create an OAuth App for User Account Authentication¶
Follow the procedure below to register an app and obtain the OAuthClientId
and OAuthClientSecret
.
Create a Custom OAuth App¶
-
Log into the Selling Partner Console and open
Develop Apps from Apps & Services
. -
Click
Add new app client
. -
Provide name for the app and select
SP-API
as the API type. -
Provide IAM ARN for the AWS account and Select Sellers.
-
Provide OAuth Login URI and OAuth Redirect URI values. After creating the app, the
OAuthClientId
andOAuthClientSecret
are displayed underLWA credentials
.
For a more in depth reading of how to create a custom OAuth app and configure the IAM role, please see the Amazon Selling Partner Guide.
Important Notes¶
Configuration Files and Their Paths¶
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features¶
This section details a selection of advanced features of the Amazon Marketplace connector.
User Defined Views
The connector 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 connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert
property under "Connection String Options" for more information.
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings
checkbox on the connection configuration screen.
User Defined Views¶
The Amazon Marketplace connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector 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 connector.
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"
Schema for User Defined Views¶
User Defined Views are exposed in the UserViews
schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName
property.
Work with User Defined Views¶
For example, a SQL statement with a User Defined View called UserViews.RCustomers
only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
SSL Configuration¶
Customize the SSL Configuration¶
By default, the connector 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.
Data Model¶
The Amazon Marketplace connector 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 connector 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 connector 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.
Marketplace Data Model¶
The Amazon Marketplace connector 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.
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. To find out more about tables and stored procedures, please navigate to their corresponding entries in this help document.
Amazon Marketplace Connector 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. |
FeedSubmissionList¶
The GetFeedSubmissionList operation returns a list of feed submissions.
Select¶
The connector 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 connector. 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. |
FeedSubmissionResult¶
The GetFeedSubmissionResult operation returns the feed processing report for a specific feed.
Select¶
The connector 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 connector. 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. |
InboundShipmentItems¶
Returns a list of items in a specified inbound shipment.
Select¶
The connector 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 connector. 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 |
InboundShipments¶
Returns a list of inbound shipments based on criteria that you specify.
Select¶
The connector 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 connector. 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 |
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 connector 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 connector. 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 |
OrderItems¶
Returns order items based on the Amazon Order ID that you specify.
Select¶
The connector 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 connector. 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 |
Orders¶
Returns orders created or updated during a time frame that you specify.
Select¶
The connector 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 connector. 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 = 'example@example.com'
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. |
Products¶
The Products Table helps you get information to match your products to existing product listings on Amazon Marketplace websites.
Select¶
The connector 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 connector. 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. |
ReportList¶
Usage information for the operation ReportList.rsd.
Select¶
The connector 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 connector. 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. |
ReportRequestList¶
Usage information for the operation ReportRequestList.rsd.
Select¶
The connector 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 connector. 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 |
Stored Procedures¶
Stored procedures are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.
Amazon Marketplace Connector Stored Procedures¶
Name | Description |
---|---|
CancelFeed | The CancelFeed cancels one or more feed submissions and returns a count of the canceled feed submissions and the feed submission information. Note that if you do not specify a FeedSubmmissionId, all feed submissions are canceled. |
CancelReportRequests | CancelReportRequests operation cancels one or more report requests and returns the number of report requests canceled and report request information. |
CreateSchema | Creates a schema file for the specified table or view. |
GetReport | Creates and/or returns data for a specific report. |
RequestReport | The RequestReport operation creates a report request. |
SubmitImageFeed | The Image feed allows you to upload various images for a product. Amazon can display several images for each product. |
SubmitInventoryFeed | The Inventory feed allows you to update inventory quantities (stock levels) for your items. |
SubmitOrderAcknowledgementFeed | The Order Acknowledgment feed allows you to acknowledge your success or failure with downloading an order. |
SubmitOrderAdjustmentFeed | The Order Adjustment feed allows you to issue a refund (adjustment) for an order. You must provide a reason for the adjustment, such as Customer Return, and the adjustment amount, broken down by price component (principle, shipping, tax, and so on). |
SubmitOrderFulfillmentFeed | The Order Fulfillment feed allows your system to update Amazon's system with order fulfillment information. |
SubmitOverrideFeed | The Override feed allows you to set an exception to your account-level shipping settings for an individual product (SKU). |
SubmitPriceFeed | The Price feed allows you to set the current price and sale price (when applicable) for an item. |
SubmitProductFeed | The Product feed contains descriptive information about the products in your catalog. This information allows Amazon to build a record and assign a unique identifier known as an ASIN (Amazon Standard Item Number) to each product. |
SubmitRelationshipFeed | The Relationship feed allows you to set up optional relationships between items in your catalog. |
SubmitSourcingOnDemandFeed | Usage information for the operation SubmitSourcingOnDemandFeed.rsb. |
CancelFeed¶
The CancelFeed cancels one or more feed submissions and returns a count of the canceled feed submissions and the feed submission information. Note that if you do not specify a FeedSubmmissionId, all feed submissions are canceled.
Input¶
Name | Type | Required | Description |
---|---|---|---|
FeedSubmissionId | String | True | Required. A unique identifier for the feed submission. |
FeedType | String | False | The type of feed submitted. |
SubmittedFromDate | Datetime | False | Beginning of the date range specified when the feed was submitted. |
SubmittedToDate | Datetime | False | End of the date range specified when the feed was submitted. |
CancelFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML or a #TEMP table. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
FeedSubmissionId | String | Required. A unique identifier for the feed submission. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission |
StartedProcessingDate | Datetime | The date when the feed processing started. |
CompletedProcessingDate | Datetime | The date when the feed processing completed. |
SwitchFulfillmentTo | String | Used only when switching the fulfillment of an item from MFN (merchant fulfilled) to AFN (Amazon fulfilled) or vice versa. |
OperationType | String | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
CancelReportRequests¶
CancelReportRequests operation cancels one or more report requests and returns the number of report requests canceled and report request information.
Input¶
Name | Type | Required | Description |
---|---|---|---|
ReportRequestIdList | String | False | A structured list of ReportRequestId values. If a ReportRequestId value is specified, other query conditions are ignored. If not specified, all report requests will be canceled. |
ReportTypeList | String | False | A structured list of ReportType values. |
ReportProcessingStatusList | String | False | A structured list of report processing statuses used to filter report requests. The values for ReportProcessingStatusList are: _SUBMITTED_, _IN_PROGRESS_, _CANCELLED_, _DONE_, _DONE_NO_DATA_ |
RequestedFromDate | Datetime | False | The start date of the date range used to select the data to report. Default: 90 days ago. |
RequestedToDate | Datetime | False | End of the date range used to select the data to report. Default: current date. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Count | Integer | A nonnegative integer representing the total number of canceled report requests. |
CreateSchema¶
Creates a schema file for the specified table or view.
Input¶
Name | Type | Required | Description |
---|---|---|---|
TableName | String | True | The name of the table or view. |
FileName | String | True | The full file path and name of the schema to generate. Begin by choosing a parent directory (this parent directory should be set in the Location property). Complete the filepath by adding a directory corresponding to the schema used (Marketplace), followed by a .rsd file with a name corresponding to the desired table name. For example : 'C:\Users\User\Desktop\AmazonMarketplace\Marketplace\Filters.rsd' |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Result | String | Returns Success or Failure. |
GetReport¶
Creates and/or returns data for a specific report.
Execute¶
We can use GetReport stored procedure in two ways:
To create and download a report in which case you must at least set ReportType, StartDate and DownloadPath attributes. The stored procedure will wait until the report is processed server side.
EXEC GetReport
@ReportType = '_GET_FLAT_FILE_ORDERS_DATA_',
@StartDate = '08-27-2020',
@DownloadPath = 'C:\Tests\AmazonMarketplaceTest'
To download an existing report in which case you must at least set ReportID and DownloadPath attributes for ex:
EXEC GetReport
@ReportID = '50815018501',
@DownloadPath = 'C:\Tests\AmazonMarketplaceTest'
Note
This procedure makes use of indexed parameters
. These input parameters are denoted with a #
character at the end of their names.
Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.
Suppose there is an input parameter named Param#. Input multiple instances of an indexed parameter like this:
EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
Input
Name | Type | Required | Description |
---|---|---|---|
ReportId | String | False | Unique ID of the report to download. |
DownloadPath | String | True | The File path to write the report data. |
CheckSum | Boolean | False | Boolean used to check sum of the report. The default value is false. |
ReportType | String | False | Indicates the report type to request. |
StartDate | Datetime | False | The start date of the date range used to select the data to report. By default it is the current date. If specified, it must be before the current date. |
EndDate | Datetime | False | End date of the date range used to select the data to report. By default it is the current date. If specified, it must be before the current date. |
ReportOptions | String | False | Additional information to pass to the report. If the report accepts ReportOptions, the information is displayed in the report description in the ReportType enumerator section. |
MarketplaceIdList# | String | False | One or more marketplace IDs for the marketplace that registered the listing account. Default: The marketplace where you first registered your Selling Account. |
Result Set Columns
Name | Type | Description |
---|---|---|
Success | Boolean | Boolean indicating the result of the operation. |
MD5SUM | String | The MD5 Sum of the report content. |
GeneratedReportId | String | A unique identifier for the report. |
ReportRequestId | String | A unique identifier for the report request. |
ReportProcessingStatus | String | The processing status of the request. |
RequestReport¶
The RequestReport operation creates a report request.
Note
This procedure makes use of indexed parameters
. These input parameters are denoted with a #
character at the end of their names.
Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.
Suppose there is an input parameter named Param#. Input multiple instances of an indexed parameter like this:
EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
Input¶
Name | Type | Required | Description |
---|---|---|---|
ReportType | String | True | Required. Indicates the report type to request. |
StartDate | Datetime | False | The start date of the date range used to select the data to report.By default it is the current date. If specified, it must be before the current date. |
EndDate | Datetime | False | End date of the date range used to select the data to report. By default it is the current date. If specified, it must be before the current date. |
ReportOptions | String | False | Additional information to pass to the report. If the report accepts ReportOptions, the information is displayed in the report description in the ReportType enumerator section. |
MarketplaceIdList# | String | False | One or more marketplace IDs for the marketplace that registered the listing account. Default: The marketplace where you first registered your Selling Account. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
ReportRequestId | String | A unique identifier for the report request. |
ReportProcessingStatus | String | The processing status of the request. |
SubmitImageFeed¶
The Image feed allows you to upload various images for a product. Amazon can display several images for each product.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query:
INSERT INTO ImageFeedAggregate#TEMP (SKU,ImageType,ImageLocation,OperationType) VALUES ('15700','Main','https://www.cdata.com/ui/img/home/adapters.png','Update')
Then you execute the procedure by specifying the value of ImageFeedAggregate with the name of #TEMP table used ImageFeedAggregate#TEMP.
EXEC SubmitImageFeed ProductImageFeedAggregate = 'ImageFeedAggregate#TEMP'
Input
Name | Type | Required | Description |
---|---|---|---|
SKU | String | True | Required. Used to identify an individual product. Each product must have a SKU, and each SKU must be unique. |
ImageType | String | False | Required. Available Values are Main, Swatch, BKLB, PT1, PT2, PT3, PT4, PT5, PT6, PT7, PT8, Search, PM01, MainOfferImage, OfferImage1, OfferImage2, OfferImage3, OfferImage4, OfferImage5, PFEE, PFUK, PFDE, PFFR, PFIT, PFES, EEGL, PT98, PT99, and ELFL. |
ImageLocation | String | False | The exact location of the image using a full URL (such as http://mystore.com/images/1234.jpg). |
OperationType | String | True | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
ProductImageFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML or a #TEMP table. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedSubmissionId | String | A unique identifier for the feed submission. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitInventoryFeed¶
The Inventory feed allows you to update inventory quantities (stock levels) for your items.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered.
You must include in your query:
INSERT INTO InventoryFeed#TEMP (SKU,Quantity,FulfillmentLatency) VALUES ('15700',11 ,'2')
INSERT INTO InventoryFeed#TEMP (SKU,Quantity,FulfillmentLatency) VALUES ('99987867',10 ,'2')
Then you execute the procedure by specifying the value of InventoryFeedAggregate with the name of #TEMP table used InventoryFeed#TEMP.
EXEC SubmitInventoryFeed InventoryFeedAggregate='InventoryFeed#TEMP'
Input
Name | Type | Required | Description |
---|---|---|---|
SKU | String | False | Required. Used to identify an individual product. Each product must have a SKU, and each SKU must be unique. |
FulfillmentCenterID | String | False | Seller-defined identifier for a fulfillment center. |
Available | Boolean | False | Indicates whether or not the item is available (true = available; false = not available). |
Quantity | Integer | False | Indicates whether or not an item is available (any positive number = available; 0 = not available). |
RestockDate | Date | False | Date the item will be restocked, if not currently available. |
FulfillmentLatency | String | False | The number of days between the order date and the ship date (a whole number between 1 and 30). |
SwitchFulfillmentTo | String | False | Used only when switching the fulfillment of an item from MFN (merchant fulfilled) to AFN (Amazon fulfilled) or vice versa. |
OperationType | String | False | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
InventoryFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML, JSON or a #TEMP table. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedSubmissionId | String | A unique identifier for the feed submission. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitOrderAcknowledgementFeed¶
The Order Acknowledgment feed allows you to acknowledge your success or failure with downloading an order.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered.
You must include in your query:
INSERT INTO OrderAcknowledgementFeedAggregate#TEMP (AmazonOrderId,StatusCode,AmazonOrderItemCode,CancelReason) VALUES ('249-6070298-2783041','Failure','25959136016214','NoInventory')
Then you execute the procedure by specifying the value of OrderAcknowledgementFeedAggregate with the name of #TEMP table used OrderAcknowledgementFeedAggregate#TEMP.
EXEC SubmitOrderAcknowledgementFeed OrderAcknowledgementFeedAggregate = 'OrderAcknowledgementFeedAggregate#TEMP'
The aggregate information can be entered by specifying it in this XML format
<Row>
<AmazonOrderId>249-6070298-2783041</AmazonOrderId>
<StatusCode>Failure</StatusCode>
<AmazonOrderItemCode>25959136016214</AmazonOrderItemCode>
<CancelReason>NoInventory</CancelReason>
</Row>
EXEC SubmitOrderAcknowledgementFeed OrderAcknowledgementFeedAggregate='<Row>
<AmazonOrderId>249-6070298-2783041</AmazonOrderId>
<StatusCode>Failure</StatusCode>
<AmazonOrderItemCode>25959136016214</AmazonOrderItemCode>
<CancelReason>NoInventory</CancelReason>
</Row>'
Input
Name | Type | Required | Description |
---|---|---|---|
AmazonOrderID | String | False | Amazon's unique identifier for an order, which identifies the entire order, regardless of the number of individual items in the order. |
MerchantOrderID | String | False | Optional seller-supplied order ID. Amazon will map the MerchantOrderID to the AmazonOrderID, and you can then use your own order ID (MerchantOrderID) for subsequent feeds relating to the order. |
StatusCode | String | False | Allows you to acknowledge your success or failure with downloading an order. StatusCode can be either Success or Failure. |
AmazonOrderItemCode | String | False | Amazon's unique identifier for an item in an order. |
MerchantOrderItemID | String | False | Optional seller-supplied ID for an item in an order. If the MerchantOrderItemID is specified with the AmazonOrderItemCode, Amazon will map the two IDs and you can then use your own order item ID for subsequent feeds relating to that order item. |
CancelReason | String | False | Used only when sending a StatusCode of Failure. |
ItemAggregate | String | False | An aggregate representing an order Item. Can be in the form of XML or a #TEMP table. Use this field when multiple items in the order need to be acknowledged. |
OrderAcknowledgementFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML, JSON or a #TEMP table. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedSubmissionId | String | A unique identifier for the feed submission. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitOrderAdjustmentFeed¶
The Order Adjustment feed allows you to issue a refund (adjustment) for an order. You must provide a reason for the adjustment, such as Customer Return, and the adjustment amount, broken down by price component (principle, shipping, tax, and so on).
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query :
INSERT INTO ItemPriceAdjustmentsAggregate#TEMP (ItemPriceAdjustmentsComponentType,ItemPriceAdjustmentsComponentAmount,ItemPriceAdjustmentsComponentAmountCurrency) VALUES ('Shipping','150','JPY')
INSERT INTO AdjustedItemAggregate#TEMP (AdjustedItemAmazonOrderItemCode,AdjustedItemAdjustmentReason,ItemPriceAdjustmentsAggregate) VALUES ('25959136016214','CustomerReturn','ItemPriceAdjustmentsAggregate#TEMP')
INSERT INTO OrderAdjustmentFeedAggregate#TEMP (AmazonOrderID,OperationType,AdjustedItemAggregate) VALUES ('249-6070298-2783041','Update','AdjustedItemAggregate#TEMP')
Then you execute the procedure by specifying the value of OrderAdjustmentFeedAggregate with the name of #TEMP table used OrderAdjustmentFeedAggregate#TEMP.
EXEC SubmitOrderAdjustmentFeed OrderAdjustmentFeedAggregate = 'OrderAdjustmentFeedAggregate#TEMP'
Input
Name | Type | Required | Description |
---|---|---|---|
AmazonOrderID | String | False | Amazon's unique identifier for an order, which identifies the entire order regardless of the number of individual items in the order. |
OperationType | String | False | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
MerchantOrderID | String | False | Optional seller-supplied order ID. The first step is to establish the MerchantOrderID in the acknowledgment feed. Amazon will map the MerchantOrderID to the AmazonOrderID, and you can then use your own order ID (MerchantOrderID) for subsequent feeds relating to that order. See the base XSD for the definition. |
AdjustedItemQuantityCancelled | Integer | False | Quantity of items being canceled. Used only for partial cancellations. |
AdjustedItemAmazonOrderItemCode | String | False | Amazon's unique ID for an item in an order. |
AdjustedItemMerchantOrderItemID | String | False | Optional seller-supplied ID for an item in an order. It can be used in order processing if the pairing was established in the acknowledgment feed. |
AdjustedItemMerchantAdjustmentItemID | String | False | Optional seller-supplied unique ID for the adjustment (not used by Amazon). |
AdjustedItemAdjustmentReason | String | False | Reason for the adjustment. |
ItemPriceAdjustmentsComponentType | String | False | The Type of price adjustment for the item. Values include: Principal, Shipping, Tax, ShippingTax, RestockingFee, RestockingFeeTax, GiftWrap, GiftWrapTax, Surcharge, ReturnShipping, Goodwill, ExportCharge, COD, CODTax, Other, FreeReplacementReturnShipping |
ItemPriceAdjustmentsComponentAmount | Decimal | False | The Amount of the adjustment. |
ItemPriceAdjustmentsComponentAmountCurrency | String | False | The Currency for the Amount. |
ItemPriceAdjustmentsAggregate | String | False | An aggregate representing the Amount the buyer is to be refunded for the item. Can be in the form of XML, JSON, or a #TEMP table. Use this field if multiple item price adjustments need to be applied. |
PromotionAdjustmentsPromotionClaimCode | String | False | The ClaimCode for the Promotion Adjustment. |
PromotionAdjustmentsMerchantPromotionID | String | False | The Promotion ID for the Promotion Adjustment. |
PromotionAdjustmentsComponentType | String | False | The Type of price adjustment for the promotion. |
PromotionAdjustmentsComponentAmount | Decimal | False | The Amount of price adjustment for the promotion. |
PromotionAdjustmentsComponentAmountCurrency | String | False | The Currency for the Amount. |
PromotionAdjustmentsComponentAggregate | String | False | An aggregate representing the Amount the buyer is to be refunded for the promotion, broken down by type. Can be in the form of XML, JSON, or a #TEMP table. Use this field if multiple promotion price adjustments need to be applied. |
PromotionAdjustmentsAggregate | String | False | An aggregate representing the promotion. Child Elements include PromotionClaimCode, MerchantPromotionID, ComponentAggregate (Type, Amount and Amount@Currency). Use this field if multiple promotions need to be applied. |
AdjustedItemAggregate | String | False | An aggregate representing order adjustment information for a specific item. Can be in the form of XML, JSON, or a #TEMP table. Use this field if multiple items need adjusting in 1 order. |
OrderAdjustmentFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML, JSON or a #TEMP table. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedSubmissionId | String | A unique identifier for the feed submission. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitOrderFulfillmentFeed¶
The Order Fulfillment feed allows your system to update Amazon's system with order fulfillment information.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query :
INSERT INTO ItemAggregate#TEMP (ItemAmazonOrderItemCode,ItemQuantity) VALUES ('25959136016214','1');
INSERT INTO OrderFulfillmentFeedAggregate#TEMP (AmazonOrderID,FulfillmentDate,FulfillmentDataCarrierName,FulfillmentDataShippingMethod,FulfillmentDataShipperTrackingNumber,ItemAggregate) VALUES ('249-6070298-2783041','2017-02-01T00:00:00Z',' Delivery Company','Normal Delivery','1223525345234','ItemAggregate#TEMP')
Then you execute the procedure by specifying the value of OrderFulfillmentFeedAggregate with the name of #TEMP table used OrderFulfillmentFeedAggregate#TEMP.
EXEC SubmitOrderFulfillmentFeed OrderFulfillmentFeedAggregate = 'OrderFulfillmentFeedAggregate#TEMP'
Input
Name | Type | Required | Description |
---|---|---|---|
AmazonOrderID | String | False | Amazon's unique identifier for an order, which identifies the entire order regardless of the number of individual items in the order. |
MerchantOrderID | String | False | Optional seller-supplied order ID. The first step is to establish the MerchantOrderID in the acknowledgment feed. Amazon will map the MerchantOrderID to the AmazonOrderID, and you can then use your own order ID (MerchantOrderID) for subsequent feeds relating to that order. See the base XSD for the definition. |
OperationType | String | True | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
MerchantFulfillmentID | Integer | False | Seller-supplied unique identifier for the shipment (not used by Amazon). |
FulfillmentDate | Datetime | False | The date the item was actually shipped or picked up, depending on the fulfillment method specified in the order. |
FulfillmentDataCarrierCode | String | False | The shipping carrier code. |
FulfillmentDataCarrierName | String | False | The shipping carrier name. |
FulfillmentDataShippingMethod | String | False | The shipping method used to deliver the item. |
FulfillmentDataShipperTrackingNumber | String | False | The tracking number for the shipment. |
CODCollectionMethod | String | False | Cash on delivery collection mode of an order. |
ItemAmazonOrderItemCode | String | False | Amazon's unique ID for an item in an order. |
ItemMerchantOrderItemID | String | False | The shipping Optional seller-supplied ID for an item in an order. |
ItemMerchantFulfillmentItemID | String | False | Seller-supplied unique identifier for an item in the shipment (not used by Amazon). |
ItemQuantity | Integer | False | The quantity of an item shipped. |
ItemAggregate | String | False | An aggregate representing order-fulfillment information for a specific item. Can be in the form of XML, JSON, or a #TEMP table. Use this field when multiple Items need to be included in the feed. |
FulfillmentDataAggregate | String | False | An aggregate representing order-fulfillment information for a specific item. Can be in the form of XML, JSON, or a #TEMP table. Use this field when multiple Items need to be included in the feed. |
OrderFulfillmentFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML, JSON, or a #TEMP table. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedSubmissionId | String | A unique identifier for the feed submission. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitOverrideFeed¶
The Override feed allows you to set an exception to your account-level shipping settings for an individual product (SKU).
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query :
INSERT INTO ShippingOverrideAggregate#TEMP (ShipOption,IsShippingRestricted) VALUES ('Std JP Kanto8','true')
INSERT INTO ShippingOverrideAggregate#TEMP (ShipOption,Type,ShipAmount,ShipAmountCurrency) VALUES ('Std JP Kantoa8','Exclusive','400.0','JPY')
INSERT INTO OverrideFeedAggregate#TEMP (SKU,OperationType,ShippingOverrideAggregate) VALUES ('15700','Update','ShippingOverrideAggregate#TEMP')
Then you execute the procedure by specifying the value of OverrideFeedAggregate with the name of #TEMP table used OverrideFeedAggregate#TEMP.
EXEC SubmitOverrideFeed OverrideFeedAggregate = 'OverrideFeedAggregate#TEMP'
Input
Name | Type | Required | Description |
---|---|---|---|
SKU | String | False | Required. Used to identify an individual product. Each product must have a SKU, and each SKU must be unique. |
OperationType | String | False | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
ShipOption | String | False | Locale and shipping service. |
IsShippingRestricted | Boolean | False | Indicates whether the SKU can or cannot be shipped to the specified locale using the specified shipping service (ShipOption). |
Type | String | False | The type of override shipping charge (Additive or Exclusive) being applied to the SKU. |
ShipAmount | Decimal | False | The Additive or Exclusive shipping charge amount. |
ShipAmountCurrency | Decimal | False | The currency used for the ShipAmount. |
ShippingOverrideAggregate | String | False | An aggregate representing the the shipping override. Can be in the form of XML or a #TEMP table. Use this field if multiple Shipping Overrides are needed. |
OverrideFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML or a #TEMP table. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedSubmissionId | String | A unique identifier for the feed submission. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitPriceFeed¶
The Price feed allows you to set the current price and sale price (when applicable) for an item.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query:
INSERT INTO PriceFeedAggregate#TEMP (SKU,StandardPrice,StandardPriceCurrency,MAP,MAPCurrency,SalePrice,SalePriceCurrency,SaleStartDate,SaleEndDate) VALUES ('15700','134','JPY','100','JPY','150','JPY','2017-02-01T00:00:00Z','2020-02-01T00:00:00Z')
INSERT INTO PriceFeedAggregate#TEMP (SKU,StandardPrice,StandardPriceCurrency,MAP,MAPCurrency,SalePrice,SalePriceCurrency,SaleStartDate,SaleEndDate) VALUES ('99987867','134','JPY','100','JPY','150','JPY','2017-02-01T00:00:00Z','2020-02-01T00:00:00Z')
Then you execute the procedure by specifying the value of PriceFeedAggregate with the name of #TEMP table used PriceFeedAggregate#TEMP.
EXEC SubmitPriceFeed PriceFeedAggregate = 'PriceFeedAggregate#TEMP'
Input
Name | Type | Required | Description |
---|---|---|---|
SKU | String | False | Required. Used to identify an individual product. Each product must have a SKU, and each SKU must be unique. |
OperationType | String | False | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
StandardPrice | Double | False | Required. Price of the item (non-sale price). |
StandardPriceCurrency | String | False | Required. The currency for the Standard Price. |
MAP | String | False | Minimum Advertised Price. Use only if dictated by the manufacturer. Both the standard and sale price (if applicable) must be higher than the MAP value. |
MAPCurrency | String | False | Minimum Advertised Price. Use only if dictated by the manufacturer. Both the standard and sale price (if applicable) must be higher than the MAP value. |
SalePrice | Double | False | The price of the sale. |
SalePriceCurrency | String | False | The currency of the sale. |
SaleStartDate | Datetime | False | The starting date of the sale. |
SaleEndDate | Datetime | False | The ending date of the sale. |
PriceFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML or a #TEMP table. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedSubmissionId | String | A unique identifier for the feed submission. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitProductFeed¶
The Product feed contains descriptive information about the products in your catalog. This information allows Amazon to build a record and assign a unique identifier known as an ASIN (Amazon Standard Item Number) to each product.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered.
SubmitProductFeed Has Two main aggregates that need to be entered.
- ProductDescriptionDataAggregate
- ProductDataAggregate
You must include in your query :
ProductDescriptionDataAggregate information needs to be entered using ProductDescriptionDataAggregate#TEMP temp table.
INSERT INTO ProductDescriptionDataAggregate#TEMP (Title,Brand,Description,BulletPoint,Manufacturer) VALUES ('test Title','test Brand','test Description','test BulletPoint','test Manufacturer')
ProductDataAggregate info varies by the Category used. The List of all XSD provided by amazon can be found here https://images-na.ssl-images-amazon.com/images/G/01/rainier/help/xsd/release_1_9/Product.xsd
This example will be using the Sports category https://images-na.ssl-images-amazon.com/images/G/01/rainier/help/xsd/release_1_9/Sports.xsd
To add a valid ProductData Sports.xsd must be followed thoroughly and the xml aggregate must be created correctly. This example has the following product Data
- ProductType = SportingGoods
- Parentage = Parent
- VariationTheme = Size (Based on the ProductType selected some of the VariationTheme will be invalid. In these example the Design variation is invalid.)
- Size = S
- MaterialComposition = Metal
By following the order of Sports.xsd XSD file the aggregate is :
<Sports>
<ProductType>SportingGoods</ProductType>
<VariationData>
<Parentage>parent</Parentage>
<VariationTheme>Size</VariationTheme>
<Size>S</Size>
</VariationData>
<MaterialComposition>Metal</MaterialComposition>
</Sports>
This Aggregate is the value of ProductDataAggregate.
INSERT INTO ProductFeedAggregate#TEMP(SKU,ProductDescriptionDataAggregate,ProductDataAggregate) VALUES ('test SKU','ProductDescriptionDataAggregate#TEMP','<Sports>
<ProductType>SportingGoods</ProductType>
<VariationData>
<Parentage>parent</Parentage>
<VariationTheme>Size</VariationTheme>
<Size>S</Size>
</VariationData>
<MaterialComposition>Metal</MaterialComposition>
</Sports>')
Then you execute the procedure by specifying the value of ProductFeedAggregate with the name of #TEMP table used ProductFeedAggregate#TEMP.
EXEC SubmitProductFeed ProductFeedAggregate = 'ProductFeedAggregate#TEMP'
Input
Name | Type | Required | Description |
---|---|---|---|
SKU | String | True | Required. Used to identify an individual product. Each product must have a SKU, and each SKU must be unique. |
OperationType | String | True | Required. Used to specify the type of operation (Update, Delete or PartialUpdate) to be performed on the data. |
StandardProductID | String | False | A standard, unique identifier for a product, consisting of a type (ISBN, UPC, or EAN) and a value that conforms to the appropriate format for the type specified. This is a required field if Type is provided for StandardProductID in the base XSD. |
ProductTaxCode | String | False | Amazon's standard code to identify the tax properties for a product. |
LaunchDate | Datetime | False | Controls when the product appears from searches and browsing on the Amazon website. |
DiscontinueDate | Datetime | False | Controls when the product disappears from searches and browsing on the Amazon website. |
ReleaseDate | Datetime | False | The date a product is released for sale. |
Condition | String | False | The condition of the item. |
Rebate | String | False | The rebate of the product. |
ItemPackageQuantity | Integer | False | Number of the same product contained within one package. For example, if you are selling a case of 10 packages of socks, ItemPackageQuantity would be 10. |
NumberOfItems | Integer | False | Number of discrete items included in the product you are offering for sale, such that each item is not packaged for individual sale. For example, if you are selling a case of 10 packages of socks, and each package contains 3 pairs of socks, NumberOfItems would be 30. |
Title | String | True | Required. Short description of the product. |
Brand | String | False | Brand of the product. |
Designer | String | False | Designer of the product. |
Description | String | False | Long Description of the product. |
BulletPoint | String | False | Brief descriptions of the product's features. |
PackageDimensionsLength | String | False | Calculated dimensions of the package. |
PackageDimensionsWidth | String | False | Calculated dimensions of the package. |
PackageDimensionsHeight | String | False | Calculated dimensions of the package. |
PackageDimensionsWeight | String | False | Calculated dimensions of the package. |
ItemDimensionsLength | String | False | Calculated dimensions of the item. |
ItemDimensionsWidth | String | False | Calculated dimensions of the item. |
ItemDimensionsHeight | String | False | Calculated dimensions of the item. |
ItemDimensionsWeight | String | False | Calculated dimensions of the item. |
PackageWeight | String | False | Weight of the package |
ShippingWeight | String | False | Weight of the product when packaged to ship. |
MerchantCatalogNumber | String | False | Seller's catalog number for the product, if different from the SKU. |
MSRP | Double | False | Manufacturer's suggested retail price. |
MaxOrderQuantity | Integer | False | Maximum quantity of the product that a customer can order. |
SerialNumberRequired | Boolean | False | Indicates whether the product must have a serial number. |
Prop65 | Boolean | False | Used if the product is subject to prop 65 regulations in California. US only. |
LegalDisclaimer | String | False | Any legal disclaimer needed for the product. |
Manufacturer | String | False | Maker of the product. |
MfrPartNumber | String | False | Part number provided by the original manufacturer. |
SearchTerms | String | False | Terms you submit that give product search results. |
PlatinumKeywords | String | False | Values used to map products to nodes in a custom browse structure. |
RecommendedBrowseNode | String | False | Value used to classify an item. |
Memorabilia | Boolean | False | Used if the product is a memorabilia item. |
Autographed | Boolean | False | Used if the product is an autographed item. |
UsedFor | String | False | What the product is used for (affects the product's placement in the Amazon browse structure). |
ItemType | String | False | Pre-defined value that specifies where the product should appear within the Amazon browse structure. |
OtherItemAttributes | String | False | Used to further classify the product within the Amazon browse structure. |
TargetAudience | String | False | Used to further classify the product within the Amazon browse structure. |
SubjectContent | String | False | Used to relate the product to a specific idea or concept for merchandising. |
IsGiftWrapAvailable | Boolean | False | Indicates whether gift wrapping is available for the product. |
IsGiftMessageAvailable | Boolean | False | Indicates whether gift messaging is available for the product. |
IsDiscontinuedByManufacturer | Boolean | False | Indicates that the manufacturer has stopped making the item. |
MaxAggregateShipQuantity | Integer | False | The maximum number of the same item that can be shipped in the same package. |
ProductDescriptionDataAggregate | String | False | Section containing category-specific information such as variations. Can be in the form of XML or a #TEMP table. |
ProductDataAggregate | String | False | Section containing category-specific information such as variations. Can be in the form of XML or a #TEMP table. |
ProductFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML, JSON or a #TEMP table. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedSubmissionId | String | A unique identifier for the feed submission. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitRelationshipFeed¶
The Relationship feed allows you to set up optional relationships between items in your catalog.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query:
INSERT INTO RelationAggregate#TEMP (Type,SKU) VALUES ('Variation','99987867')
INSERT INTO RelationAggregate#TEMP (Type,SKU) VALUES ('Variation','99987867')
INSERT INTO RelationshipFeedAggregate#TEMP(ParentSKU,RelationAggregate) VALUES ('15700','RelationAggregate#TEMP')
Then you execute the procedure by specifying the value of RelationshipFeedAggregate with the name of #TEMP table used RelationshipFeedAggregate#TEMP.
EXEC SubmitRelationshipFeed RelationshipFeedAggregate = 'RelationshipFeedAggregate#TEMP'
Input
Name | Type | Required | Description |
---|---|---|---|
ParentSKU | String | False | Required. The master SKU for a product with variations. |
OperationType | String | False | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
Type | String | False | Type of relationship; currently supported are Variation or Accessory. |
SKU | String | False | Used to identify an individual product, one (child) variation of the parent SKU. |
RelationAggregate | String | False | An aggregate representing the the relation. Can be in the form of XML, JSON or a #TEMP table. Use this field when applying multiple relations |
RelationshipFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML or #TEMP table. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedSubmissionId | String | A unique identifier for the feed submission. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitSourcingOnDemandFeed¶
Usage information for the operation SubmitSourcingOnDemandFeed.rsb.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query:
INSERT INTO OrderSourcingOnDemandFeedAggregate#TEMP (AmazonOrderID,SKU,EstimatedShipDate) VALUES ('250-4747727-9303810','15700','2018-12-08T00:00:00Z');
Then you execute the procedure by specifying the value of OrderSourcingOnDemandFeedAggregate with the name of #TEMP table used OrderSourcingOnDemandFeedAggregate#TEMP.
EXEC SubmitSourcingOnDemandFeed OrderSourcingOnDemandFeedAggregate = 'OrderSourcingOnDemandFeedAggregate#TEMP'
Input
Name | Type | Required | Description |
---|---|---|---|
AmazonOrderID | String | False | Amazon Order ID. |
SKU | String | True | Required. Used to identify an individual product. Each product must have a SKU, and each SKU must be unique. |
EstimatedShipDate | Datetime | True | Required. Estimated ship date. |
OrderSourcingOnDemandFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML or a #TEMP table. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedSubmissionId | String | A unique identifier for the feed submission. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
Selling Partner Data Model¶
The Amazon Marketplace connector 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¶
Reports can be exposed as views by setting IncludeReports
connection property to true. A view is exposed for each report type specified in ReportTypes
connection property. In order to include multiple reports, you can also specify a report type category, which can be retrieved from ReportTypes view.
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.
Tables¶
The connector 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 Tables¶
Name | Description |
---|---|
ListingsItems | Returns details about a listings item for a selling partner. |
ListingsItemsAttributes | The GetFeedSubmissionList operation returns a list of feed submissions. |
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. |
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. |
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. To find out more about tables and stored procedures, please navigate to their corresponding entries in this help document.
Amazon Marketplace Connector Views¶
Name | Description |
---|---|
CatalogItems | The Catalog Items table helps you retrieve item details for items in the catalog. |
ContainerIdentificationInternal | Usage information for the operation ContainerIdentificationInternal.rsd. |
ContainerItemInternal | Usage information for the operation ContainerItemInternal.rsd. |
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. |
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. |
OrderAckInternal | Usage information for the operation OrderAckInternal.rsd. |
OrderItemAckInternal | Usage information for the operation OrderItemAckInternal.rsd. |
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. |
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. |
ShipmentAddressInternal | Usage information for the operation ShipmentAddressInternal.rsd. |
ShipmentCartonsInternal | Usage information for the operation ShipmentCartonsInternal.rsd. |
ShipmentItemsInternal | Usage information for the operation ShipmentItemsInternal.rsd. |
ShipmentPalletsInternal | Usage information for the operation ShipmentPalletsInternal.rsd. |
VendorOrders | The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. |
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 | |
SellerSKU | String | |
UPC | String | |
EAN | String | |
ISBN | String | |
JAN | String | |
MarketplaceId | String |
ContainerIdentificationInternal¶
Usage information for the operation ContainerIdentificationInternal.rsd.
Columns¶
Name | Type | References | Description |
---|---|---|---|
ContainerIdentificationType | String | The allowed values are SSCC, AMZNCC, GTIN, BPS, CID. | |
ContainerIdentificationNumber | String |
ContainerItemInternal¶
Usage information for the operation ContainerItemInternal.rsd.
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemReference | String | ||
ShippedQuantityAmount | Integer | ||
ShippedQuantityUnit | String | The allowed values are Cases, Eaches. | |
ShippedQuantityUnitSize | Integer | ||
PurchaseOrderNumber | String | ||
LotNumber | String | ||
ExpiryManufacturerDate | Datetime | ||
ExpiryDate | Datetime | ||
ExpiryAfterDurationUnit | String | The allowed values are Days, Months. | |
ExpiryAfterDurationValue | Integer | ||
MaximumRetailPriceCurrencyCode | String | ||
MaximumRetailPriceAmount | String | ||
HandlingCode | String | The allowed values are Oversized, Fragile, Food, HandleWithCare. |
Feeds¶
The GetFeedSubmissionList operation returns a list of feed submissions.
Select¶
The connector 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 connector.
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. |
InboundShipmentItems¶
Returns a list of items in a specified inbound shipment.
Select¶
The connector 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 connector.
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 |
InboundShipments¶
Returns a list of inbound shipments based on criteria that you specify.
Select¶
The connector 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 connector.
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 |
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 connector 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 connector.
Note
Attributes 'GranularityType' and 'GranularityId' are required to query the view.
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 | |
MarketplaceId | String |
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 |
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 |
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 |
OrderAckInternal¶
Usage information for the operation OrderAckInternal.rsd.
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemSequenceNumber | String | ||
AmazonProductIdentifier | String | ||
VendorProductIdentifier | String | ||
OrderedAmount | Integer | ||
OrderedUnit | String | The allowed values are Cases, Eaches. | |
OrderedUnitSize | Integer | ||
NetCostCurrencyCode | String | ||
NetCostAmount | String | ||
ListPriceCurrencyCode | String | ||
ListPriceAmount | String | ||
DiscountMultiplier | String | ||
ItemAcknowledgements | String |
OrderItemAckInternal¶
Usage information for the operation OrderItemAckInternal.rsd.
Columns¶
Name | Type | References | Description |
---|---|---|---|
AcknowledgementCode | String | The allowed values are Accepted, Backordered, Rejected. | |
AcknowledgedAmount | Integer | ||
AcknowledgedUnit | String | The allowed values are Cases, Eaches. | |
AcknowledgedUnitSize | Integer | ||
ScheduledShipDate | Datetime | ||
ScheduledDeliveryDate | Datetime | ||
RejectionReason | String | The allowed values are TemporarilyUnavailable, InvalidProductIdentifier, ObsoleteProduct. |
OrderItems¶
Returns order items based on the Amazon Order ID that you specify.
Select¶
The connector 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 connector. 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. | |
GiftWrapPriceAmount | String | The Gift Wrap Price Amount. | |
GiftWrapPriceCurrencyCode | String | The Gift Wrap 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. | |
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. | |
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. | |
GiftMessageText | String | The Gift Message Text. | |
GiftWrapLevel | String | The Gift Wrap Level. | |
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 | Decimal | The Gift Wrap Price Currency Code. | |
GiftWrapTaxAmount | String | The Gift Wrap Tax Amount. | |
GiftWrapTaxCurrencyCode | Decimal | 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 |
Orders¶
Returns orders created or updated during a time frame that you specify.
Select¶
The connector 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 connector.
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 = 'random@gmail.com'
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 = 'example@example.com'
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. | |
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. | |
DefaultShipCountry | String | Default Ship From Location Address Country. | |
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. |
ReportList¶
Returns report details for the reports that match the filters that you specify.
Select¶
The connector 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 connector.
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. |
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. |
ShipmentAddressInternal¶
Usage information for the operation ShipmentAddressInternal.rsd.
Columns¶
Name | Type | References | Description |
---|---|---|---|
Name | String | ||
AddressLine1 | String | ||
AddressLine2 | String | ||
AddressLine3 | String | ||
City | String | ||
County | String | ||
District | String | ||
StateOrRegion | String | ||
PostalCode | String | ||
CountryCode | String | ||
Phone | String |
ShipmentCartonsInternal¶
Usage information for the operation ShipmentCartonsInternal.rsd.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CartonIdentifiers | String | ||
CartonSequenceNumber | String | ||
DimensionsLength | String | ||
DimensionsWidth | String | ||
DimensionsHeight | String | ||
DimensionsUnit | String | The allowed values are In, Ft, Meter, Yard. | |
WeightValue | String | ||
WeightUnit | String | The allowed values are G, Kg, Oz, Lb. | |
TrackingNumber | String | ||
Items | String |
ShipmentItemsInternal¶
Usage information for the operation ShipmentItemsInternal.rsd.
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemSequenceNumber | String | ||
AmazonProductIdentifier | String | ||
VendorProductIdentifier | String | ||
ShippedQuantityAmount | Integer | ||
ShippedQuantityUnit | String | The allowed values are Cases, Eaches. | |
ShippedQuantityUnitSize | Integer | ||
PurchaseOrderNumber | String | ||
LotNumber | String | ||
ExpiryManufacturerDate | Datetime | ||
ExpiryDate | Datetime | ||
ExpiryAfterDurationUnit | String | The allowed values are Days, Months. | |
ExpiryAfterDurationValue | Integer | ||
MaximumRetailPriceCurrencyCode | String | ||
MaximumRetailPriceAmount | String | ||
HandlingCode | String | The allowed values are Oversized, Fragile, Food, HandleWithCare. |
ShipmentPalletsInternal¶
Usage information for the operation ShipmentPalletsInternal.rsd.
Columns¶
Name | Type | References | Description |
---|---|---|---|
PalletIdentifiers | String | ||
Tier | Integer | ||
Block | Integer | ||
DimensionsLength | String | ||
DimensionsWidth | String | ||
DimensionsHeight | String | ||
DimensionsUnit | String | The allowed values are In, Ft, Meter, Yard. | |
WeightValue | String | ||
WeightUnit | String | The allowed values are G, Kg, Oz, Lb. | |
CartonCount | Integer | ||
CartonReferenceNumbers | String | ||
Items | String |
VendorOrders¶
The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
Select¶
The connector 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 connector.
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. |
Stored Procedures¶
Stored procedures are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.
Amazon Marketplace Connector Stored Procedures¶
Name | Description |
---|---|
CancelFeed | The CancelFeed cancels feed submission for the given FeedId |
CancelReport | CancelReport operation cancels report request for the given ReportId. |
CreateSchema | Creates a schema file for the specified table or view. |
GetOAuthAccessToken | Gets an authentication token from Amazon. |
GetOAuthAuthorizationURL | Gets the authorization URL that must be opened separately by the user to grant access to your application. You will request the OAuthAccessToken from this URL. |
GetReport | Creates and/or returns data for a specific report. |
RefreshOAuthAccessToken | Exchanges a access token for a new access token. |
RequestReport | The RequestReport operation creates a report request. |
SubmitImageFeed | The Image feed allows you to upload various images for a product. Amazon can display several images for each product. |
SubmitInventoryFeed | The Inventory feed allows you to update inventory quantities (stock levels) for your items. |
SubmitOrderAcknowledgementFeed | The Order Acknowledgment feed allows you to acknowledge your success or failure with downloading an order. |
SubmitOrderAdjustmentFeed | The Order Adjustment feed allows you to issue a refund (adjustment) for an order. You must provide a reason for the adjustment, such as Customer Return, and the adjustment amount, broken down by price component (principle, shipping, tax, and so on). |
SubmitOrderFulfillmentFeed | The Order Fulfillment feed allows your system to update Amazon's system with order fulfillment information. |
SubmitOverrideFeed | The Override feed allows you to set an exception to your account-level shipping settings for an individual product (SKU). |
SubmitPriceFeed | The Price feed allows you to set the current price and sale price (when applicable) for an item. |
SubmitProductFeed | The Product feed contains descriptive information about the products in your catalog. This information allows Amazon to build a record and assign a unique identifier known as an ASIN (Amazon Standard Item Number) to each product. |
SubmitRelationshipFeed | The Relationship feed allows you to set up optional relationships between items in your catalog. |
SubmitSourcingOnDemandFeed | Usage information for the operation SubmitSourcingOnDemandFeed.rsb. |
SubmitVendorOrderAcknowledgement | Submits acknowledgements for one purchase order. |
SubmitVendorShipmentConfirmations | Submits shipment confirmations for vendor orders. |
CancelFeed¶
The CancelFeed cancels feed submission for the given FeedId
Input¶
Name | Type | Required | Description |
---|---|---|---|
FeedId | String | True | Required. The identifier for the feed. This identifier is unique only in combination with a seller ID. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | Boolean | Whether the CancelFeed operation successful or not |
CancelReport¶
CancelReport operation cancels report request for the given ReportId.
Input¶
Name | Type | Required | Description |
---|---|---|---|
ReportId | String | True | Required. The identifier for the report. This identifier is unique only in combination with a seller ID. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | Boolean | Whether the CancelReport operation successful or not. |
CreateSchema¶
Creates a schema file for the specified table or view.
Input¶
Name | Type | Required | Description |
---|---|---|---|
TableName | String | True | The name of the table or view. |
FileName | String | True | The full file path and name of the schema to generate. Begin by choosing a parent directory (this parent directory should be set in the Location property). Complete the filepath by adding a directory corresponding to the schema used (SellingPartner), followed by a .rsd file with a name corresponding to the desired table name. For example : 'C:\Users\User\Desktop\AmazonMarketplace\SellingPartner\Filters.rsd' |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Result | String | Returns Success or Failure. |
GetOAuthAccessToken¶
Gets an authentication token from Amazon.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is APP. |
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. Only needed when the Authmode parameter is Web. |
Verifier | String | False | The verifier returned from Amazon after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
State | String | False | Any value that you wish to be sent with the callback. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The access token used for communication with the API. |
OAuthRefreshToken | String | The refresh access token used to refresh your connection. |
ExpiresIn | String | The remaining lifetime on the access token. |
GetOAuthAuthorizationURL¶
Gets the authorization URL that must be opened separately by the user to grant access to your application. You will request the OAuthAccessToken from this URL.
Input¶
Name | Type | Required | Description |
---|---|---|---|
CallbackURL | String | False | This field determines where the response is sent. The value of this parameter must exactly match one of the values registered in the APIs Console, including the HTTP or HTTPS schemes, case, and trailing forward slash ('/'). |
State | String | False | Any value that you wish to be sent with the callback. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
GetReport¶
Creates and/or returns data for a specific report.
Execute¶
We can use GetReport stored procedure in two ways:
To create and download a report in which case you must at least set ReportType, StartDate and DownloadPath attributes. The stored procedure will wait until the report is processed server side.
EXEC GetReport
@ReportDocumentId = '1234',
@DownloadPath = 'C:\Tests\AmazonMarketplaceTest'
Input
Name | Type | Required | Description |
---|---|---|---|
ReportDocumentId | String | True | Unique ID of the report to download. |
DownloadPath | String | True | The File path to write the report data. If no path is specified, the file is kept in memory in the FileData output. |
IsRestrictedReport | Boolean | False | Boolean indicating whether the specified report ID is a restricted report (report containing PII). The default value is false. |
Result Set Columns
Name | Type | Description |
---|---|---|
Success | Boolean | Boolean indicating the result of the operation. |
Url | String | A unique identifier for the report. |
FileData | String | The file data output, if the LocalPath input is empty. |
RefreshOAuthAccessToken¶
Exchanges a access token for a new access token.
Input¶
Name | Type | Required | Description |
---|---|---|---|
OAuthRefreshToken | String | True | The refresh token returned from the original authorization code exchange. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from Amazon. |
OAuthRefreshToken | String | The authentication token returned from Amazon. |
ExpiresIn | String | The remaining lifetime on the access token. |
RequestReport¶
The RequestReport operation creates a report request.
Input¶
Name | Type | Required | Description |
---|---|---|---|
ReportType | String | True | Required. Indicates the report type to request. |
DataStartTime | Datetime | False | The start date of the date range used to select the data to report.By default it is the current date. If specified, it must be before the current date. |
DataEndTime | Datetime | False | End date of the date range used to select the data to report. By default it is the current date. If specified, it must be before the current date. |
ReportOptions | String | False | Additional information to pass to the report. If the report accepts ReportOptions, the information is displayed in the report description in the ReportType enumerator section. |
MarketplaceIds | String | True | Required. A list of one or more marketplace IDs for the marketplace that registered the listing account. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
ReportId | String | A unique identifier for the report. |
SubmitImageFeed¶
The Image feed allows you to upload various images for a product. Amazon can display several images for each product.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query :
INSERT INTO ImageFeedAggregate#TEMP (SKU,ImageType,ImageLocation,OperationType) VALUES ('15700','Main','https://www.cdata.com/ui/img/home/adapters.png','Update')
Then you execute the procedure by specifying the value of ImageFeedAggregate with the name of #TEMP table used ImageFeedAggregate#TEMP.
Exec SubmitImageFeed ProductImageFeedAggregate = 'ImageFeedAggregate#TEMP', marketplaceids = 'A1VC38T7YXB528'
Input
Name | Type | Required | Description |
---|---|---|---|
SKU | String | True | Required. Used to identify an individual product. Each product must have a SKU, and each SKU must be unique. |
ImageType | String | True | Required. Available Values are Main, Swatch, BKLB, PT1, PT2, PT3, PT4, PT5, PT6, PT7, PT8, Search, PM01, MainOfferImage, OfferImage1, OfferImage2, OfferImage3, OfferImage4, OfferImage5, PFEE, PFUK, PFDE, PFFR, PFIT, PFES, EEGL, PT98, PT99, and ELFL. |
ImageLocation | String | False | The exact location of the image using a full URL (such as http://mystore.com/images/1234.jpg). |
OperationType | String | True | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
ProductImageFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML or a #TEMP table. |
MarketplaceIds | String | True | Required. A list of one or more marketplace IDs for the marketplace that registered the listing account. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedId | String | A unique identifier for the feed. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitInventoryFeed¶
The Inventory feed allows you to update inventory quantities (stock levels) for your items.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query:
INSERT INTO InventoryFeed#TEMP (SKU,Quantity,FulfillmentLatency) VALUES ('15700',11 ,'2')
INSERT INTO InventoryFeed#TEMP (SKU,Quantity,FulfillmentLatency) VALUES ('99987867',10 ,'2')
Then you execute the procedure by specifying the value of InventoryFeedAggregate with the name of #TEMP table used InventoryFeed#TEMP.
EXEC SubmitInventoryFeed InventoryFeedAggregate='InventoryFeed#TEMP', marketplaceids = 'A1VC38T7YXB528'
Input
Name | Type | Required | Description |
---|---|---|---|
SKU | String | True | Required. Used to identify an individual product. Each product must have a SKU, and each SKU must be unique. |
FulfillmentCenterID | String | False | Seller-defined identifier for a fulfillment center. |
Available | Boolean | False | Indicates whether or not the item is available (true = available; false = not available). |
Quantity | Integer | False | Indicates whether or not an item is available (any positive number = available; 0 = not available). |
RestockDate | Date | False | Date the item will be restocked, if not currently available. |
FulfillmentLatency | String | False | The number of days between the order date and the ship date (a whole number between 1 and 30). |
SwitchFulfillmentTo | String | False | Used only when switching the fulfillment of an item from MFN (merchant fulfilled) to AFN (Amazon fulfilled) or vice versa. |
OperationType | String | True | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
InventoryFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML, JSON or a #TEMP table. |
MarketplaceIds | String | True | Required. A list of one or more marketplace IDs for the marketplace that registered the listing account. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedId | String | A unique identifier for the feed. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitOrderAcknowledgementFeed¶
The Order Acknowledgment feed allows you to acknowledge your success or failure with downloading an order.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query :
INSERT INTO OrderAcknowledgementFeedAggregate#TEMP(AmazonOrderId,StatusCode,AmazonOrderItemCode,CancelReason) VALUES ('249-6070298-2783041','Failure','25959136016214','NoInventory')
Then you execute the procedure by specifying the value of OrderAcknowledgementFeedAggregate with the name of #TEMP table used OrderAcknowledgementFeedAggregate#TEMP.
EXEC SubmitOrderAcknowledgementFeed OrderAcknowledgementFeedAggregate = 'OrderAcknowledgementFeedAggregate#TEMP', marketplaceids = 'A1VC38T7YXB528'
The aggregate information can be entered by specifying it in this XML format
<Row>
<AmazonOrderId>249-6070298-2783041</AmazonOrderId>
<StatusCode>Failure</StatusCode>
<AmazonOrderItemCode>25959136016214</AmazonOrderItemCode>
<CancelReason>NoInventory</CancelReason>
</Row>
EXEC SubmitOrderAcknowledgementFeed OrderAcknowledgementFeedAggregate='<Row>
<AmazonOrderId>249-6070298-2783041</AmazonOrderId>
<StatusCode>Failure</StatusCode>
<AmazonOrderItemCode>25959136016214</AmazonOrderItemCode>
<CancelReason>NoInventory</CancelReason>
</Row>'
Input
Name | Type | Required | Description |
---|---|---|---|
AmazonOrderID | String | False | Amazon's unique identifier for an order, which identifies the entire order, regardless of the number of individual items in the order. |
MerchantOrderID | String | False | Optional seller-supplied order ID. Amazon will map the MerchantOrderID to the AmazonOrderID, and you can then use your own order ID (MerchantOrderID) for subsequent feeds relating to the order. |
StatusCode | String | False | Allows you to acknowledge your success or failure with downloading an order. StatusCode can be either Success or Failure. |
AmazonOrderItemCode | String | False | Amazon's unique identifier for an item in an order. |
MerchantOrderItemID | String | False | Optional seller-supplied ID for an item in an order. If the MerchantOrderItemID is specified with the AmazonOrderItemCode, Amazon will map the two IDs and you can then use your own order item ID for subsequent feeds relating to that order item. |
CancelReason | String | False | Used only when sending a StatusCode of Failure. |
ItemAggregate | String | False | An aggregate representing an order Item. Can be in the form of XML or a #TEMP table. Use this field when multiple items in the order need to be acknowledged. |
OrderAcknowledgementFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML, JSON or a #TEMP table. |
MarketplaceIds | String | True | Required. A list of one or more marketplace IDs for the marketplace that registered the listing account. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedId | String | A unique identifier for the feed. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitOrderAdjustmentFeed¶
The Order Adjustment feed allows you to issue a refund (adjustment) for an order. You must provide a reason for the adjustment, such as Customer Return, and the adjustment amount, broken down by price component (principle, shipping, tax, and so on).
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query :
INSERT INTO ItemPriceAdjustmentsAggregate#TEMP (ItemPriceAdjustmentsComponentType,ItemPriceAdjustmentsComponentAmount,ItemPriceAdjustmentsComponentAmountCurrency) VALUES ('Shipping','150','JPY')
INSERT INTO AdjustedItemAggregate#TEMP (AdjustedItemAmazonOrderItemCode,AdjustedItemAdjustmentReason,ItemPriceAdjustmentsAggregate) VALUES ('25959136016214','CustomerReturn','ItemPriceAdjustmentsAggregate#TEMP')
INSERT INTO OrderAdjustmentFeedAggregate#TEMP (AmazonOrderID,OperationType,AdjustedItemAggregate) VALUES ('249-6070298-2783041','Update','AdjustedItemAggregate#TEMP')
Then you execute the procedure by specifying the value of OrderAdjustmentFeedAggregate with the name of #TEMP table used OrderAdjustmentFeedAggregate#TEMP.
EXEC SubmitOrderAdjustmentFeed OrderAdjustmentFeedAggregate = 'OrderAdjustmentFeedAggregate#TEMP', marketplaceids = 'A1VC38T7YXB528'
Input
Name | Type | Required | Description |
---|---|---|---|
AmazonOrderID | String | False | Amazon's unique identifier for an order, which identifies the entire order regardless of the number of individual items in the order. |
OperationType | String | True | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
MerchantOrderID | String | False | Optional seller-supplied order ID. The first step is to establish the MerchantOrderID in the acknowledgment feed. Amazon will map the MerchantOrderID to the AmazonOrderID, and you can then use your own order ID (MerchantOrderID) for subsequent feeds relating to that order. See the base XSD for the definition. |
AdjustedItemQuantityCancelled | Integer | False | Quantity of items being canceled. Used only for partial cancellations. |
AdjustedItemAmazonOrderItemCode | String | False | Amazon's unique ID for an item in an order. |
AdjustedItemMerchantOrderItemID | String | False | Optional seller-supplied ID for an item in an order. It can be used in order processing if the pairing was established in the acknowledgment feed. |
AdjustedItemMerchantAdjustmentItemID | String | False | Optional seller-supplied unique ID for the adjustment (not used by Amazon). |
AdjustedItemAdjustmentReason | String | False | Reason for the adjustment. |
ItemPriceAdjustmentsComponentType | String | False | The Type of price adjustment for the item. Values include: Principal, Shipping, Tax, ShippingTax, RestockingFee, RestockingFeeTax, GiftWrap, GiftWrapTax, Surcharge, ReturnShipping, Goodwill, ExportCharge, COD, CODTax, Other, FreeReplacementReturnShipping |
ItemPriceAdjustmentsComponentAmount | Decimal | False | The Amount of the adjustment. |
ItemPriceAdjustmentsComponentAmountCurrency | String | False | The Currency for the Amount. |
ItemPriceAdjustmentsAggregate | String | False | An aggregate representing the Amount the buyer is to be refunded for the item. Can be in the form of XML, JSON, or a #TEMP table. Use this field if multiple item price adjustments need to be applied. |
PromotionAdjustmentsPromotionClaimCode | String | False | The ClaimCode for the Promotion Adjustment. |
PromotionAdjustmentsMerchantPromotionID | String | False | The Promotion ID for the Promotion Adjustment. |
PromotionAdjustmentsComponentType | String | False | The Type of price adjustment for the promotion. |
PromotionAdjustmentsComponentAmount | Decimal | False | The Amount of price adjustment for the promotion. |
PromotionAdjustmentsComponentAmountCurrency | String | False | The Currency for the Amount. |
PromotionAdjustmentsComponentAggregate | String | False | An aggregate representing the Amount the buyer is to be refunded for the promotion, broken down by type. Can be in the form of XML, JSON, or a #TEMP table. Use this field if multiple promotion price adjustments need to be applied. |
PromotionAdjustmentsAggregate | String | False | An aggregate representing the promotion. Child Elements include PromotionClaimCode, MerchantPromotionID, ComponentAggregate (Type, Amount and Amount@Currency). Use this field if multiple promotions need to be applied. |
AdjustedItemAggregate | String | False | An aggregate representing order adjustment information for a specific item. Can be in the form of XML, JSON, or a #TEMP table. Use this field if multiple items need adjusting in 1 order. |
OrderAdjustmentFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML, JSON or a #TEMP table. |
MarketplaceIds | String | True | Required. A list of one or more marketplace IDs for the marketplace that registered the listing account. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedId | String | A unique identifier for the feed. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitOrderFulfillmentFeed¶
The Order Fulfillment feed allows your system to update Amazon's system with order fulfillment information.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query:
INSERT INTO ItemAggregate#TEMP(ItemAmazonOrderItemCode,ItemQuantity) VALUES ('25959136016214','1');
INSERT INTO OrderFulfillmentFeedAggregate#TEMP (AmazonOrderID,FulfillmentDate,FulfillmentDataCarrierName,FulfillmentDataShippingMethod,FulfillmentDataShipperTrackingNumber,ItemAggregate) VALUES ('249-6070298-2783041','2017-02-01T00:00:00Z',' Delivery Company','Normal Delivery','1223525345234','ItemAggregate#TEMP')
Then you execute the procedure by specifying the value of OrderFulfillmentFeedAggregate with the name of #TEMP table used OrderFulfillmentFeedAggregate#TEMP.
EXEC SubmitOrderFulfillmentFeed OrderFulfillmentFeedAggregate = 'OrderFulfillmentFeedAggregate#TEMP', marketplaceids = 'A1VC38T7YXB528'
Input
Name | Type | Required | Description |
---|---|---|---|
AmazonOrderID | String | False | Amazon's unique identifier for an order, which identifies the entire order regardless of the number of individual items in the order. |
MerchantOrderID | String | False | Optional seller-supplied order ID. The first step is to establish the MerchantOrderID in the acknowledgment feed. Amazon will map the MerchantOrderID to the AmazonOrderID, and you can then use your own order ID (MerchantOrderID) for subsequent feeds relating to that order. See the base XSD for the definition. |
OperationType | String | True | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
MerchantFulfillmentID | Integer | False | Seller-supplied unique identifier for the shipment (not used by Amazon). |
FulfillmentDate | Datetime | False | The date the item was actually shipped or picked up, depending on the fulfillment method specified in the order. |
FulfillmentDataCarrierCode | String | False | The shipping carrier code. |
FulfillmentDataCarrierName | String | False | The shipping carrier name. |
FulfillmentDataShippingMethod | String | False | The shipping method used to deliver the item. |
FulfillmentDataShipperTrackingNumber | String | False | The tracking number for the shipment. |
CODCollectionMethod | String | False | Cash on delivery collection mode of an order. |
ItemAmazonOrderItemCode | String | False | Amazon's unique ID for an item in an order. |
ItemMerchantOrderItemID | String | False | The shipping Optional seller-supplied ID for an item in an order. |
ItemMerchantFulfillmentItemID | String | False | Seller-supplied unique identifier for an item in the shipment (not used by Amazon). |
ItemQuantity | Integer | False | The quantity of an item shipped. |
ItemAggregate | String | False | An aggregate representing order-fulfillment information for a specific item. Can be in the form of XML, JSON, or a #TEMP table. Use this field when multiple Items need to be included in the feed. |
FulfillmentDataAggregate | String | False | An aggregate representing order-fulfillment information for a specific item. Can be in the form of XML, JSON, or a #TEMP table. Use this field when multiple Items need to be included in the feed. |
OrderFulfillmentFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML, JSON, or a #TEMP table. |
MarketplaceIds | String | True | Required. A list of one or more marketplace IDs for the marketplace that registered the listing account. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedId | String | A unique identifier for the feed. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitOverrideFeed¶
The Override feed allows you to set an exception to your account-level shipping settings for an individual product (SKU).
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query :
INSERT INTO ShippingOverrideAggregate#TEMP (ShipOption,IsShippingRestricted) VALUES ('Std JP Kanto8','true')
INSERT INTO ShippingOverrideAggregate#TEMP (ShipOption,Type,ShipAmount,ShipAmountCurrency) VALUES ('Std JP Kantoa8','Exclusive','400.0','JPY')
INSERT INTO OverrideFeedAggregate#TEMP (SKU,OperationType,ShippingOverrideAggregate) VALUES ('15700','Update','ShippingOverrideAggregate#TEMP')
Then you execute the procedure by specifying the value of OverrideFeedAggregate with the name of #TEMP table used OverrideFeedAggregate#TEMP.
EXEC SubmitOverrideFeed OverrideFeedAggregate = 'OverrideFeedAggregate#TEMP', marketplaceids = 'A1VC38T7YXB528'
Input
Name | Type | Required | Description |
---|---|---|---|
SKU | String | True | Required. Used to identify an individual product. Each product must have a SKU, and each SKU must be unique. |
OperationType | String | True | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
ShipOption | String | False | Locale and shipping service. |
IsShippingRestricted | Boolean | False | Indicates whether the SKU can or cannot be shipped to the specified locale using the specified shipping service (ShipOption). |
Type | String | False | The type of override shipping charge (Additive or Exclusive) being applied to the SKU. |
ShipAmount | Decimal | False | The Additive or Exclusive shipping charge amount. |
ShipAmountCurrency | Decimal | False | The currency used for the ShipAmount. |
ShippingOverrideAggregate | String | False | An aggregate representing the the shipping override. Can be in the form of XML or a #TEMP table. Use this field if multiple Shipping Overrides are needed. |
OverrideFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML or a #TEMP table. |
MarketplaceIds | String | True | Required. A list of one or more marketplace IDs for the marketplace that registered the listing account. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedId | String | A unique identifier for the feed. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitPriceFeed¶
The Price feed allows you to set the current price and sale price (when applicable) for an item.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query :
INSERT INTO PriceFeedAggregate#TEMP (SKU,StandardPrice,StandardPriceCurrency,MAP,MAPCurrency,SalePrice,SalePriceCurrency,SaleStartDate,SaleEndDate) VALUES ('15700','134','JPY','100','JPY','150','JPY','2017-02-01T00:00:00Z','2020-02-01T00:00:00Z')
INSERT INTO PriceFeedAggregate#TEMP (SKU,StandardPrice,StandardPriceCurrency,MAP,MAPCurrency,SalePrice,SalePriceCurrency,SaleStartDate,SaleEndDate) VALUES ('99987867','134','JPY','100','JPY','150','JPY','2017-02-01T00:00:00Z','2020-02-01T00:00:00Z')
Then you execute the procedure by specifying the value of PriceFeedAggregate with the name of #TEMP table used PriceFeedAggregate#TEMP.
EXEC SubmitPriceFeed PriceFeedAggregate = 'PriceFeedAggregate#TEMP', marketplaceids = 'A1VC38T7YXB528'
Input
Name | Type | Required | Description |
---|---|---|---|
SKU | String | False | Required. Used to identify an individual product. Each product must have a SKU, and each SKU must be unique. |
OperationType | String | False | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
StandardPrice | Double | False | Required. Price of the item (non-sale price). |
StandardPriceCurrency | String | False | Required. The currency for the Standard Price. |
MAP | String | False | Minimum Advertised Price. Use only if dictated by the manufacturer. Both the standard and sale price (if applicable) must be higher than the MAP value. |
MAPCurrency | String | False | Minimum Advertised Price. Use only if dictated by the manufacturer. Both the standard and sale price (if applicable) must be higher than the MAP value. |
SalePrice | Double | False | The price of the sale. |
SalePriceCurrency | String | False | The currency of the sale. |
SaleStartDate | Datetime | False | The starting date of the sale. |
SaleEndDate | Datetime | False | The ending date of the sale. |
PriceFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML or a #TEMP table. |
MarketplaceIds | String | False | Required. A list of one or more marketplace IDs for the marketplace that registered the listing account. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedId | String | A unique identifier for the feed. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitProductFeed¶
The Product feed contains descriptive information about the products in your catalog. This information allows Amazon to build a record and assign a unique identifier known as an ASIN (Amazon Standard Item Number) to each product.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered.
SubmitProductFeed Has Two main aggregates that need to be entered.
- ProductDescriptionDataAggregate
- ProductDataAggregate
You must include in your query :
ProductDescriptionDataAggregate information needs to be entered using ProductDescriptionDataAggregate#TEMP temp table.
INSERT INTO ProductDescriptionDataAggregate#TEMP(Title,Brand,Description,BulletPoint,Manufacturer) VALUES ('test Title','test Brand','test Description','test BulletPoint','test Manufacturer')
ProductDataAggregate info varies by the Category used. The List of all XSD provided by amazon can be found here https://images-na.ssl-images-amazon.com/images/G/01/rainier/help/xsd/release_1_9/Product.xsd
This example will be using the Sports category https://images-na.ssl-images-amazon.com/images/G/01/rainier/help/xsd/release_1_9/Sports.xsd
To add a valid ProductData Sports.xsd must be followed thoroughly and the xml aggregate must be created correctly. This example has the following product Data
- ProductType = SportingGoods
- Parentage = Parent
- VariationTheme = Size (Based on the ProductType selected some of the VariationTheme will be invalid. In these example the Design variation is invalid.)
- Size = S
- MaterialComposition = Metal
By following the order of Sports.xsd XSD file the aggregate is :
<Sports>
<ProductType>SportingGoods</ProductType>
<VariationData>
<Parentage>parent</Parentage>
<VariationTheme>Size</VariationTheme>
<Size>S</Size>
</VariationData>
<MaterialComposition>Metal</MaterialComposition>
</Sports>
This Aggregate is the value of ProductDataAggregate.
INSERT INTO ProductFeedAggregate#TEMP(SKU,ProductDescriptionDataAggregate,ProductDataAggregate) VALUES ('test SKU','ProductDescriptionDataAggregate#TEMP','<Sports>
<ProductType>SportingGoods</ProductType>
<VariationData>
<Parentage>parent</Parentage>
<VariationTheme>Size</VariationTheme>
<Size>S</Size>
</VariationData>
<MaterialComposition>Metal</MaterialComposition>
</Sports>')
Then you execute the procedure by specifying the value of ProductFeedAggregate with the name of #TEMP table used ProductFeedAggregate#TEMP.
EXEC SubmitProductFeed ProductFeedAggregate = 'ProductFeedAggregate#TEMP', marketplaceids = 'A1VC38T7YXB528'
Input
Name | Type | Required | Description |
---|---|---|---|
SKU | String | True | Required. Used to identify an individual product. Each product must have a SKU, and each SKU must be unique. |
OperationType | String | True | Required. Used to specify the type of operation (Update, Delete or PartialUpdate) to be performed on the data. |
StandardProductID | String | False | A standard, unique identifier for a product, consisting of a type (ISBN, UPC, or EAN) and a value that conforms to the appropriate format for the type specified. This is a required field if Type is provided for StandardProductID in the base XSD. |
ProductTaxCode | String | False | Amazon's standard code to identify the tax properties for a product. |
LaunchDate | Datetime | False | Controls when the product appears from searches and browsing on the Amazon website. |
DiscontinueDate | Datetime | False | Controls when the product disappears from searches and browsing on the Amazon website. |
ReleaseDate | Datetime | False | The date a product is released for sale. |
Condition | String | False | The condition of the item. |
Rebate | String | False | The rebate of the product. |
ItemPackageQuantity | Integer | False | Number of the same product contained within one package. For example, if you are selling a case of 10 packages of socks, ItemPackageQuantity would be 10. |
NumberOfItems | Integer | False | Number of discrete items included in the product you are offering for sale, such that each item is not packaged for individual sale. For example, if you are selling a case of 10 packages of socks, and each package contains 3 pairs of socks, NumberOfItems would be 30. |
Title | String | True | Required. Short description of the product. |
Brand | String | False | Brand of the product. |
Designer | String | False | Designer of the product. |
Description | String | False | Long Description of the product. |
BulletPoint | String | False | Brief descriptions of the product's features. |
PackageDimensionsLength | String | False | Calculated dimensions of the package. |
PackageDimensionsWidth | String | False | Calculated dimensions of the package. |
PackageDimensionsHeight | String | False | Calculated dimensions of the package. |
PackageDimensionsWeight | String | False | Calculated dimensions of the package. |
ItemDimensionsLength | String | False | Calculated dimensions of the item. |
ItemDimensionsWidth | String | False | Calculated dimensions of the item. |
ItemDimensionsHeight | String | False | Calculated dimensions of the item. |
ItemDimensionsWeight | String | False | Calculated dimensions of the item. |
PackageWeight | String | False | Weight of the package. |
ShippingWeight | String | False | Weight of the product when packaged to ship. |
MerchantCatalogNumber | String | False | Seller's catalog number for the product, if different from the SKU. |
MSRP | Double | False | Manufacturer's suggested retail price. |
MaxOrderQuantity | Integer | False | Maximum quantity of the product that a customer can order. |
SerialNumberRequired | Boolean | False | Indicates whether the product must have a serial number. |
Prop65 | Boolean | False | Used if the product is subject to prop 65 regulations in California. US only. |
LegalDisclaimer | String | False | Any legal disclaimer needed for the product. |
Manufacturer | String | False | Maker of the product. |
MfrPartNumber | String | False | Part number provided by the original manufacturer. |
SearchTerms | String | False | Terms you submit that give product search results. |
PlatinumKeywords | String | False | Values used to map products to nodes in a custom browse structure. |
RecommendedBrowseNode | String | False | Value used to classify an item. |
Memorabilia | Boolean | False | Used if the product is a memorabilia item. |
Autographed | Boolean | False | Used if the product is an autographed item. |
UsedFor | String | False | What the product is used for (affects the product's placement in the Amazon browse structure). |
ItemType | String | False | Pre-defined value that specifies where the product should appear within the Amazon browse structure. |
OtherItemAttributes | String | False | Used to further classify the product within the Amazon browse structure. |
TargetAudience | String | False | Used to further classify the product within the Amazon browse structure. |
SubjectContent | String | False | Used to relate the product to a specific idea or concept for merchandising. |
IsGiftWrapAvailable | Boolean | False | Indicates whether gift wrapping is available for the product. |
IsGiftMessageAvailable | Boolean | False | Indicates whether gift messaging is available for the product. |
IsDiscontinuedByManufacturer | Boolean | False | Indicates that the manufacturer has stopped making the item. |
MaxAggregateShipQuantity | Integer | False | The maximum number of the same item that can be shipped in the same package. |
ProductDescriptionDataAggregate | String | False | Section containing category-specific information such as variations. Can be in the form of XML or a #TEMP table. |
ProductDataAggregate | String | False | Section containing category-specific information such as variations. Can be in the form of XML or a #TEMP table. |
ProductFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML, JSON or a #TEMP table. |
MarketplaceIds | String | True | Required. A list of one or more marketplace IDs for the marketplace that registered the listing account. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedId | String | A unique identifier for the feed. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitRelationshipFeed¶
The Relationship feed allows you to set up optional relationships between items in your catalog.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query:
INSERT INTO RelationAggregate#TEMP (Type,SKU) VALUES ('Variation','99987867')
INSERT INTO RelationAggregate#TEMP (Type,SKU) VALUES ('Variation','99987867')
INSERT INTO RelationshipFeedAggregate#TEMP (ParentSKU,RelationAggregate) VALUES ('15700','RelationAggregate#TEMP')
Then you execute the procedure by specifying the value of RelationshipFeedAggregate with the name of #TEMP table used RelationshipFeedAggregate#TEMP.
EXEC SubmitRelationshipFeed RelationshipFeedAggregate = 'RelationshipFeedAggregate#TEMP', marketplaceids = 'A1VC38T7YXB528'
Input
Name | Type | Required | Description |
---|---|---|---|
ParentSKU | String | False | Required. The master SKU for a product with variations. |
OperationType | String | False | Required. Used to specify the type of operation (Update or Delete) to be performed on the data. |
Type | String | False | Type of relationship; currently supported are Variation or Accessory. |
SKU | String | False | Used to identify an individual product, one (child) variation of the parent SKU. |
RelationAggregate | String | False | An aggregate representing the the relation. Can be in the form of XML, JSON or a #TEMP table. Use this field when applying multiple relations |
RelationshipFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML or #TEMP table. |
MarketplaceIds | String | False | Required. A list of one or more marketplace IDs for the marketplace that registered the listing account. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedId | String | A unique identifier for the feed. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitSourcingOnDemandFeed¶
Usage information for the operation SubmitSourcingOnDemandFeed.rsb.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query :
INSERT INTO OrderSourcingOnDemandFeedAggregate#TEMP (AmazonOrderID,SKU,EstimatedShipDate) VALUES ('250-4747727-9303810','15700','2018-12-08T00:00:00Z');
Then you execute the procedure by specifying the value of OrderSourcingOnDemandFeedAggregate with the name of #TEMP table used OrderSourcingOnDemandFeedAggregate#TEMP.
EXEC SubmitSourcingOnDemandFeed OrderSourcingOnDemandFeedAggregate = 'OrderSourcingOnDemandFeedAggregate#TEMP', marketplaceids = 'A1VC38T7YXB528'
Input
Name | Type | Required | Description |
---|---|---|---|
AmazonOrderID | String | False | Amazon Order ID. |
SKU | Datetime | True | Required. Used to identify an individual product. Each product must have a SKU, and each SKU must be unique. |
EstimatedShipDate | String | True | Required. Estimated ship date. |
OrderSourcingOnDemandFeedAggregate | String | False | An aggregate representing the feed. Can be in the form of XML or a #TEMP table. |
MarketplaceIds | String | True | Required. A list of one or more marketplace IDs for the marketplace that registered the listing account. |
Result Set Columns
Name | Type | Description |
---|---|---|
FeedId | String | A unique identifier for the feed. |
FeedType | String | The type of feed submitted. |
SubmittedDate | Datetime | The date and time when the feed was submitted. |
FeedProcessingStatus | String | The processing status of the feed submission. |
SubmitVendorOrderAcknowledgement¶
Submits acknowledgements for one purchase order.
Execute¶
The Driver Uses #TEMP tables as fields for aggregate information entered
You must include in your query information for both OrderAcknowledgement
and OrderItemAcknowledgement
.
First we create an OrderItemAcknowledgements temporary table for the OrderAcknowledgement number 1:
INSERT INTO itemAck1#temp(AcknowledgementCode, AcknowledgedAmount, AcknowledgedUnit, AcknowledgedUnitSize, ScheduledShipDate, ScheduledDeliveryDate, RejectionReason)
VALUES ('Accepted', 100, 'Cases', 10, '2022-02-02T12:00:00Z', '2022-02-10T15:00:00Z', 'TemporarilyUnavailable')
INSERT INTO itemAck1#temp(AcknowledgementCode, AcknowledgedAmount, AcknowledgedUnit, AcknowledgedUnitSize, ScheduledShipDate, ScheduledDeliveryDate, RejectionReason)
VALUES ('Accepted', 100, 'Cases', 20, '2022-03-02T12:00:00Z', '2022-03-10T15:00:00Z', 'InvalidProductIdentifier')
INSERT INTO itemAck1#temp(AcknowledgementCode, AcknowledgedAmount, AcknowledgedUnit, AcknowledgedUnitSize, ScheduledShipDate, ScheduledDeliveryDate, RejectionReason)
VALUES ('Rejected', 100, 'Cases', 30, '2022-04-02T12:00:00Z', '2022-04-10T15:00:00Z', 'ObsoleteProduct')
INSERT INTO itemAck1#temp(AcknowledgementCode, AcknowledgedAmount, AcknowledgedUnit, AcknowledgedUnitSize, ScheduledShipDate, ScheduledDeliveryDate, RejectionReason)
VALUES ('Rejected', 101, 'Cases', 30, '2022-04-02T12:00:00Z', '2022-04-10T15:00:00Z', 'ObsoleteProduct')
Then we create another OrderItemAcknowledgements temporary table for the OrderAcknowledgement number 2:
INSERT INTO itemAck2#temp(AcknowledgementCode, AcknowledgedAmount, AcknowledgedUnit, AcknowledgedUnitSize, ScheduledShipDate, ScheduledDeliveryDate, RejectionReason)
VALUES ('Accepted', 99, 'Cases', 9, '2022-09-09T12:00:00Z', '2022-08-8T15:00:00Z', 'ObsoleteProduct')
After that we have to create another temporary table referencing previously created temporary tables itemAck1#temp and itemAck2#temp
INSERT INTO orderAck#temp(ItemSequenceNumber, AmazonProductIdentifier, VendorProductIdentifier, OrderedAmount, OrderedUnit, OrderedUnitSize, NetCostCurrencyCode, NetCostAmount, ListPriceCurrencyCode, ListPriceAmount, DiscountMultiplier, ItemAcknowledgements)
VALUES ('seq1', 'id1', 'vendId1', 100, 'Cases', 2, 'ALL', 999, 'ALL', 999, 'discount_multiplier_123', 'itemAck1#temp')
INSERT INTO orderAck#temp(ItemSequenceNumber, AmazonProductIdentifier, VendorProductIdentifier, OrderedAmount, OrderedUnit, OrderedUnitSize, NetCostCurrencyCode, NetCostAmount, ListPriceCurrencyCode, ListPriceAmount, DiscountMultiplier, ItemAcknowledgements)
VALUES ('seq2', 'id2', 'vendId2', 200, 'Cases', 4, 'ALL', 992, 'ALL', 992, 'discount_multiplier_456', 'itemAck2#temp')
After we have created necessary temporary tables we can execute the stored procedure, as shown in the example below:
EXECUTE SubmitVendorOrderAcknowledgement
PurchaseOrderNumber = 'PurchaseOrderNumber1',
SellerPartyId = '123',
SellerTaxRegistrationType = 'VAT',
SellerTaxRegistrationNumber = '123456',
AcknowledgementDate = '2022-01-01T10:00:00.000',
Items = 'orderAck#temp';
OrderAcknowledgement
temporary table schema info:
Column Name | Type | Required | Description |
---|---|---|---|
ItemSequenceNumber | string | false | Line item sequence number for the item. |
AmazonProductIdentifier | string | false | Amazon Standard Identification Number (ASIN) of an item. |
VendorProductIdentifier | string | false | The vendor selected product identification of the item. Should be the same as was sent in the purchase order. |
OrderedAmount | integer | true | Ordered quantity. This value should not be zero. |
OrderedUnit | string | true | Unit of measure for the ordered quantity. |
OrderedUnitSize | integer | true | The case size, in the event that we ordered using cases. |
NetCostCurrencyCode | string | false | Three digit currency code in ISO 4217 format. |
NetCostAmount | string | false | A decimal number with no loss of precision. |
ListPriceCurrencyCode | string | false | Three digit currency code in ISO 4217 format. |
ListPriceAmount | string | false | A decimal number with no loss of precision. |
DiscountMultiplier | string | false | The discount multiplier that should be applied to the price if a vendor sells books with a list price. |
ItemAcknowledgements | string | true | This is used to indicate acknowledged quantity. Should be specified using a #temp table. |
OrderItemAcknowledgement
temporary table schema info:
Column Name | Type | Required | Description |
---|---|---|---|
AcknowledgementCode | string | true | This indicates the acknowledgement code. |
AcknowledgedAmount | integer | true | Ordered quantity. This value should not be zero. |
AcknowledgedUnit | string | true | Unit of measure for the ordered quantity. |
AcknowledgedUnitSize | integer | false | The case size, in the event that we ordered using cases. |
ScheduledShipDate | datetime | false | Estimated ship date per line item. Must be in ISO-8601 date/time format. |
ScheduledDeliveryDate | datetime | false | Estimated delivery date per line item. Must be in ISO-8601 date/time format. |
RejectionReason | string | false | Indicates the reason for rejection. |
Input
Name | Type | Required | Description |
---|---|---|---|
PurchaseOrderNumber | String | True | The purchase order number |
SellerPartyId | String | True | Assigned identification for the party. For example, warehouse code or vendor code. |
SellerTaxRegistrationNumber | String | False | Tax registration number for the entity. For example, VAT ID. |
SellerTaxRegistrationType | String | False | Tax registration type for the entity. The allowed values are VAT, GST. |
SellerAddressAddressLine1 | String | False | First line of the address. |
SellerAddressAddressLine2 | String | False | Additional address information, if required. |
SellerAddressAddressLine3 | String | False | Additional address information, if required. |
SellerAddressCity | String | False | The city where the person, business or institution is located. |
SellerAddressCountryCode | String | False | The two digit country code in ISO 3166-1 alpha-2 format. |
SellerAddressCounty | String | False | The county where person, business or institution is located. |
SellerAddressDistrict | String | False | The district where person, business or institution is located. |
SellerAddressName | String | False | The name of the address of the person, business or institution. |
SellerAddressPhone | String | False | The phone number of the person, business or institution located at that address. |
SellerAddressPostalCode | String | False | The postal code of that address. It contains a series of letters or digits or both. |
SellerAddressStateOrRegion | String | False | The state or region where person, business or institution is located. |
Items | String | True | An aggregate representation items. Can be in the form of #TEMP table. |
AcknowledgementDate | Datetime | False | The date and time when the purchase order is acknowledged, in ISO-8601 date/time format. |
Result Set Columns
Name | Type | Description |
---|---|---|
Success | String | |
TransactionId | String |
SubmitVendorShipmentConfirmations¶
Submits shipment confirmations for vendor orders.
Execute¶
The Driver uses #TEMP tables as fields for aggregate information entered.
Below is an example where the usage of all #TEMP tables is covered. The following stored procedure inputs take a temp table: SellingPartyAddress, ShipFromPartyAddress, ShipToPartyAddress, ShippedItems, Cartons, and Pallets. Furthermore, the Cartons and Pallets temp table schemas, have the following inputs that also take temp tables: CartonIdentifiers/PalletIdentifiers and Items.
First, create a ShipFromPartyAddress temporary table for the ShipFromPartyAddress input:
INSERT INTO ShipFromPartyAddress#TEMP (Name, AddressLine1, City, CountryCode) VALUES ('ABC electronics warehouse', 'DEF 1st street', 'Berlin', 'DE')
Then, create a ShippedItems temporary table for the ShippedItems input:
INSERT INTO ShippedItems#TEMP (ItemSequenceNumber, VendorProductIdentifier, ShippedQuantityAmount, ShippedQuantityUnit) VALUES ('001', '9782700001659', 100, 'Eaches')
The Cartons input has a more complex structure. Two of its inputs, CartonIdentifiers and Items need to be built from the CartonIdentifiers#TEMP and CartonItems#TEMP tables respectively:
INSERT INTO CartonIdentifiers#TEMP (ContainerIdentificationType, ContainerIdentificationNumber) VALUES ('SSCC', '00102234567666698888')
INSERT INTO CartonItems#TEMP (ItemReference, ShippedQuantityAmount, ShippedQuantityUnit, ShippedQuantityUnitSize) VALUES ('001', 25, 'Eaches', 1)
INSERT INTO Cartons#TEMP (CartonIdentifiers, CartonSequenceNumber, Items) VALUES ('CartonIdentifiers#TEMP', '001', 'CartonItems#TEMP')
Then, add another row to the Cartons input:
INSERT INTO CartonIdentifiers2#TEMP (ContainerIdentificationType, ContainerIdentificationNumber) VALUES ('SSCC', '00102234567666699999')
INSERT INTO CartonItems2#TEMP (ItemReference, ShippedQuantityAmount, ShippedQuantityUnit, ShippedQuantityUnitSize) VALUES ('002', 50, 'Eaches', 1)
INSERT INTO Cartons#TEMP (CartonIdentifiers, CartonSequenceNumber, Items) VALUES ('CartonIdentifiers2#TEMP', '002', 'CartonItems2#TEMP')
The Pallets input has a similar structure compared to the Cartons one:
INSERT INTO PalletIdentifiers#TEMP (ContainerIdentificationType, ContainerIdentificationNumber) VALUES ('SSCC', '00102234567898098745')
INSERT INTO Pallets#TEMP (PalletIdentifiers, Tier, Block, CartonCount, CartonReferenceNumbers) VALUES ('PalletIdentifiers#TEMP', 2, 2, 4, '001,002,003,004')
After the necessary temporary tables have been created, execute the stored procedure as shown in the example below:
EXECUTE SubmitVendorShipmentConfirmations
ShipmentIdentifier = '00050003',
ShipmentConfirmationType = 'Original',
ShipmentType = 'LessThanTruckLoad',
ShipmentConfirmationDate = '2022-08-07T19:56:45.632Z',
SellingPartyId = 'VENDORCODE',
ShipFromPartyId = 'VENDORWAREHOUSECODE',
ShipFromPartyAddress = 'ShipFromPartyAddress#TEMP',
ShipToPartyId = 'AMZWAREHOUSECODE',
ShippedItems = 'ShippedItems#TEMP',
Cartons = 'Cartons#TEMP',
Pallets = 'Pallets#TEMP';
ShipmentAddress temporary table schema info:
Column Name | Type | Required |
---|---|---|
Name | string | true |
AddressLine1 | string | true |
AddressLine2 | string | false |
AddressLine3 | string | false |
City | string | false |
County | string | false |
District | string | false |
StateOrRegion | string | false |
PostalCode | string | false |
CountryCode | string | true |
Phone | string | false |
ShippedItems temporary table schema info:
Column Name | Type | Required |
---|---|---|
ItemSequenceNumber | string | true |
AmazonProductIdentifier | string | false |
VendorProductIdentifier | string | false |
ShippedQuantityAmount | integer | true |
ShippedQuantityUnit | string | true |
ShippedQuantityUnitSize | integer | false |
PurchaseOrderNumber | string | false |
LotNumber | string | false |
ExpiryManufacturerDate | datetime | false |
ExpiryDate | datetime | false |
ExpiryAfterDurationUnit | string | false |
ExpiryAfterDurationValue | integer | false |
MaximumRetailPriceCurrencyCode | string | false |
MaximumRetailPriceAmount | string | false |
HandlingCode | string | false |
CartonIdentifiers/PalletIdentifiers temporary table schema info:
Column Name | Type | Required |
---|---|---|
ContainerIdentificationType | string | true |
ContainerIdentificationNumber | string | true |
CartonItems/PalletItems temporary table schema info:
Column Name | Type | Required |
---|---|---|
ItemReference | string | true |
ShippedQuantityAmount | integer | true |
ShippedQuantityUnit | string | true |
ShippedQuantityUnitSize | integer | false |
PurchaseOrderNumber | string | false |
LotNumber | string | false |
ExpiryManufacturerDate | datetime | false |
ExpiryDate | datetime | false |
ExpiryAfterDurationUnit | string | false |
ExpiryAfterDurationValue | integer | false |
MaximumRetailPriceCurrencyCode | string | false |
MaximumRetailPriceAmount | string | false |
HandlingCode | string | false |
Cartons temporary table schema info:
Column Name | Type | Required |
---|---|---|
CartonIdentifiers | string | false |
CartonSequenceNumber | string | true |
DimensionsLength | string | false |
DimensionsWidth | string | false |
DimensionsHeight | string | false |
DimensionsUnit | string | false |
WeightValue | string | false |
WeightUnit | string | false |
TrackingNumber | string | false |
Items | string | true |
Pallets temporary table schema info:
Column Name | Type | Required |
---|---|---|
PalletIdentifiers | string | true |
Tier | integer | false |
Block | integer | false |
DimensionsLength | string | false |
DimensionsWidth | string | false |
DimensionsHeight | string | false |
DimensionsUnit | string | false |
WeightValue | string | false |
WeightUnit | string | false |
CartonCount | integer | false |
CartonReferenceNumbers | string | false |
Items | string | false |
Input
Name | Type | Required | Description |
---|---|---|---|
ShipmentIdentifier | String | True | Unique shipment ID. |
ShipmentConfirmationType | String | True | Indicates if this shipment confirmation is the initial confirmation, or intended to replace an already posted shipment confirmation. The allowed values are Original, Replace. |
ShipmentType | String | False | The type of shipment. The allowed values are TruckLoad, LessThanTruckLoad, SmallParcel. |
ShipmentStructure | String | False | Shipment hierarchical structure. The allowed values are PalletizedAssortmentCase, LooseAssortmentCase, PalletOfItems, PalletizedStandardCase, LooseStandardCase, MasterPallet, MasterCase. |
TransportationDetailsCarrierScac | String | False | Code that identifies the carrier for the shipment. |
TransportationDetailsCarrierShipmentReferenceNumber | String | False | The field also known as PRO number is a unique number assigned by the carrier. |
TransportationDetailsTransportationMode | String | False | The mode of transportation for this shipment. The allowed values are Road, Air, Ocean. |
TransportationDetailsBillOfLadingNumber | String | False | Bill Of Lading (BOL) number is the unique number assigned by the vendor. |
AmazonReferenceNumber | String | False | The Amazon Reference Number is a unique identifier generated by Amazon for all Collect/WePay shipments. |
ShipmentConfirmationDate | Datetime | True | Date on which the shipment confirmation was submitted. |
ShippedDate | Datetime | False | The date and time of the departure of the shipment from the vendor's location. |
EstimatedDeliveryDate | Datetime | False | The date and time on which the shipment is expected to reach buyer's warehouse. |
SellingPartyId | String | True | Assigned identification for the selling party. |
SellingPartyAddress | String | False | Identification of the selling party by address. An aggregate representation of the address. Can be in the form of a #TEMP table. |
SellingPartyTaxRegistrationType | String | False | Tax registration type for the entity. The allowed values are VAT, GST. |
SellingPartyTaxRegistrationNumber | String | False | Tax registration number for the entity. For example, VAT ID. |
ShipFromPartyId | String | True | Assigned identification for the ship from party. |
ShipFromPartyAddress | String | False | Identification of the ship from party by address. An aggregate representation of the address. Can be in the form of a #TEMP table. |
ShipFromPartyTaxRegistrationType | String | False | Tax registration type for the entity. The allowed values are VAT, GST. |
ShipFromPartyTaxRegistrationNumber | String | False | Tax registration number for the entity. For example, VAT ID. |
ShipToPartyId | String | True | Assigned identification for the ship to party. |
ShipToPartyAddress | String | False | Identification of the ship to party by address. An aggregate representation of the address. Can be in the form of a #TEMP table. |
ShipToPartyTaxRegistrationType | String | False | Tax registration type for the entity. The allowed values are VAT, GST. |
ShipToPartyTaxRegistrationNumber | String | False | Tax registration number for the entity. For example, VAT ID. |
ShipmentMeasurements | String | False | JSON aggregate representation of the shipment measurement details. |
ImportDetails | String | False | JSON aggregate representation of the of the import details. |
ShippedItems | String | True | An aggregate representation of the items in this shipment. Can be in the form of a #TEMP table. |
Cartons | String | False | An aggregate representation of the cartons in this shipment. Can be in the form of a #TEMP table. |
Pallets | String | False | An aggregate representation of the pallets in this shipment. Can be in the form of a #TEMP table. |
Result Set Columns
Name | Type | Description |
---|---|---|
Success | String | |
TransactionId | String |
System Tables¶
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
Schema Tables¶
The following tables return database metadata for Amazon Marketplace:
- sys_catalogs: Lists the available databases.
- sys_schemas: Lists the available schemas.
- sys_tables: Lists the available tables and views.
- sys_tablecolumns: Describes the columns of the available tables and views.
- sys_procedures: Describes the available stored procedures.
- sys_procedureparameters: Describes stored procedure parameters.
- sys_keycolumns: Describes the primary and foreign keys.
- sys_indexes: Describes the available indexes.
Data Source Tables¶
The following tables return information about how to connect to and query the data source:
- sys_connection_props: Returns information on the available connection properties.
- sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.
Query Information Tables¶
The following table returns query statistics for data modification queries:
- sys_identity: Returns information about batch operations or single updates.
sys_catalogs¶
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
sys_schemas¶
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
sys_tables¶
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
sys_tablecolumns¶
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Orders table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Orders'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
sys_procedures¶
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
sys_procedureparameters¶
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SampleProcedure stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
sys_keycolumns¶
Describes the primary and foreign keys.
The following query retrieves the primary key for the Orders table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Orders'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
sys_foreignkeys¶
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
sys_indexes¶
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
sys_connection_props¶
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:amazonmarketplace:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Columns¶
Name | Type | Description |
---|---|---|
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
sys_sqlinfo¶
Describes the SELECT query processing that the connector can offload to the data source.
Collaborative Query Processing¶
When working with data sources that do not support SQL-92, you can query the sys_sqlinfo view to determine the query capabilities of the underlying APIs, expressed in SQL syntax. The connector offloads as much of the SELECT statement processing as possible to the server and then processes the rest of the query in memory.
Discovering the Data Source's SELECT Capabilities¶
Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
---|---|---|
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Whether COUNT function is supported. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Supported string functions. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES , NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES , NO |
DATASYNCVERSION | The Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The Data Sync category of this driver. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES , NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES , NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Columns¶
Name | Type | Description |
---|---|---|
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
sys_identity¶
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Columns¶
Name | Type | Description |
---|---|---|
Id | String | The database-generated ID returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
Advanced Configurations Properties¶
The advanced configurations 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. Click the links for further details.
Property | Description |
---|---|
Schema | The type of schema to use. |
AWSRegion | The hosting region for your Amazon Web Services. |
AWSAccessKeyId | The AWS AccessKey ID that you received when you registered for Amazon MWS. |
Marketplace | The Marketplace region that you are registered to sell in. |
MWSAuthToken | The authorization token that you received when you registered for Amazon MWS. |
SellerId | The Seller ID that you received when you registered for Amazon MWS. |
AWSRoleARN | The Amazon Resource Name of the role to use when authenticating. |
AppId | Application ID for Selling Partner app you created. |
AWSSessionToken | AWS Session Token for Selling Partner app you created. |
AWSAccessKey | Your AWS access key. |
AWSSecretKey | Your AWS secret key. |
SellingPartner | Specifies the type of Selling Partner. |
IncludeRestrictedData | Determinies if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII). |
UseSandbox | A boolean determining if the connection should be made to the Selling Partner sandbox account. |
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthAppStatus | Specifies whether the specified SellingPartner OAuth App is in Draft status or Published Status. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Property | Description |
---|---|
IncludeReports | Set this connection property to true to expose already created reports as views. |
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. |
Other | These hidden properties are used only in specific use cases. |
ProcedurePooling | Whether or not to get feed results after an execution of a stored procedure. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
ReportTypes | Set this connection property to one or more report types to filter reports. |
RowScanDepth | The maximum number of rows to scan to look for the columns datatype in a report. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
TypeDetectionScheme | Specifies how to determine the data types of columns when selecting from Reports. |
Authentication¶
This section provides a complete list of authentication properties you can configure.
Property | Description |
---|---|
Schema | The type of schema to use. |
AWSRegion | The hosting region for your Amazon Web Services. |
AWSAccessKeyId | The AWS AccessKey ID that you received when you registered for Amazon MWS. |
Marketplace | The Marketplace region that you are registered to sell in. |
MWSAuthToken | The authorization token that you received when you registered for Amazon MWS. |
SellerId | The Seller ID that you received when you registered for Amazon MWS. |
AWSRoleARN | The Amazon Resource Name of the role to use when authenticating. |
AppId | Application ID for Selling Partner app you created. |
AWSSessionToken | AWS Session Token for Selling Partner app you created. |
AWSAccessKey | Your AWS access key. |
AWSSecretKey | Your AWS secret key. |
SellingPartner | Specifies the type of Selling Partner. |
IncludeRestrictedData | Determinies if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII). |
UseSandbox | A boolean determining if the connection should be made to the Selling Partner sandbox account. |
Schema¶
The type of schema to use.
Possible Values¶
Marketplace
, SellingPartner
Data Type¶
string
Default Value¶
Marketplace
Remarks¶
The available schemas are Marketplace and SellingPartner.
AWSRegion¶
The hosting region for your Amazon Web Services.
Possible Values¶
OHIO
, NORTHERNVIRGINIA
, NORTHERNCALIFORNIA
, OREGON
, CAPETOWN
, HONGKONG
, MUMBAI
, OSAKA
, SEOUL
, SINGAPORE
, SYDNEY
, TOKYO
, CENTRAL
, BEIJING
, NINGXIA
, FRANKFURT
, IRELAND
, LONDON
, MILAN
, PARIS
, STOCKHOLM
, BAHRAIN
, SAOPAULO
, GOVCLOUDEAST
, GOVCLOUDWEST
Data Type¶
string
Default Value¶
NORTHERNVIRGINIA
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.
AWSAccessKeyId¶
The AWS AccessKey ID that you received when you registered for Amazon MWS.
Data Type¶
string
Default Value¶
""
Remarks¶
Use this connection property to override the embedded AWSAccessKeyId.
Marketplace¶
The Marketplace region that you are registered to sell in.
Possible Values¶
United States
, Canada
, Mexico
, Spain
, United Kingdom
, France
, Germany
, Italy
, Brazil
, India
, China
, Japan
, Australia
, Netherlands
Data Type¶
string
Default Value¶
United States
Remarks¶
Available regions are United States, Canada, Mexico, Spain, United Kingdom, France, Germany, Italy, Brazil, India, China, Japan, Netherlands and Australia.
MWSAuthToken¶
The authorization token that you received when you registered for Amazon MWS.
Data Type¶
string
Default Value¶
""
Remarks¶
The authorization token that you received when you registered for Amazon MWS.
SellerId¶
The Seller ID that you received when you registered for Amazon MWS.
Data Type¶
string
Default Value¶
""
Remarks¶
If Seller ID not specified, then the Merchant identifier is required to authenticate.
AWSRoleARN¶
The Amazon Resource Name of the role to use when authenticating.
Data Type¶
string
Default Value¶
""
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 Amazon Marketplace connector 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.
AppId¶
Application ID for Selling Partner app you created.
Data Type¶
string
Default Value¶
""
Remarks¶
Application ID for Selling Partner app you created.
AWSSessionToken¶
AWS Session Token for Selling Partner app you created.
Data Type¶
string
Default Value¶
""
Remarks¶
AWS Session Token can be obtained from AssumeRole request to AWS. AWSAccessKeyId and AWSSecretKey should also be provided when setting AWSSessionToken.
AWSAccessKey¶
Your AWS access key.
Data Type¶
string
Default Value¶
""
Remarks¶
This is the Access Key tied to the AWS user that is associated with the the OAuthClientId.
AWSSecretKey¶
Your AWS secret key.
Data Type¶
string
Default Value¶
""
Remarks¶
This is the Secret Key tied to the AWS user that is associated with the the OAuthClientId.
SellingPartner¶
Specifies the type of Selling Partner.
Possible Values¶
Seller
, Vendor
Data Type¶
string
Default Value¶
Seller
Remarks¶
Specifies the type of Selling Partner, which can be Seller or Vendor.
IncludeRestrictedData¶
Determinies if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII).
Data Type¶
bool
Default Value¶
false
Remarks¶
Determinies if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII)
UseSandbox¶
A boolean determining if the connection should be made to the Selling Partner sandbox account.
Data Type¶
bool
Default Value¶
false
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'.
OAuth¶
This section provides a complete list of OAuth properties you can configure.
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthAppStatus | Specifies whether the specified SellingPartner OAuth App is in Draft status or Published Status. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
InitiateOAuth¶
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Possible Values¶
OFF
, GETANDREFRESH
, REFRESH
Data Type¶
string
Default Value¶
OFF
Remarks¶
The following options are available:
OFF
: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.GETANDREFRESH
: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.REFRESH
: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthClientId¶
The client ID assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
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.
OAuthClientSecret¶
The client secret assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
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.
OAuthAccessToken¶
The access token for connecting using OAuth.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthAccessToken
property is used to connect using OAuth. The OAuthAccessToken
is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
OAuthSettingsLocation¶
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'
.
Data Type¶
string
Default Value¶
%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt
Remarks¶
When InitiateOAuth is set to GETANDREFRESH
or REFRESH
, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.
Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://'
followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props
system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.
The default location is "%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt" with %APPDATA%
set to the user's configuration directory. The default values are
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
where DSN is the name of the current DSN used in the open connection.
The following table lists the value of %APPDATA%
by OS:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Linux | ~/.config |
CallbackURL¶
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Data Type¶
string
Default Value¶
""
Remarks¶
During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.
OAuthAppStatus¶
Specifies whether the specified SellingPartner OAuth App is in Draft status or Published Status.
Possible Values¶
Published
, Draft
Data Type¶
string
Default Value¶
Published
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.
OAuthVerifier¶
The verifier code returned from the OAuth authorization URL.
Data Type¶
string
Default Value¶
""
Remarks¶
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
Note
For SellingPartner Schema, verifier code returned from OAuth authorization URL needs to be base64 decoded before using.
Authentication on Headless Machines¶
See to obtain the OAuthVerifier
value.
Set OAuthSettingsLocation along with OAuthVerifier
. When you connect, the connector exchanges the OAuthVerifier
for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier
from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
OAuthRefreshToken¶
The OAuth refresh token for the corresponding OAuth access token.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthRefreshToken
property is used to refresh the OAuthAccessToken when using OAuth authentication.
OAuthExpiresIn¶
The lifetime in seconds of the OAuth AccessToken.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
OAuthTokenTimestamp¶
The Unix epoch timestamp in milliseconds when the current Access Token was created.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
SSL¶
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLServerCert¶
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type¶
string
Default Value¶
""
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.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema¶
This section provides a complete list of schema properties you can configure.
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Location¶
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type¶
string
Default Value¶
%APPDATA%\AmazonMarketplace Data Provider\Schema
Remarks¶
The path to a directory which contains the schema files for the connector (.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%\AmazonMarketplace Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas¶
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables¶
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
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.
Views¶
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
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.
Miscellaneous¶
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
---|---|
IncludeReports | Set this connection property to true to expose already created reports as views. |
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. |
Other | These hidden properties are used only in specific use cases. |
ProcedurePooling | Whether or not to get feed results after an execution of a stored procedure. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
ReportTypes | Set this connection property to one or more report types to filter reports. |
RowScanDepth | The maximum number of rows to scan to look for the columns datatype in a report. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
TypeDetectionScheme | Specifies how to determine the data types of columns when selecting from Reports. |
IncludeReports¶
Set this connection property to true to expose already created reports as views.
Data Type¶
bool
Default Value¶
false
Remarks¶
Set this connection property to true to expose already created reports as views. When using 'Selling Partner' Schema, a view will be exposed for each report type specified in ReportTypes connection property. These views can then be queried by using 'DataStartTime' and 'DataEndTime' required parameters. The driver will automatically search for an existing report that matches the specified interval, and if not found a new report will be created. 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
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.
Data Type¶
int
Default Value¶
-1
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.
Other¶
These hidden properties are used only in specific use cases.
Data Type¶
string
Default Value¶
""
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¶
Property | Description |
---|---|
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
ProcedurePooling¶
Whether or not to get feed results after an execution of a stored procedure.
Data Type¶
bool
Default Value¶
true
Remarks¶
Set this to False if you do not want to wait to get the results of a stored procedure.
PseudoColumns¶
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type¶
string
Default Value¶
""
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, "*=*".
ReportTypes¶
Set this connection property to one or more report types to filter reports.
Data Type¶
string
Default Value¶
""
Remarks¶
Set this connection property to one or more comma-separated report types or categories to filter reports. This property decides which report types to expose as views when IncludeReports = True and Schema = SellingPartner. In order to include multiple reports, you can also specify a report type category, which can be retrieved from ReportTypes view.
RowScanDepth¶
The maximum number of rows to scan to look for the columns datatype in a report.
Data Type¶
int
Default Value¶
100
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.
Timeout¶
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type¶
int
Default Value¶
60
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 connector throws an exception.
TypeDetectionScheme¶
Specifies how to determine the data types of columns when selecting from Reports.
Possible Values¶
None
, RowScan
Data Type¶
string
Default Value¶
RowScan
Remarks¶
When IncludeReports is set to True, this property specifies how to determine the data types.
Property | Description |
---|---|
None | Setting TypeDetectionScheme to None will return all columns as the string type. |
RowScan | Setting TypeDetectionScheme to RowScan will scan rows to heuristically determine the data type. |