Amazon Seller Partner
This page contains the setup guide and reference information for the Amazon Seller Partner source connector.
Prerequisites
- Amazon Seller Partner account
For Airbyte Cloud:
- AWS Environment
- AWS Region
- AWS Seller Partner Account Type
- Granted OAuth access
For Airbyte Open Source:
- AWS Environment
- AWS Region
- AWS Seller Partner Account Type
- LWA Client Id
- LWA Client Secret
- Refresh Token
Setup Guide
Step 1: Set up Amazon Seller Partner
Register your Amazon Seller Partner account.
Airbyte Open Source setup steps
- Register Amazon Seller Partner application. The application must be published as Amazon does not allow external parties such as Airbyte to access draft applications.
Step 2: Set up the source connector in Airbyte
To pass the check for Seller and Vendor accounts, you must have access to the Orders endpoint and the Vendor Orders endpoint, respectively.
For Airbyte Cloud:
- Log into your Airbyte Cloud account.
- Click Sources and then click + New source.
- On the Set up the source page, select Amazon Seller Partner from the Source type dropdown.
- Enter a name for the Amazon Seller Partner connector.
- Click
Authenticate your account
. - Log in and Authorize to your Amazon Seller Partner account.
- For
Start Date
, enter the date inYYYY-MM-DD
format. The data added on and after this date will be replicated. This field is optional - if not provided, the date 2 years ago from today will be used. - For
End Date
, enter the date inYYYY-MM-DD
format. Any data after this date will not be replicated. This field is optional - if not provided, today's date will be used. - You can specify report options for each stream using Report Options section. Available options can be found in corresponding category here.
- Click
Set up source
.
For Airbyte Open Source:
- Using developer application from Step 1, generate refresh token.
- Go to local Airbyte page.
- On the Set up the source page, select Amazon Seller Partner from the Source type dropdown.
- Enter a name for the Amazon Seller Partner connector.
- For Start Date, enter the date in YYYY-MM-DD format. The data added on and after this date will be replicated. This field is optional - if not provided, the date 2 years ago from today will be used.
- For End Date, enter the date in YYYY-MM-DD format. Any data after this date will not be replicated. This field is optional - if not provided, today's date will be used.
- You can specify report options for each stream using Report Options section. Available options can be found in corresponding category here.
- Click
Set up source
.
Supported sync modes
The Amazon Seller Partner source connector supports the following sync modes:
- Full Refresh
- Incremental
Supported streams
- Active Listings Report (incremental)
- All Listings Report (incremental)
- Browse Tree Report (incremental)
- Canceled Listings Report (incremental)
- FBA Amazon Fulfilled Inventory Report (incremental)
- FBA Amazon Fulfilled Shipments Report (incremental)
- FBA Fee Preview Report (incremental)
- FBA Manage Inventory (incremental)
- FBA Manage Inventory Health Report (incremental)
- FBA Multi-Country Inventory Report (incremental)
- FBA Promotions Report (incremental)
- FBA Reimbursements Report (incremental)
- FBA Removal Order Detail Report (incremental)
- FBA Removal Shipment Detail Report (incremental)
- FBA Replacements Report (incremental)
- FBA Returns Report (incremental)
- FBA Storage Fees Report (incremental)
- FBA Stranded Inventory Report (incremental)
- Financial Events (incremental)
- Financial Event Groups (incremental)
- Flat File Archived Orders Report (incremental)
- Flat File Feedback Report (incremental)
- Flat File Orders By Last Update Report (incremental)
- Flat File Orders By Order Date Report (incremental)
- Flat File Returns Report by Return Date (incremental)
- Flat File Settlement Report (incremental)
- Inactive Listings Report (incremental)
- Inventory Ledger Report - Detailed View (incremental)
- Inventory Ledger Report - Summary View (incremental)
- Inventory Report (incremental)
- Open Listings Report (incremental)
- Orders (incremental)
- Order Items (incremental)
- Restock Inventory Report (incremental)
- Scheduled XML Order Report (Shipping) (incremental)
- Subscribe and Save Forecast Report (incremental)
- Subscribe and Save Performance Report (incremental)
- Suppressed Listings Report (incremental)
- Unshipped Orders Report (incremental)
- Vendor Direct Fulfillment Shipping (incremental)
- Vendor Forecasting Report (full-refresh)
- Vendor Orders (incremental)
- XML Orders By Order Date Report (incremental)
- Amazon Search Terms Report (only available in OSS, incremental)
- Market Basket Analysis Report (only available in OSS, incremental)
- Net Pure Product Margin Report (only available in OSS, incremental)
- Rapid Retail Analytics Inventory Report (only available in OSS, incremental)
- Repeat Purchase (only available in OSS, incremental)
- Sales and Traffic Business Report (only available in OSS, incremental)
- Vendor Inventory Report (only available in OSS, incremental)
- Vendor Sales Report (only available in OSS, incremental)
- Vendor Traffic Report (only available in OSS, incremental)
Report options
Report options can be assigned on a per-stream basis that alter the behavior when generating a report. For the full list, refer to Amazon’s report type values documentation.
Certain report types have required parameters that must be defined.
For GET_AMAZON_FULFILLED_SHIPMENTS_DATA_GENERAL
and GET_FLAT_FILE_RETURNS_DATA_BY_RETURN_DATE
streams maximum value for period_in_days
30 days and 60 days.
So, for any value that exceeds the limit, the period_in_days
will be automatically reduced to the limit for the stream.
For the Vendor Forecasting Report, we have two streams - GET_VENDOR_FORECASTING_FRESH_REPORT
and GET_VENDOR_FORECASTING_RETAIL_REPORT
which use the same GET_VENDOR_FORECASTING_REPORT
Amazon's report,
but with different options for the sellingProgram
parameter - FRESH
and RETAIL
respectively.
Performance considerations
Information about rate limits you may find here.
Data type map
Integration Type | Airbyte Type |
---|---|
string | string |
int , float , number | number |
date | date |
datetime | datetime |
array | array |
object | object |
Reference
Config fields reference
Changelog
Expand to review
Version | Date | Pull Request | Subject |
---|---|---|---|
4.3.5 | 2024-06-27 | 40215 | Replaced deprecated AirbyteLogger with logging.Logger |
4.3.4 | 2024-06-25 | 40384 | Update dependencies |
4.3.3 | 2024-06-22 | 40008 | Update dependencies |
4.3.2 | 2024-06-13 | 39441 | Update state handling for incremental streams |
4.3.1 | 2024-06-04 | 38969 | [autopull] Upgrade base image to v1.2.1 |
4.3.0 | 2024-05-24 | #00000 | Extend the report_options spec config with a stream_name attribute |
4.2.4 | 2024-05-15 | #38210 | Fix GET_VENDOR_TRAFFIC_REPORT stream with report option reportPeriod=DAY |
4.2.3 | 2024-05-09 | #38078 | Hide OSS-only streams in report options config for cloud users |
4.2.2 | 2024-04-24 | #36630 | Schema descriptions and CDK 0.80.0 |
4.2.1 | 2024-04-08 | #36895 | Fix reportPeriod day query params |
4.2.0 | 2024-03-19 | #36267 | Pin airbyte-cdk version to ^0 |
4.1.0 | 2024-03-12 | #35954 | Add GET_VENDOR_FORECASTING_FRESH_REPORT and GET_VENDOR_FORECASTING_RETAIL_REPORT streams |
4.0.0 | 2024-02-23 | #35439 | Update schema for the GET_FBA_STORAGE_FEE_CHARGES_DATA stream |
3.5.0 | 2024-02-09 | #35331 | Fix check for Vendor accounts. Add failed report result message |
3.4.0 | 2024-02-15 | #35273 | Add VendorOrders stream |
3.3.2 | 2024-02-13 | #33996 | Add integration tests |
3.3.1 | 2024-02-09 | #35106 | Add logs for the failed check command |
3.3.0 | 2024-02-09 | #35062 | Fix the check command for the Vendor account type |
3.2.2 | 2024-02-07 | #34914 | Fix date formatting for ledger reports with aggregation by month |
3.2.1 | 2024-01-30 | #34654 | Fix date format in state message for streams with custom dates formatting |
3.2.0 | 2024-01-26 | #34549 | Update schemas for vendor analytics streams |
3.1.0 | 2024-01-17 | #34283 | Delete deprecated streams |
3.0.1 | 2023-12-22 | #33741 | Improve report streams performance |
3.0.0 | 2023-12-12 | #32977 | Make all streams incremental |
2.5.0 | 2023-11-27 | #32505 | Make report options configurable via UI |
2.4.0 | 2023-11-23 | #32738 | Add GET_VENDOR_NET_PURE_PRODUCT_MARGIN_REPORT , GET_VENDOR_REAL_TIME_INVENTORY_REPORT , and GET_VENDOR_TRAFFIC_REPORT streams |
2.3.0 | 2023-11-22 | #32541 | Make GET_AFN_INVENTORY_DATA , GET_AFN_INVENTORY_DATA_BY_COUNTRY , and GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE streams incremental |
2.2.0 | 2023-11-21 | #32639 | Make start date optional, if start date is not provided, date 2 years ago from today will be used |
2.1.1 | 2023-11-21 | #32560 | Silently exit sync if the retry attempts were unsuccessful |
2.1.0 | 2023-11-21 | #32591 | Add new fields to GET_LEDGER_DETAIL_VIEW_DATA, GET_FBA_INVENTORY_PLANNING_DATA and Orders schemas |
2.0.2 | 2023-11-17 | #32462 | Remove Max time option from specification; set default waiting time for reports to 1 hour |
2.0.1 | 2023-11-16 | #32550 | Fix the OAuth flow |
2.0.0 | 2023-11-23 | #32355 | Remove Brand Analytics from Airbyte Cloud, permanently remove deprecated FBA reports |
1.6.2 | 2023-11-14 | #32508 | Do not use AWS signature as it is no longer required by the Amazon API |
1.6.1 | 2023-11-13 | #32457 | Fix report decompression |
1.6.0 | 2023-11-09 | #32259 | Mark "aws_secret_key" and "aws_access_key" as required in specification; update schema for stream Orders |
1.5.1 | 2023-08-18 | #29255 | Field role_arn is optional on UI but not really on the backend blocking connector set up using oauth |
1.5.0 | 2023-08-08 | #29054 | Add new stream OrderItems |
1.4.1 | 2023-07-25 | #27050 | Fix - non vendor accounts connector create/check issue |
1.4.0 | 2023-07-21 | #27110 | Add GET_FLAT_FILE_ACTIONABLE_ORDER_DATA_SHIPPING and GET_ORDER_REPORT_DATA_SHIPPING streams |
1.3.0 | 2023-06-09 | #27110 | Removed app_id from InputConfiguration , refactored spec |
1.2.0 | 2023-05-23 | #22503 | Enabled stream attribute customization from Source configuration |
1.1.0 | 2023-04-21 | #23605 | Add FBA Reimbursement Report stream |
1.0.1 | 2023-03-15 | #24098 | Add Belgium Marketplace |
1.0.0 | 2023-03-13 | #23980 | Make app_id required. Increase end_date gap up to 5 minutes from now for Finance streams. Fix connection check failure when trying to connect to Amazon Vendor Central accounts |
0.2.33 | 2023-03-01 | #23606 | Implement reportOptions for all missing reports and refactor |
0.2.32 | 2022-02-21 | #23300 | Make AWS Access Key, AWS Secret Access and Role ARN optional |
0.2.31 | 2022-01-10 | #16430 | Implement slicing for report streams |
0.2.30 | 2022-12-28 | #20896 | Validate connections without orders data |
0.2.29 | 2022-11-18 | #19581 | Use user provided end date for GET_SALES_AND_TRAFFIC_REPORT |
0.2.28 | 2022-10-20 | #18283 | Added multiple (22) report types |
0.2.26 | 2022-09-24 | #16629 | Report API version to 2021-06-30, added multiple (5) report types |
0.2.25 | 2022-07-27 | #15063 | Add Restock Inventory Report |
0.2.24 | 2022-07-12 | #14625 | Add FBA Storage Fees Report |
0.2.23 | 2022-06-08 | #13604 | Add new streams: Fullfiments returns and Settlement reports |
0.2.22 | 2022-06-15 | #13633 | Fix - handle start date for financial stream |
0.2.21 | 2022-06-01 | #13364 | Add financial streams |
0.2.20 | 2022-05-30 | #13059 | Add replication end date to config |
0.2.19 | 2022-05-24 | #13119 | Add OAuth2.0 support |
0.2.18 | 2022-05-06 | #12663 | Add GET_XML_BROWSE_TREE_DATA report |
0.2.17 | 2022-05-19 | #12946 | Add throttling exception managing in Orders streams |
0.2.16 | 2022-05-04 | #12523 | Allow to use IAM user arn or IAM role |
0.2.15 | 2022-01-25 | #9789 | Add stream FbaReplacementsReports |
0.2.14 | 2022-01-19 | #9621 | Add GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_GENERAL report |
0.2.13 | 2022-01-18 | #9581 | Change createdSince parameter to dataStartTime |
0.2.12 | 2022-01-05 | #9312 | Add all remaining brand analytics report streams |
0.2.11 | 2022-01-05 | #9115 | Fix reading only 100 orders |
0.2.10 | 2021-12-31 | #9236 | Fix NoAuth deprecation warning |
0.2.9 | 2021-12-30 | #9212 | Normalize GET_SELLER_FEEDBACK_DATA header field names |
0.2.8 | 2021-12-22 | #8810 | Fix GET_SELLER_FEEDBACK_DATA Date cursor field format |
0.2.7 | 2021-12-21 | #9002 | Extract REPORTS_MAX_WAIT_SECONDS to configurable parameter |
0.2.6 | 2021-12-10 | #8179 | Add GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT report |
0.2.5 | 2021-12-06 | #8425 | Update title, description fields in spec |
0.2.4 | 2021-11-08 | #8021 | Added GET_SELLER_FEEDBACK_DATA report with incremental sync capability |
0.2.3 | 2021-11-08 | #7828 | Remove datetime format from all streams |
0.2.2 | 2021-11-08 | #7752 | Change check_connection function to use stream Orders |
0.2.1 | 2021-09-17 | #5248 | Added extra stream support. Updated reports streams logics |
0.2.0 | 2021-08-06 | #4863 | Rebuild source with airbyte-cdk |
0.1.3 | 2021-06-23 | #4288 | Bugfix failing connection check |
0.1.2 | 2021-06-15 | #4108 | Fixed: Sync fails with timeout when create report is CANCELLED` |