tap-amazon-sp - Meltano Hub

Amazon Selling Partner (SP)

tap-amazon-sp (hotgluexyz variant)🥇

Amazon selling partners programmatic access to their Amazon Seller Central account data

The tap-amazon-sp extractor pulls data from Amazon Selling Partner (SP) that can then be sent to a destination using a loader.

Alternate Implementations

Hotglue (default)🥇
Stitch Data
🥈

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

Add the tap-amazon-sp extractor to your project using
```
meltano add
```
:

meltano add extractor tap-amazon-sp

Configure the tap-amazon-sp settings using

meltano config

:

meltano config tap-amazon-sp set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-amazon-sp test

Next steps

Follow the remaining steps of the Getting Started guide:

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-amazon-sp may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

about
catalog
discover
schema-flattening
state
stream-maps

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-amazon-sp settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

aws_access_key
aws_secret_key
client_secret
lwa_client_id
marketplaces
processing_status
refresh_token
report_types
role_arn
sandbox

Expand To Show SDK Settings

flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-amazon-sp list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

AWS Access Key (aws_access_key)

Environment variable: TAP_AMAZON_SP_AWS_ACCESS_KEY

Your AWS access key.

Configure this setting directly using the following Meltano command:

meltano config tap-amazon-sp set aws_access_key [value]

AWS Secret Key (aws_secret_key)

Environment variable: TAP_AMAZON_SP_AWS_SECRET_KEY

Your AWS secret key.

Configure this setting directly using the following Meltano command:

meltano config tap-amazon-sp set aws_secret_key [value]

Client Secret (client_secret)

Environment variable: TAP_AMAZON_SP_CLIENT_SECRET

Your AWS client secret.

Configure this setting directly using the following Meltano command:

meltano config tap-amazon-sp set client_secret [value]

Lwa Client ID (lwa_client_id)

Environment variable: TAP_AMAZON_SP_LWA_CLIENT_ID

Your AWS LWA client ID.

Configure this setting directly using the following Meltano command:

meltano config tap-amazon-sp set lwa_client_id [value]

Marketplaces (marketplaces)

Environment variable: TAP_AMAZON_SP_MARKETPLACES

An array of Marketplace Country Code values. Default ["US"].

Configure this setting directly using the following Meltano command:

meltano config tap-amazon-sp set marketplaces [value]

Processing Status (processing_status)

Environment variable: TAP_AMAZON_SP_PROCESSING_STATUS
Default Value: ["IN_QUEUE","IN_PROGRESS"]

An array of processing statuses.

Configure this setting directly using the following Meltano command:

meltano config tap-amazon-sp set processing_status [value]

Refresh Token (refresh_token)

Environment variable: TAP_AMAZON_SP_REFRESH_TOKEN

Your AWS refresh token.

Configure this setting directly using the following Meltano command:

meltano config tap-amazon-sp set refresh_token [value]

Report Types (report_types)

Environment variable: TAP_AMAZON_SP_REPORT_TYPES
Default Value: ["GET_LEDGER_DETAIL_VIEW_DATA","GET_MERCHANT_LISTINGS_ALL_DATA"]

An array of report types.

Configure this setting directly using the following Meltano command:

meltano config tap-amazon-sp set report_types [value]

Role Arn (role_arn)

Environment variable: TAP_AMAZON_SP_ROLE_ARN

Your AWS role ARN.

Configure this setting directly using the following Meltano command:

meltano config tap-amazon-sp set role_arn [value]

Sandbox (sandbox)

Environment variable: TAP_AMAZON_SP_SANDBOX
Default Value: false

Whether to using a sandbox or not.

Configure this setting directly using the following Meltano command:

meltano config tap-amazon-sp set sandbox [value]

Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

Environment variable: TAP_AMAZON_SP_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.

Configure this setting directly using the following Meltano command:

meltano config tap-amazon-sp set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_AMAZON_SP_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-amazon-sp set flattening_max_depth [value]

Stream Map Config (stream_map_config)

Environment variable: TAP_AMAZON_SP_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.

Configure this setting directly using the following Meltano command:

meltano config tap-amazon-sp set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_AMAZON_SP_STREAM_MAPS

Config object for stream maps capability.

Configure this setting directly using the following Meltano command:

meltano config tap-amazon-sp set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-amazon-sp extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the

#plugins-general

channel.

Install

meltano add extractor tap-amazon-sp

Maintenance Status

Repo

https://gitlab.com/hotglue/tap-amazon-seller

Maintainer

Meltano Stats

Keywords