Amazon Selling Partner (SP-API) Connector for MS Access

In this article you will learn how to integrate Amazon Selling Partner (SP-API) data in MS Access without coding in just a few clicks (live / bi-directional connection to Amazon Selling Partner (SP-API)). Amazon Selling Partner Connector (SP-API) can be used to integrated SP-API that helps Amazon sellers to programmatically exchange data on listings, orders, payments, reports, and more..

Using Amazon Selling Partner (SP-API) Connector you will be able to connect, read, and write data from within MS Access. Follow the steps below to see how we would accomplish that.

Download Documentation

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Amazon Selling Partner (SP-API) using MS Access we first need to create a DSN (Data Source) which will access data from Amazon Selling Partner (SP-API). We will later be able to read data using MS Access. Perform these steps:

  1. Install ZappySys ODBC PowerPack.

  2. Open ODBC Data Sources (x64):
    Open ODBC Data Source

  3. Create a User Data Source (User DSN) based on ZappySys API Driver

    ZappySys API Driver
    Create new User DSN for ZappySys API Driver
    You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.
  4. When the Configuration window appears give your data source a name if you haven't done that already, then select "Amazon Selling Partner (SP-API)" from the list of Popular Connectors. If "Amazon Selling Partner (SP-API)" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

    AmazonSellingPartner(SP-ApI)DSN
    Amazon Selling Partner (SP-API)
    ODBC DSN Template Selection

  5. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    Steps to get Amazon Selling Partner (SP-API) Credentials : OAuth (Self Authorize - Private App) [OAuth]
    To call Amazon SP-API you need to register as Developer and create an App to obtain Client ID / Client Secret. After that authorize to get a Refresh Token. Perform the following steps (Detailed steps found in the each link described below)
    1. Go to Register as a Private App developer. You can wait for day or two to get approval. Check status this way
    2. Once your Developer account is approved. Login to your account and create a new app and obtain Client ID and Client Secret.
    3. In the very last step can click here to learn how to obtain Refresh Token (Self-Authorize).
    4. Copy Client ID, Client Secret and Refresh Token and paste on the Connector UI. Refresh Token field is found under the Grid on the Connector UI and Client ID and Client Secret found in the Grid.
    5. For Video Tutorial check this blog post

    Fill in all required parameters and set optional parameters if needed:

    AmazonSellingPartner(SP-ApI)DSN
    Amazon Selling Partner (SP-API)
    OAuth (Self Authorize - Private App) [OAuth]
    https://sellingpartnerapi-na.amazon.com
    Required Parameters
    Optional Parameters
    ClientId Fill in the parameter...
    ClientSecret Fill in the parameter...
    TokenUrl Fill in the parameter...
    TokenUIMode Fill in the parameter...
    AuthUrl (Do not Use for Private App - Self Authorization) Fill in the parameter...
    OrdersApiVersion Fill in the parameter...
    SellerApiVersion Fill in the parameter...
    ShippingApiVersion Fill in the parameter...
    ServicesApiVersion Fill in the parameter...
    FbaApiVersion Fill in the parameter...
    SalesApiVersion Fill in the parameter...
    ReportsApiVersion Fill in the parameter...
    ProductsFeesApiVersion Fill in the parameter...
    ProductPricingApiVersion Fill in the parameter...
    CatalogItemsApiVersion Fill in the parameter...
    VendorOrdersApiVersion Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ODBC DSN Oauth Connection Configuration

  6. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
    ODBC ZappySys Data Source Preview

  7. Click OK to finish creating the data source.

Video instructions

Read data in Microsoft Access from the ODBC data source

  1. First of all, open MS Access and create a new MS Access database.

  2. In the next step, start loading ODBC data source we created: Load ODBC data source

  3. Then click next until data source selection window appears. Select the data source we created in one of the previous steps and hit OK:

    AmazonSellingPartner(SP-ApI)DSN
    DSN selection

  4. Continue with tables and views selection. You can extract multiple tables or views:
    DSN Table Selection

  5. Finally, wait while data is being loaded and once done you should see a similar view: In Access DSN Data Loaded

Using Linked Table for Live Data (Slow)

Linked tables in Microsoft Access are crucial for online databases because they enable real-time access to centralized data, support scalability, facilitate collaboration, enhance data security, ease maintenance tasks, and allow integration with external systems. They provide a flexible and efficient way to work with data stored in online databases, promoting cross-platform compatibility and reducing the need for data duplication.

  1. Real-Time Data Access:
    Access can interact directly with live data in online databases, ensuring that users always work with the most up-to-date information.
  2. Centralized Data Management:
    Online databases serve as a centralized repository, enabling efficient management of data from various locations.
  3. Ease of Maintenance:
    Updates or modifications to the online database structure are automatically reflected in Access, streamlining maintenance tasks.
  4. Adaptability to Changing Requirements:
    Linked tables provide flexibility, allowing easy adaptation to changing data storage needs or migration to different online database systems.

Let's create the linked table.

  1. Launch Microsoft Access and open the database where you want to create the linked table.

  2. Go to the "External Data" tab on the Ribbon. >> "New Data Source" >> "From Other Sources" >> "ODBC Database" Load ODBC data source

  3. Select the option "Link to Data Source by creating a linked table: Load ODBC data source

  4. Continue by clicking 'Next' until the Data Source Selection window appears. Navigate to the Machine Data Source tab and select the desired data source established in one of the earlier steps. Click 'OK' to confirm your selection.

    AmazonSellingPartner(SP-ApI)DSN
    DSN selection

  5. Proceed to the selection of Tables and Views. You have the option to extract multiple tables or views:
    DSN Table Selection

  6. When prompted to select Unique Key column DO NOT select any column(s) and just click OK: MS Access Linked Table - Key selection

  7. Finally, Simply double-click the newly created Linked Table to load the data: MS Access Linked Table

Guide to Effectively Addressing Known Issues

Discover effective strategies to address known issues efficiently in this guide. Get solutions and practical tips to streamline troubleshooting and enhance system performance, ensuring a smoother user experience.

Fewer Rows Imported

The reason for this is that MS Access has a default query timeout of 60 seconds, which means it stops fetching data if the query takes longer than that. As a result, only a limited number of rows are fetched within this time frame.

To address this, we can adjust the Query Timeout by following the steps below.
WOW6432NodeODBCQueryTimeout

The path may vary depending on the MS Access bitness, such as 32-bit versus 64-bit.

\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Jet\4.0\Engines\ODBC
\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Jet\4.0\Engines\ODBC
\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\ClickToRun\REGISTRY\MACHINE\Software\Microsoft\Office\16.0\Access Connectivity Engine\Engines\ODBC

We can identify this issue by examining the Fiddler Log, as MS Access doesn't display any error regarding partial import, which is quite unusual

Please refer to this link : How to use Fiddler to analyze HTTP web requests
fiddlerlogs

#Deleted word appears for column value in MS Access for Linked Table mode

If you used Linked Table mode to get external data and it shows #deleted word rather than actual value for column after you open then most likely its following issue.

Make sure to re-create Linked Table and DO NOT select any key column when prompted (Just click OK) MS Access Linked Table Mode - #Deleted Error
How to Fix
MS Access Linked Table Mode - Do not select Key column

Table Selection UI Opening Delays

The Table selection UI takes a significant amount of time to open after clicking the 'New Data Source' -> 'Other Data Sources' -> 'ODBC'

The reason for this issue is that MS Access sends a dummy query, leading to several unnecessary pagination cycles before an error is thrown. To mitigate this, we can prevent wasted cycles by configuring the 'Throw error if no match' setting on the Filter Options Tab.
Throw error if no match

Enhancing Performance through Metadata Addition (Reduces Query Time)

We can optimize query performance by creating Virtual Tables (i.e. views with custom SQL) on Datasource and incorporating META=static columns. Learn how to capture static metadata in this guide.
Performance Options - Generate Metadata Manually

Execute the query initially, save the metadata by selecting 'Save to Meta' (choose Compact Format), and then click 'Save to Clipboard.' Utilize the resulting list by pasting it into the META attribute as follows: 'META=paste here.'
Generate Metadata in ZappySys ODBC Drivers

SELECT * FROM products
    WITH(
        META='id:String(20); title:String(100);  description:String(500);'
    )

Optimize Workflow with Automated Import

Employ Automated Import when Linked Tables are not feasible, and we need to depend on Imported Tables with static data.

While using Linked Tables sometime it encounter errors, and we are left with no alternative but to utilize Imported Tables, Automatic Refresh becomes crucial in such scenarios.

Here's a guide on automating refreshes. We can set up automatic refresh on different events, such as when the database opens, a form is opened, or a button is clicked.

To initiate the import process, follow these steps:

  • Perform the data import using the standard manual steps.
  • In the final step, we'll encounter a checkbox labeled 'Save Import Steps.' Ensure to check this option.
  • After saving the steps, we can locate their name in the Save Imports UI. Identify the name associated with the saved steps.
  • "Now, we can execute the code as shown below:"
Private Sub cmdYes_Click()
    Label0.Visible = True
    DoCmd.RunSavedImportExport "Import-DATA.products"
    Label0.Visible = False
End Sub

Advanced topics

Create Custom Stored Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
    Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
        @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
     AS
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';
    

    ZappySys Driver - Create Custom Stored Procedure

  4. That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01';

    ZappySys Driver - Execute Custom Stored Procedure

  5. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
      "ShipCountry",
      "OrderID",
      "CustomerID",
      "EmployeeID",
      "OrderDate",
      "RequiredDate",
      "ShippedDate",
      "ShipVia",
      "Freight",
      "ShipName",
      "ShipAddress",
      "ShipCity",
      "ShipRegion",
      "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table

  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"

    ZappySys Driver - Execute Custom Virtual Table Query

  6. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Actions supported by Amazon Selling Partner (SP-API) Connector

Amazon Selling Partner (SP-API) Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 Download Report File to Local Disk
   [Read more...]
Parameter Description
ReportType
 Get Report Data - Tab Separated File (TSV)
   [Read more...]
Parameter Description
ReportType
 Get Report Data - Comma Separated File (CSV)
   [Read more...]
Parameter Description
ReportType
 Get Report Data - XML File
   [Read more...]
Parameter Description
ReportType
Filter for XML File
Option Value
Example1 $.Result.Node[*]
Example2 $.SomeNode.SomeArray[?(@SomeProperty='ABCD')]
 Get Report Data - JSON File
   [Read more...]
Parameter Description
ReportType
Filter for JSON File
 Get Report Options
   [Read more...]
 Get Report Filters
   [Read more...]
 Get FBA Inventory Summaries (Fulfilled By Amazon)
Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters.    [Read more...]
Parameter Description
MarketplaceIds
Option Value
United States of America ATVPDKIKX0DER
Brazil A2Q3Y263D00KWC
Canada A2EUQ1WTGCTBG2
Mexico A1AM78C64UM0Y8
Spain A1RKKUPIHCS9HS
United Kingdom A1F83G8C2ARO7P
France A13V1IB3VIYZZH
Belgium AMEN7PMS3EDWL
Netherlands A1805IZSGTT6HS
Germany A1PA6795UKMFR9
Italy APJ6JRA9NG5V4
Sweden A2NODRKZP88ZB9
South Africa AE08WJ6YKNBMC
Poland A1C3SOZRARQ6R3
Egypt ARBP9OOSHTCHU
Turkey A33AVAJ2PDY3EV
Saudi Arabia A17E79C6D8DWNP
United Arab Emirates (U.A.E.) A2VIGQ35RCS4UG
India A21TJRUUN4KGV
Singapore A19VAU5U5O7RUS
Australia A39IBJ37TRP1C6
Japan A1VC38T7YXB528
Include details true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value false).
Option Value
true true
false false
Granularity Type The granularity type for the inventory aggregation level.
Option Value
Marketplace Marketplace
Granularity Id The granularity ID for the inventory aggregation level (e.g. MarketPlaceId if granularityType is MarketPlace ID).
Option Value
United States of America ATVPDKIKX0DER
Brazil A2Q3Y263D00KWC
Canada A2EUQ1WTGCTBG2
Mexico A1AM78C64UM0Y8
Spain A1RKKUPIHCS9HS
United Kingdom A1F83G8C2ARO7P
France A13V1IB3VIYZZH
Belgium AMEN7PMS3EDWL
Netherlands A1805IZSGTT6HS
Germany A1PA6795UKMFR9
Italy APJ6JRA9NG5V4
Sweden A2NODRKZP88ZB9
South Africa AE08WJ6YKNBMC
Poland A1C3SOZRARQ6R3
Egypt ARBP9OOSHTCHU
Turkey A33AVAJ2PDY3EV
Saudi Arabia A17E79C6D8DWNP
United Arab Emirates (U.A.E.) A2VIGQ35RCS4UG
India A21TJRUUN4KGV
Singapore A19VAU5U5O7RUS
Australia A39IBJ37TRP1C6
Japan A1VC38T7YXB528
Start Date A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected. You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
SellerSku (Single) A single seller SKU used for querying the specified seller SKU inventory summaries.
SellerSkus (Multiple) A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
 Search Catalog Items
Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.    [Read more...]
Parameter Description
MarketplaceIds
Option Value
United States of America ATVPDKIKX0DER
Brazil A2Q3Y263D00KWC
Canada A2EUQ1WTGCTBG2
Mexico A1AM78C64UM0Y8
Spain A1RKKUPIHCS9HS
United Kingdom A1F83G8C2ARO7P
France A13V1IB3VIYZZH
Belgium AMEN7PMS3EDWL
Netherlands A1805IZSGTT6HS
Germany A1PA6795UKMFR9
Italy APJ6JRA9NG5V4
Sweden A2NODRKZP88ZB9
South Africa AE08WJ6YKNBMC
Poland A1C3SOZRARQ6R3
Egypt ARBP9OOSHTCHU
Turkey A33AVAJ2PDY3EV
Saudi Arabia A17E79C6D8DWNP
United Arab Emirates (U.A.E.) A2VIGQ35RCS4UG
India A21TJRUUN4KGV
Singapore A19VAU5U5O7RUS
Australia A39IBJ37TRP1C6
Japan A1VC38T7YXB528
Identifiers (comma-delimited list) A comma-delimited list of product identifiers to search the Amazon catalog for. Note: Cannot be used with keywords.
IdentifiersType Type of product identifiers to search the Amazon catalog for. Note: Required when identifiers are provided.
Option Value
ASIN (Amazon Standard Identification Number) ASIN
EAN (European Article Number) EAN
GTIN (Global Trade Item Number) GTIN
ISBN (International Standard Book Number) ISBN
JAN (Japanese Article Number) JAN
MINSAN (Minsan Code) MINSAN
SKU (Stock Keeping Unit - must be used with sellerId) SKU
UPC (Universal Product Code) UPC
IncludedData A comma-delimited list of data sets to include in the response. Default: summaries.
Option Value
attributes attributes
classifications classifications
dimensions dimensions
identifiers identifiers
images images
productTypes productTypes
relationships relationships
salesRanks salesRanks
summaries summaries
Filter
Option Value
$.items[*] $.items[*]
$.items[*].summaries[*] $.items[*].summaries[*]
$.items[*].images[*].images[*] $.items[*].images[*].images[*]
$.items[*].attributes[*] $.items[*].attributes[*]
$.items[*].classifications[*].classifications[*] $.items[*].classifications[*].classifications[*]
$.items[*].identifiers[*].identifiers[*] $.items[*].identifiers[*].identifiers[*]
$.items[*].productTypes[*] $.items[*].productTypes[*]
$.items[*].salesRanks[*] $.items[*].salesRanks[*]
$.items[*].relationships[*].relationships[*] $.items[*].relationships[*].relationships[*]
$.items[*].dimensions[*] $.items[*].dimensions[*]
$.refinements[*].brands[*] $.refinements[*].brands[*]
$.refinements[*].classifications[*] $.refinements[*].classifications[*]
Locale Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
SellerId A selling partner identifier, such as a seller account or vendor code. Note: Required when identifiersType is SKU.
Keywords (comma-delimited list) A comma-delimited list of words to search the Amazon catalog for. Note: Cannot be used with identifiers.
BrandNames (comma-delimited list) A comma-delimited list of brand names to limit the search for keywords-based queries. Note: Cannot be used with identifiers
Classification Ids (comma-delimited list) A comma-delimited list of classification identifiers to limit the search for keywords-based queries. Note: Cannot be used with identifiers.
KeywordsLocale The language of the keywords provided for keywords-based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers.
 Get Report Types
   [Read more...]
Parameter Description
Filter
Option Value
All Reports $.data[*]
Tab-delimited / Flat File Reports $.data[?(@format=='TSV')]
Comma-delimited Reports $.data[?(@format=='CSV')]
XML Reports $.data[?(@format=='XML')]
PDF Reports $.data[?(@format=='PDF')]
Excel (XLSX) Reports $.data[?(@format=='XLSX')]
 Get Market Place Participations
   [Read more...]
 Get Vendor PurchaseOrders
Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the createdAfter, createdBefore, changedAfter and changedBefore parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting includeDetails to false. You can then use the getPurchaseOrder operation to receive details for a specific purchase order.    [Read more...]
Parameter Description
CreatedAfter Purchase orders that became available after this time will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02). If LastUpdatedAfter is not specified. Specifying both CreatedAfter and LastUpdatedAfter returns an error. You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
CreatedBefore Purchase orders that became available before this time will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02) You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
ChangedAfter Purchase orders that changed after this timestamp will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02). If CreatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.If LastUpdatedAfter is specified, then BuyerEmail and SellerOrderId cannot be specified. You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
ChangedBefore Purchase orders that changed before this timestamp will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02) You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
IncludeDetails When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
Option Value
true true
false false
SortOrder Sort in ascending or descending order by purchase order creation date.
Option Value
ASC ASC
DESC DESC
PoItemState Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.
Option Value
ACCEPTED ACCEPTED
PARTIALLY_ACCEPTED PARTIALLY_ACCEPTED
REJECTED REJECTED
UNCONFIRMED UNCONFIRMED
IsPOChanged When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.
Option Value
true true
false false
PurchaseOrderState Filters purchase orders based on the purchase order state.
Option Value
New New
Acknowledged Acknowledged
Closed Closed
OrderingVendorCode Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned.
 Get Vendor PurchaseOrder Items
Returns a list of purchase order items created or changed during the time frame that you specify. You define the time frame using the createdAfter, createdBefore, changedAfter and changedBefore parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting includeDetails to false. You can then use the getPurchaseOrder operation to receive details for a specific purchase order.    [Read more...]
Parameter Description
CreatedAfter Purchase orders that became available after this time will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02). If LastUpdatedAfter is not specified. Specifying both CreatedAfter and LastUpdatedAfter returns an error. You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
CreatedBefore Purchase orders that became available before this time will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02) You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
ChangedAfter Purchase orders that changed after this timestamp will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02). If CreatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.If LastUpdatedAfter is specified, then BuyerEmail and SellerOrderId cannot be specified. You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
ChangedBefore Purchase orders that changed before this timestamp will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02) You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
IncludeDetails When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
Option Value
true true
false false
SortOrder Sort in ascending or descending order by purchase order creation date.
Option Value
ASC ASC
DESC DESC
PoItemState Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.
Option Value
ACCEPTED ACCEPTED
PARTIALLY_ACCEPTED PARTIALLY_ACCEPTED
REJECTED REJECTED
UNCONFIRMED UNCONFIRMED
IsPOChanged When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.
Option Value
true true
false false
PurchaseOrderState Filters purchase orders based on the purchase order state.
Option Value
New New
Acknowledged Acknowledged
Closed Closed
OrderingVendorCode Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned.
 Get Orders
Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria.    [Read more...]
 Get Order (Single)
Returns the order information for a specified OrderId    [Read more...]
Parameter Description
AmazonOrderId Filters purchase orders based on the specified orderid.
 Get Order Items (For Single Order)
Returns the order items information for a specified OrderId    [Read more...]
Parameter Description
AmazonOrderId Filters purchase orders based on the specified orderid.
 Get Orders Items (For All Orders **Slow**)
Returns the order items information for a specified order search criterial (All orders by Create/Update date, status etc)    [Read more...]
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Amazon Selling Partner (SP-API) Connector Examples for MS Access Connection

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Read Orders    [Read more...]

Read orders with search criteria such as CreatedAfter, CreatedBefore, MarketPlaceIds, OrderStatuses, PaymentType and many more

SELECT * FROM Orders
--WHERE AmazonOrderId='902-1845936-5435065'		
WITH(
	  CreatedAfter='1900-01-01T00:00:00'
--	, CreatedBefore='1900-01-01T00:00:00'
--	, LastUpdatedAfter='1900-01-01T00:00:00'
--	, LastUpdatedBefore='1900-01-01T00:00:00'
--	, OrderStatuses='Pending~Unshipped~PartiallyShipped~PendingAvailability~Shipped~Canceled~Unfulfillable'
--	, MarketplaceIds='ATVPDKIKX0DER~A2Q3Y263D00KWC~A2EUQ1WTGCTBG2'
--	, FulfillmentChannels='AFN~MFN'
--	, PaymentMethods='COD~CVS~Other'
--	, AmazonOrderIds='1111111,222222,333333'
)
--CONNECTION(
--	ServiceUrl='https://sellingpartnerapi-na.amazon.com'
--)

Read Single Order    [Read more...]

Read single order by orderid

SELECT * FROM Orders 
Where AmazonOrderId='902-1845936-5435065'
--CONNECTION(
--	ServiceUrl='https://sellingpartnerapi-na.amazon.com'
--)

Read Order Items (For Single Order)    [Read more...]

Read order items for a specified orderid

SELECT * FROM get_order_items 
WITH(
	AmazonOrderId ='902-1845936-5435065'
)
--CONNECTION(
--	ServiceUrl='https://sellingpartnerapi-na.amazon.com'
--)

Read Order Items (For All Orders - Slow)    [Read more...]

Read order items with search criteria on orders such as CreatedAfter, CreatedBefore, MarketPlaceIds, OrderStatuses, PaymentType and many more. This is slow way of pulling all items for all orders without reading one by one order.

SELECT * FROM OrderItems
WITH(
	  CreatedAfter='1900-01-01T00:00:00'
--	, CreatedBefore='1900-01-01T00:00:00'
--	, LastUpdatedAfter='1900-01-01T00:00:00'
--	, LastUpdatedBefore='1900-01-01T00:00:00'
--	, OrderStatuses='Pending~Unshipped~PartiallyShipped~PendingAvailability~Shipped~Canceled~Unfulfillable'
--	, MarketplaceIds='ATVPDKIKX0DER~A2Q3Y263D00KWC~A2EUQ1WTGCTBG2'
--	, FulfillmentChannels='AFN~MFN'
--	, PaymentMethods='COD~CVS~Other'
--	, AmazonOrderIds='1111111,222222,333333'
)
--CONNECTION(
--	ServiceUrl='https://sellingpartnerapi-na.amazon.com'
--)

Sandbox - Read Orders (Fake data for testing)    [Read more...]

Read orders which has fake values (sandbox data)

SELECT *
FROM Orders
--DONOT try WHERE AmazonOrderId='TEST_CASE_200' (WHERE clause) for sandbox endpoint, it will return empty row. If you try in Live API then should work. 
WITH(
	  CreatedAfter='TEST_CASE_200' 
	  --CreatedAfter='TEST_CASE_200_NEXT_TOKEN'
	, MarketplaceIds='ATVPDKIKX0DER'
)
CONNECTION(
	ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)

Sandbox - Read Single Order (Fake data for testing)    [Read more...]

Read single order with orderid which has fake values (sandbox data)

SELECT *
FROM get_order
--DONOT try WHERE AmazonOrderId='TEST_CASE_200' (WHERE clause) for sandbox endpoint, it will return empty row. If you try in Live API then should work. 
WITH(
	AmazonOrderId='TEST_CASE_200'
--  AmazonOrderId='TEST_CASE_IBA_200'	
)
CONNECTION(
	ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)

Sandbox - Read Order Items (Fake data for testing)    [Read more...]

Read order items with orderid which has fake values (sandbox data)

SELECT *
FROM get_order_items
--DONOT try WHERE AmazonOrderId='TEST_CASE_200' (WHERE clause) for sandbox endpoint, it will return empty row. If you try in Live API then should work. 
WITH(
	AmazonOrderId='TEST_CASE_200'
--  AmazonOrderId='TEST_CASE_IBA_200'	
)
CONNECTION(
	ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)

Generic Request - Read Any API Endpoint    [Read more...]

Read any API endpoint using generic request endpoint

SELECT *
FROM generic_request
WITH(
	  URL='/orders/v0/orders/TEST_CASE_200/orderItems' 
	, Filter='$.payload.OrderItems[*]'
	, IncludeParentColumns=1
--	, RequestMethod='GET'
--	, Body=''
--	, IsMultiPart=0
--	, RequestContentTypeCode"='Default'
--	, ResponseFormat='Default' --Json, Csv, Xml
--	, Headers='Accept: */* || Cache-Control: no-cache'
--	, PagingMode"=''
--	, PagingByUrlAttributeName=''
--	, PagingIncrementBy='1'
--	, NextUrlAttributeOrExpr=''
--	, NextUrlWaitInMs='0'
--	, ColumnDelimiter=','
--	, HasColumnHeaderRow='True'
--	, ElementsToTreatAsArray=''	
	
)
CONNECTION(
	ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)

Get Report Types    [Read more...]

Lists report types which you can use for download_report / get_report_tsv / get_report_csv or get_report_xml endpoints

SELECT * FROM ReportTypes)

Download Report to Local Disk    [Read more...]

This example shows how to run a report and download data to local disk file. You can save any file format report by calling this endpoint.

SELECT * FROM download_report
WITH(
	  ReportType='GET_XML_BROWSE_TREE_DATA'
	, TargetFilePath='c:\temp\GET_XML_BROWSE_TREE_DATA.gz'
	, MarketplaceIds='ATVPDKIKX0DER'
  --, FileOverwriteMode='FailIfExists' (Default is 'AlwaysOverwrite')
  --, StartDate='2012-12-31'	
  --, EndDate='today-1d'  
)

Generate Report    [Read more...]

This example shows how to get data from a specified report

SELECT *
FROM get_report_tsv
WITH(
	  ReportType='GET_MERCHANT_LISTINGS_ALL_DATA'
	, MarketplaceIds='ATVPDKIKX0DER'
)

Conclusion

In this article we discussed how to connect to Amazon Selling Partner (SP-API) in MS Access and integrate data without any coding. Click here to Download Amazon Selling Partner (SP-API) Connector for MS Access and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download Amazon Selling Partner (SP-API) Connector for MS Access Documentation 

More integrations

Other application integration scenarios for Amazon Selling Partner (SP-API)

Other connectors for MS Access


Download Amazon Selling Partner (SP-API) Connector for MS Access Documentation

  • How to connect Amazon Selling Partner (SP-API) in MS Access?

  • How to get Amazon Selling Partner (SP-API) data in MS Access?

  • How to read Amazon Selling Partner (SP-API) data in MS Access?

  • How to load Amazon Selling Partner (SP-API) data in MS Access?

  • How to import Amazon Selling Partner (SP-API) data in MS Access?

  • How to pull Amazon Selling Partner (SP-API) data in MS Access?

  • How to push data to Amazon Selling Partner (SP-API) in MS Access?

  • How to write data to Amazon Selling Partner (SP-API) in MS Access?

  • How to POST data to Amazon Selling Partner (SP-API) in MS Access?

  • Call Amazon Selling Partner (SP-API) API in MS Access

  • Consume Amazon Selling Partner (SP-API) API in MS Access

  • Amazon Selling Partner (SP-API) MS Access Automate

  • Amazon Selling Partner (SP-API) MS Access Integration

  • Integration Amazon Selling Partner (SP-API) in MS Access

  • Consume real-time Amazon Selling Partner (SP-API) data in MS Access

  • Consume real-time Amazon Selling Partner (SP-API) API data in MS Access

  • Amazon Selling Partner (SP-API) ODBC Driver | ODBC Driver for Amazon Selling Partner (SP-API) | ODBC Amazon Selling Partner (SP-API) Driver | SSIS Amazon Selling Partner (SP-API) Source | SSIS Amazon Selling Partner (SP-API) Destination

  • Connect Amazon Selling Partner (SP-API) in MS Access

  • Load Amazon Selling Partner (SP-API) in MS Access

  • Load Amazon Selling Partner (SP-API) data in MS Access

  • Read Amazon Selling Partner (SP-API) data in MS Access

  • Amazon Selling Partner (SP-API) API Call in MS Access