Amazon Selling Partner (SP-API) Connector for SSIS
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. You can use this connector to integrate Amazon Selling Partner (SP-API) data inside SSIS and SQL Server. Let's take a look at the steps below to see how exactly to accomplish that.
Download
Documentation
If you are new with SSIS and ZappySys SSIS PowerPack then check below links to get started.
|
Connect to Amazon Selling Partner (SP-API) in other apps
|
Video Tutorial - Integrate Amazon Selling Partner (SP-API) data in SSIS
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download / install required driver for Amazon Selling Partner (SP-API) integration in SSIS
- How to configure connection for Amazon Selling Partner (SP-API)
- Features about API Source (Authentication / Query Language / Examples / Driver UI)
- Using Amazon Selling Partner (SP-API) Connection in SSIS
Prerequisites
Before we perform steps listed in this article, you will need to make sure following prerequisites are met:
- SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft site).
- Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
- Make sure ZappySys SSIS PowerPack is downloaded and installed (download it). Check Getting started section for more information.
- Optional (If you want to Deploy and Schedule ) - Deploy and Schedule SSIS Packages
How to read data from Amazon Selling Partner (SP-API) in SSIS (Export data)
In this section we will learn how to configure and use Amazon Selling Partner (SP-API) Connector in API Source to extract data from Amazon Selling Partner (SP-API).
-
Begin with opening Visual Studio and Create a New Project.
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
-
In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to
this help link.
-
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
-
Select New Connection to create a new connection:
-
Use a preinstalled Amazon Selling Partner (SP-API) Connector from Popular Connector List or press Search Online radio button to download Amazon Selling Partner (SP-API) Connector. Once downloaded simply use it in the configuration:
Amazon Selling Partner (SP-API)
-
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in 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)
- Go to Register as a Private App developer. You can wait for day or two to get approval. Check status this way
- Once your Developer account is approved. Login to your account and create a new app and obtain Client ID and Client Secret.
- In the very last step can click here to learn how to obtain Refresh Token (Self-Authorize).
- 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.
- For Video Tutorial check this blog post
Amazon Selling Partner (SP-API)
OAuth (Self Authorize - Private App) [OAuth]
https://sellingpartnerapi-na.amazon.com
-
Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.
API Source - 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.
-
That's it! We are done! Just in a few clicks we configured the call to Amazon Selling Partner (SP-API) using Amazon Selling Partner (SP-API) Connector.
You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)
Load Amazon Selling Partner (SP-API) data in SQL Server using Upsert Destination (Insert or Update)
Once you read data from the desired source, now let's see how to Load Amazon Selling Partner (SP-API) data in SQL Server using Upsert Destination.
Upsert Destination can Merge/Synchronize data from source to target for Microsoft SQL Server, PostgreSql and Redshift. It supports very fast Bulk Upsert (Update or Insert) operation along and Bulk delete.
-
From the SSIS toolbox drag and drop Upsert Destination on the dataflow designer surface
Connect our Source component to Upsert Destination
-
Double click on Upsert Destination component to configure it.
-
Select the desired Microsoft SQL Server/PostgreSql/Redshift Target Connection or click NEW to create new connection. Select Target Table or click NEW to create new table based on source columns.
Configure SSIS Upsert Destination Connection - Loading data (REST / SOAP / JSON / XML /CSV) into SQL Server or other target using SSIS
-
Set Action to Upsert => (insert if not matching in target else update). Select Target Connection and Target Table. Check on Insert and Update. Click on Map All to Mappings all columns and check on Only Primary Key columns.
-
Click on OK to save Upsert Destination settings UI.
-
That's it. Run the SSIS Package and it will read the data from the Amazon Selling Partner (SP-API) and load the data in the SQL Server/PostgreSql/Redshift using Upsert Destination.
Video Tutorial - Write or lookup data to Amazon Selling Partner (SP-API) using SSIS
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download SSIS PowerPack for Amazon Selling Partner (SP-API) integration in SSIS
- How to configure connection for Amazon Selling Partner (SP-API)
- How to Write or lookup data to Amazon Selling Partner (SP-API)
- Features about SSIS API Destination
- Using Amazon Selling Partner (SP-API) Connector in SSIS
How to write or lookup data to Amazon Selling Partner (SP-API) in SSIS (Import data)
In upper section we learned how to read data, now in this section we will learn how to configure Amazon Selling Partner (SP-API) in the API Source to Post data to the Amazon Selling Partner (SP-API).
-
Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.
-
From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
-
Select New Connection to create a new connection:
API Destination - 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.
-
Use a preinstalled Amazon Selling Partner (SP-API) Connector from Popular Connector List or press Search Online radio button to download Amazon Selling Partner (SP-API) Connector. Once downloaded simply use it in the configuration:
Amazon Selling Partner (SP-API)
-
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in 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)
- Go to Register as a Private App developer. You can wait for day or two to get approval. Check status this way
- Once your Developer account is approved. Login to your account and create a new app and obtain Client ID and Client Secret.
- In the very last step can click here to learn how to obtain Refresh Token (Self-Authorize).
- 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.
- For Video Tutorial check this blog post
Amazon Selling Partner (SP-API)
OAuth (Self Authorize - Private App) [OAuth]
https://sellingpartnerapi-na.amazon.com
-
Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.
API Destination - 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.
-
Finally, map the desired columns:
API Destination - 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.
-
That's it; we successfully configured the POST API Call. In a few clicks we configured the Amazon Selling Partner (SP-API) API call using ZappySys Amazon Selling Partner (SP-API) Connector
Advanced topics
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
Get Report Data - Tab Separated File (TSV)
Get Report Data - Comma Separated File (CSV)
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 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 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.
|
[
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
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.
|
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...]
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...]
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
|
Conclusion
In this article we discussed how to connect to Amazon Selling Partner (SP-API) in SSIS and integrate data without any coding. Click here to Download Amazon Selling Partner (SP-API) Connector for SSIS 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 SSIS
Documentation
More integrations
Other application integration scenarios for Amazon Selling Partner (SP-API)
Other connectors for SSIS
Download Amazon Selling Partner (SP-API) Connector for SSIS
Documentation
Common Searches:
How to connect Amazon Selling Partner (SP-API) in SSIS?
How to get Amazon Selling Partner (SP-API) data in SSIS?
How to read Amazon Selling Partner (SP-API) data in SSIS?
How to load Amazon Selling Partner (SP-API) data in SSIS?
How to import Amazon Selling Partner (SP-API) data in SSIS?
How to pull Amazon Selling Partner (SP-API) data in SSIS?
How to push data to Amazon Selling Partner (SP-API) in SSIS?
How to write data to Amazon Selling Partner (SP-API) in SSIS?
How to POST data to Amazon Selling Partner (SP-API) in SSIS?
Call Amazon Selling Partner (SP-API) API in SSIS
Consume Amazon Selling Partner (SP-API) API in SSIS
Amazon Selling Partner (SP-API) SSIS Automate
Amazon Selling Partner (SP-API) SSIS Integration
Integration Amazon Selling Partner (SP-API) in SSIS
Consume real-time Amazon Selling Partner (SP-API) data in SSIS
Consume real-time Amazon Selling Partner (SP-API) API data in SSIS
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 SSIS
Load Amazon Selling Partner (SP-API) in SSIS
Load Amazon Selling Partner (SP-API) data in SSIS
Read Amazon Selling Partner (SP-API) data in SSIS
Amazon Selling Partner (SP-API) API Call in SSIS