Skip to main content

Amazon Marketplace Reader

Note

This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.

Amazon Marketplace is an online marketplace that allows third-party sellers to sell their products to Amazon customers. The Amazon Marketplace Reader connects with the Amazon Marketplace platform and reads supported objects.

Feature summary

Feature

Supported?

Notes

Objects

Standard objects

Custom objects

Authentication

Basic authentication

Username and password

OAuth authentication

Manual configuration based

Custom authentication methods

Not all methods may be supported

Operations

Automated mode

Initial load

Pull-based incremental load

Push-based incremental load

Automated pipeline

Governance

Connection profile

Sherlock AI

Sentinel AI

Schema handling

Initial schema creation

Works with supported targets

Schema evolution

Setup

Wizard template

Flow Designer

Striim TQL

Runtime

Resilience/recovery

Parallel execution

Metrics

Standard metrics

Supported authentication method

The Amazon Marketplace Reader supports OAuth authentication. Creating a connection requires creating an app in the Amazon Developer Console, obtaining the OAuth credentials after registration, obtaining an authorization code and exchanging it for an access token and refresh token, and setting the connection properties in Striim.

To configure OAuth authentication for Amazon Marketplace:

  1. Create an app on the Amazon Developer Console:

    1. Go to the Amazon Developer Console.

    2. Select the App Submission API and register your app.

    3. After registration, note down the Client ID and Client Secret.

  2. Get the access token and refresh token:

    1. Use the OAuth 2.0 flow by sending the user to the authorization URL:

      https://www.amazon.com/ap/oa

      Include parameters such as:

      • client_id=<YOUR_CLIENT_ID>

      • scope-sellingpartnerapi

      • redirect_uri=<YOUR_REDIRECT_URI>

      • response_type=code

    2. After user authorization, exchange the authorization code for tokens by making a POST request:

      POST https://api.amazon.com/auth/o2/token

      Include the following parameters:

      • grant_type=authorization_code

      • code=<AUTHORIZATION_CODE_FROM_URL>

      • client_id=<YOUR_CLIENT_ID>

      • client_secret=<YOUR_CLIENT_SECRET>

      • redirect_uri=<YOUR_REDIRECT_URI>

      The response from the above call will return both the access token and refresh token.

Supported objects

The following are the supported objects for reading from Amazon Marketplace:

  • CatalogItems

  • CatalogItemsClassifications

  • CompetitivePricing

  • Destinations

  • Feeds

  • FeesEstimate

  • InboundDeliveryChallanDocument

  • InboundDeliveryWindowOptions

  • InboundItemComplianceDetails

  • InboundOperationStatus

  • InboundPackingGroupBoxes

  • InboundPackingGroupItems

  • InboundPackingOptions

  • InboundPlacementOptions

  • InboundPlan

  • InboundPlanBoxes

  • InboundPlanItems

  • InboundPlanPallets

  • InboundPreparationInstructions

  • InboundSelfShipAppointmentSlots

  • InboundShipmentBoxes

  • InboundShipmentContentUpdatePreview

  • InboundShipmentItems

  • InboundShipmentPallets

  • InboundShipmentPreorders

  • InboundShipmentTransportDetails

  • InboundShipments

  • InboundTransportationOptions

  • InventorySupply

  • ItemOffers

  • ListingOffers

  • ListingsItems

  • ListingsItemsAttributes

  • ListingsItemsIssues

  • ListingsItemsOffers

  • ListingsItemsSummaries

  • OrderItems

  • OrderMetrics

  • Orders

  • OutboundFeatures

  • OutboundFulfillmentOrderItems

  • OutboundFulfillmentOrders

  • OutboundFulfillmentsPreview

  • OutboundPackageTracking

  • OutboundReturnItems

  • OutboundReturnReasons

  • ProductPricing

  • ReportList

  • ReportTypes

  • ShippingDocuments

  • ShippingRates

  • ShippingTracking

  • Subscriptions

  • VendorCustomerInvoices

  • VendorOrders

  • VendorPackingSlips

  • VendorShippingLabels

Amazon Marketplace Reader properties

Property

Type

Default value

Notes

Schema

String

The type of schema to use.

The available schemas are SellerCentral and VendorCentral.

Marketplace

String

The Marketplace region that you are registered to sell in.

The available regions are Australia, Belgium, Brazil, Canada, Egypt, France, Germany, India, Italy, Japan, Mexico, Netherlands, Poland, Saudi Arabia, Singapore, Spain, Sweden, Turkey, United Arab Emirates, United Kingdom, United States.

Client ID

String

Client ID of the private app registered in the Active Directory of the Microsoft platform.

Client secret

Password

Client secret of the private app registered in the Active Directory of the Microsoft platform.

Access token

Password

The access token for connecting using OAuth. The access token is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

Refresh token

Password

The OAuth refresh token for the corresponding OAuth access token, which is used to refresh the OAuth access token when using OAuth authentication.

App ID

String

The Application ID for the Selling Partner app you created.

AWS access key

Password

The AWS access key of the AWS user that is associated with the the OAuth Client ID.

AWS secret key

Password

The AWS secret key of the AWS user that is associated with the the OAuth Client ID.

Connection pool size

Integer

20

Specifies the maximum number of active connections.

Exclude tables

String

A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.

Incremental load marker

String

The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval.

Specify the name of the column that contains the start position value. This column must meet the following criteria:

  • It should have an integer or timestamp data type (for example, a creation timestamp or an employee ID).

  • The values must be unique and continuously increasing to ensure proper incremental reading.

Migrate schema

Boolean

False

Only available in Initial Load or Automated mode. Set to True to enable initial schema migration, which propagates the object schema from the source to the target.

Mode

Select list:

  • Automated mode

  • Initial load

  • Incremental load

Automated

Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.

Polling interval

Integer

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s). The reader polls the source at the specified interval.

Refresh token

Password

An OAuth 2.0 refresh token.Use the value generated while creating the token.

Start Position

String

%=-1

Value of the incremental load marker that defines the initial reading position.

Tables

String

A semicolon-delimited (;) list of objects to read from the source. Supports the % wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.

Thread pool count

Integer

10

The number of parallel running threads. The default value of zero specifies single-threaded operation.

When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.