Amazon Selling Partner (SP-API) Connector
Documentation
Version: 1
Documentation
Authentication

Private app

Description

Amazon Sellers can use SP-API to set up private integrations and build solutions exclusively for their Amazon store. Private app is available only to your organization and is self-authorized. A private developer builds application(s) that integrate their own company with Amazon APIs. [API reference]

Instructions

Perform the following steps to authenticate calls using Amazon SP-API Private app:

  1. Register as an Amazon Private SP-API Developer. You may need to wait for a day or two to get approved (check approval status).
  2. Once your developer account is approved, login to your account, visit developer console and click Add new app client button to create a Private app: Add new app client as Amazon private developer
  3. Continue by naming your application in the App name field, choose SP API as API Type, and select the Roles for your app (i.e. permissions): Register Amazon SP API app
  4. Once you do that, click View link in LWA credentials column to copy Client identifier and Client secret (we will use them later): Copy client id and client secret of Private app in Amazon
  5. Now it's time to Authorize your app: Start authorizing Private app in Amazon developer area
  6. Finish authorizing it by presing Authorize app button: Authorize Private app in Amazon developer area
  7. Finally, copy the Refresh Token (we will use it in the next step): Use refresh token to get Amazon Selling Partner data via REST API
  8. Now go to SSIS package or ODBC data source and use Private app authentication configuration:
    • In the ClientId field paste the Client identifier value you copied in the previous step.
    • In the ClientSecret field paste the Client secret value you copied in the previous step.
    • Leave the default value in the TokenUrl field.
    • In the Refresh Token field paste the Refresh Token value you copied in the previous step.
  9. Click Test Connection to confirm the connection is working.
  10. Done! Now you are ready to use Amazon Selling Partner (SP-API) Connector!

Parameters

Parameter Required Default value Options
Name: ClientId

Label: ClientId

 YES
Name: ClientSecret

Label: ClientSecret

 YES
Name: TokenUrl

Label: TokenUrl

 YES https://api.amazon.com/auth/o2/token
Name: TokenUIMode

Label: TokenUIMode

 OnlyRefreshToken
Name: AuthUrl

Label: AuthUrl (Do not Use for Private app - Self Authorization)

 https://sellercentral.amazon.com/apps/authorize/consent?application_id=[YOUR-APPLICATION-ID]&version=beta
Name: OrdersApiVersion

Label: OrdersApiVersion

 v0
Name: SellerApiVersion

Label: SellerApiVersion

 v1
Name: ShippingApiVersion

Label: ShippingApiVersion

 v1
Name: ServicesApiVersion

Label: ServicesApiVersion

 v1
Name: FbaApiVersion

Label: FbaApiVersion

 v1
Name: SalesApiVersion

Label: SalesApiVersion

 v1
Name: ReportsApiVersion

Label: ReportsApiVersion

 2021-06-30
Name: ProductsFeesApiVersion

Label: ProductsFeesApiVersion

 v0
Name: ProductPricingApiVersion

Label: ProductPricingApiVersion

 v0
Name: CatalogItemsApiVersion

Label: CatalogItemsApiVersion

 2022-04-01
Name: VendorOrdersApiVersion

Label: VendorOrdersApiVersion

 v1
Name: RetryMode

Label: RetryMode

 RetryWhenStatusCodeMatch
Name: RetryStatusCodeList

Label: RetryStatusCodeList

 429
Name: RetryCountMax

Label: RetryCountMax

 5
Name: RetryMultiplyWaitTime

Label: RetryMultiplyWaitTime

 True