Skip to main content

Amazon Seller Central Component

Amazon Seller Central is the portal for accessing your Amazon seller account. Use the Amazon Seller Central component to manage your catalog, orders, and shipping information.

Component key: amazon-seller-central

Description

Amazon Seller Central is the portal for accessing your Amazon seller account.

Use the Amazon Seller Central component to manage your catalog, orders, and shipping information.

API Documentation

This component was built using the Amazon Selling Partner API.

Connections

Amazon Seller Central OAuth 2.0 Client Credentials

InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for Amazon Seller Central. For the {Seller Central URL} use one of https://developer-docs.amazon.com/sp-api/docs/seller-central-urls. Replace {YOUR_APPLICATION_ID} with the application ID you received from the Developer Central page. If your app is still not in production, remember to add the version=beta parameter to the URL.

{Seller Central URL}/apps/authorize/consent?application_id={YOUR_APPLICATION_ID}
Client ID

Provide the Client Id you received from the Developer Central page.

Client Secret

Provide the Client Secret you received from the Developer Central page.

Is Sandbox Environment

If you are using a sandbox environment, select this checkbox. Otherwise, leave it blank.

SP-API Endpoint

Selling Partner API endpoints are associated with a particular AWS Region. The AWS Region is important because it is part of the credential scope, which is required for calculating a signature when calling the Selling Partner API.

sellingpartnerapi-na.amazon.com
Scopes

A space-delimited set of one or more scopes to get the user's permission to access.

Token URL

The OAuth 2.0 Token URL for Amazon Seller Central.

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

Amazon Seller Central OAuth 2.0

To register your application (for all public applications and private seller applications)

  1. Sign into Seller Central using your developer credentials and navigate to Develop Apps.
  2. On the Developer Central page, choose Add new app client.
  3. Enter the OAuth Redirect URI as https://oauth2.prismatic.io/callback and save
  4. Viewing the LWA credentials will provide the client ID and client secret to enter into your credentials

Amazon Seller Central Sandbox Environment

When connecting to the Sandbox environment, it is important to know that some fields will require different value formats than Production in order to succeed. The expected values can be referenced under the Selling Partner API Models

Orders Example

Order Model Reference

  • Created After accepts TEST_CASE_200 or TEST_CASE_200_NEXT_TOKEN
  • Created Before accepts TEST_CASE_200 or TEST_CASE_200_NEXT_TOKEN
  • Order ID accepts TEST_CASE_200

Notifications Example

Notifications Model Reference

  • Subscription ID accepts TEST_CASE_200_SUBSCRIPTION_ID
  • Created Before accepts TEST_CASE_200_DESTINATION_ID
InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for Amazon Seller Central. For the {Seller Central URL} use one of https://developer-docs.amazon.com/sp-api/docs/seller-central-urls. Replace {YOUR_APPLICATION_ID} with the application ID you received from the Developer Central page. If your app is still not in production, remember to add the version=beta parameter to the URL.

{Seller Central URL}/apps/authorize/consent?application_id={YOUR_APPLICATION_ID}
Client ID

Provide the Client Id you received from the Developer Central page.

Client Secret

Provide the Client Secret you received from the Developer Central page.

Is Sandbox Environment

If you are using a sandbox environment, select this checkbox. Otherwise, leave it blank.

SP-API Endpoint

Selling Partner API endpoints are associated with a particular AWS Region. The AWS Region is important because it is part of the credential scope, which is required for calculating a signature when calling the Selling Partner API.

sellingpartnerapi-na.amazon.com
Scopes

A space-delimited set of one or more scopes to get the user's permission to access.

Token URL

The OAuth 2.0 Token URL for Amazon Seller Central.

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

Data Sources

Fetch Destinations

Fetch an array of Destinations | key: destinations | type: picklist

InputNotesExample
Connection

{
"result": [
{
"label": "Destination Name.",
"key": "123"
}
]
}

Select AWS Region

Select an AWS region | key: selectRegion | type: picklist


Actions

Cancel Feed

Cancels the feed that you specify. | key: cancelFeed

InputNotesExample
Connection
Feed Id

The identifier for the feed. This identifier is unique only in combination with a seller ID.

123abc

Cancel Shipment

Cancel the shipment indicated by the specified shipment identifier. | key: cancelShipment

InputNotesExample
Connection
Shipment Id

The Amazon-defined shipment identifier for the shipment to cancel.

123abc

Confirm Order Shipment

Updates the shipment confirmation status for a specified order. | key: confirmOrderShipment

InputNotesExample
Carrier Code

Identifies the carrier that will deliver the package.

123-1234567-1234567
Carrier Name

Carrier Name that will deliver the package. Required when carrierCode is 'Others'

Amazon Logistics
COD Collection Method

The cod collection method, support in JP only.

Connection
Marketplace Id

The unobfuscated marketplace identifier.

Order Id

An Amazon-defined order identifier, in 3-7-7 format.

123-1234567-1234567
Order Items

The list of order items and quantities to be updated.

Package Reference Id

A seller-supplied identifier that uniquely identifies a package within the scope of an order. Only positive numeric values are supported.

123-1234567-1234567
Ship Date

The shipping date for the package. Must be in ISO-8601 date/time format.

2020-12-07T16:50:06.678Z
Ship From Supply Source Id

The unique identifier of the supply source

123abc
Shipping Method

Ship method to be used for shipping the order.

Amazon Logistics
Tracking Number

The tracking number used to obtain tracking and delivery information.

123abc

Create Destination

Creates a destination resource to receive notifications. | key: createDestination

InputNotesExample
Account Id

The identifier for the AWS account that is responsible for charges related to receiving notifications.

123abc
arn

The Amazon Resource Name (ARN) associated with the SQS queue.

DestinationName
Connection
Name

A developer-defined name to help identify this destination.

DestinationName
AWS Region

AWS provides services in multiple regions, like us-west-2 or eu-west-1.

us-east-1

Create Feed

Creates a feed. Upload the contents of the feed document before calling this operation. | key: createFeed

InputNotesExample
Connection
Feed Options

Additional options to control the feed. These vary by feed type.

Feed Type

The feed type.

TheFeedType
Input Feed Document Id

The document identifier returned by the createFeedDocument operation. Upload the feed document contents before calling the createFeed operation.

123abc
Marketplace Ids

list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See (https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.


Create Feed Document

Creates a feed document for the feed type that you specify. | key: createFeedDocument

InputNotesExample
Connection
Content Type

The content type of the feed.

text/xml

Create Listings Item

Creates a new or fully-updates an existing listings item for a selling partner. | key: createListingsItem

InputNotesExample
Attributes

JSON object containing structured listings item attribute data keyed by attribute name.

Connection
Issue Locale

A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: 'en_US', 'fr_CA', 'fr_FR'. Localized messages default to 'en_US' when a localization is not available in the specified locale.

en_US
Marketplace Ids

list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See (https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.

Product Type

The Amazon product type of the listings item.

Requirements

The name of the requirements set for the provided data.

Seller Id

A selling partner identifier, such as a seller account or vendor code. Note: Required when identifiersType is SKU.

123abc
Stock Keeping Unit (SKU)

A selling partner provided identifier for an Amazon listing.

B07H65KP63

Create Shipment

Create a shipment with the information provided. | key: createShipment

InputNotesExample
Amazon Order Id

An Amazon-defined order identifier in 3-7-7 format.

123-1234567-1234567
Connection
Hazmat Type

Hazardous materials options for a package. Consult the terms and conditions for each carrier for more information about hazardous materials.

Include Packing Slip With Label

When true, include a packing slip with the label.

false
Item List

The list of items to be included in a shipment.

Label Customization

Label customization options.

Must Arrive By Date

The date by which the package must arrive to keep the promise to the customer, in ISO 8601 datetime format. If MustArriveByDate is specified, only shipping service offers that can be delivered by that date are returned.

2020-12-07T16:50:06.678Z
Ship From Address

The package dimensions.

Seller Order Id

A seller-defined order identifier.

123
Ship Date

The shipping date for the package. Must be in ISO-8601 date/time format.

2020-12-07T16:50:06.678Z
Ship From Address

The address of the sender.

Shipment Level Seller Inputs List

Label customization options.

Shipping Service Id

An Amazon-defined shipping service identifier.

123abc
Shipping Service Offer Id

Identifies a shipping service order made by a carrier.

123abc
Shipping Service Options

Extra services offered by the carrier.

Weight

The package weight.


Create Subscription

Creates a subscription for the specified notification type to be delivered to the specified destination. | key: createSubscription

InputNotesExample
Aggregation Time Period

he supported aggregation time periods. For example, if FiveMinutes is the value chosen, and 50 price updates occur for an ASIN within 5 minutes, Amazon will send only two notifications; one for the first event, and then a subsequent notification 5 minutes later with the final end state of the data. The 48 interim events will be dropped.

Connection
Destination Id

The identifier for the destination where notifications will be delivered.

123abc
Event Filter Type

An eventFilterType value that is supported by the specific notificationType. This is used by the subscription service to determine the type of event filter. Refer to the section of the Notifications Use Case Guide that describes the specific notificationType to determine if an eventFilterType is supported.

Marketplace Ids

A list of marketplace identifiers to subscribe to (e.g. ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list.

Notification Type

The type of notification.

Order Change Types

A list of order change types to subscribe to (e.g. BuyerRequestedChange). To receive notifications of all change types, do not provide this list.

Payload Version

The version of the payload object to be used in the notification.

1.0

Delete Destination

Deletes the destination that you specify. | key: deleteDestination

InputNotesExample
Connection
Destination Id

The identifier for the destination that you want to delete.

123abc

Delete Listings Item

Delete a listings item for a selling partner. | key: deleteListingsItem

InputNotesExample
Connection
Issue Locale

A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: 'en_US', 'fr_CA', 'fr_FR'. Localized messages default to 'en_US' when a localization is not available in the specified locale.

en_US
Marketplace Ids

list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See (https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.

Seller Id

A selling partner identifier, such as a seller account or vendor code. Note: Required when identifiersType is SKU.

123abc
Stock Keeping Unit (SKU)

A selling partner provided identifier for an Amazon listing.

B07H65KP63

Delete Subscription By ID

Deletes the subscription indicated by the subscription identifier and notification type that you specify. | key: deleteSubscription

InputNotesExample
Connection
Notification Type

The type of notification.

Subscription Id

The identifier for the subscription that you want to delete.

123abc

Get Catalog Item

Retrieves details for an item in the Amazon catalog. | key: getCatalogItem

InputNotesExample
Amazon Standard Identification Number (ASIN)

The Amazon Standard Identification Number (ASIN) of the item.

B07H65KP63
Connection
Included Data

A comma-delimited list of data sets to include in the response. Default: summaries.

Locale

Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.

en_US
Marketplace Ids

list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See (https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.


Get Destination

Returns information about the destination that you specify. | key: getDestination

InputNotesExample
Connection
Destination Id

The identifier generated when you created the destination.

123abc

Get Feed

Returns feed details (including the resultDocumentId, if available) for the feed that you specify. | key: getFeed

InputNotesExample
Connection
Feed Id

The identifier for the feed. This identifier is unique only in combination with a seller ID.

123abc

Get Feed Document

Returns the information required for retrieving a feed document's contents. | key: getFeedDocument

InputNotesExample
Connection
Feed Document Id

The identifier of the feed document.

123abc

Get Listings Item

Returns details about a listings item for a selling partner. | key: getListingsItem

InputNotesExample
Connection
Included Data

A comma-delimited list of data sets to include in the response. Default: summaries.

Issue Locale

A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: 'en_US', 'fr_CA', 'fr_FR'. Localized messages default to 'en_US' when a localization is not available in the specified locale.

en_US
Marketplace Ids

list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See (https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.

Seller Id

A selling partner identifier, such as a merchant account or vendor code.

123abc
Stock Keeping Unit (SKU)

A selling partner provided identifier for an Amazon listing.

B07H65KP63

Get Order

Returns the order that you specify. | key: getOrder

InputNotesExample
Connection
Order Id

An Amazon-defined order identifier, in 3-7-7 format.

123-1234567-1234567

Get Order Address

Returns the shipping address for the order that you specify. | key: getOrderAddress

InputNotesExample
Connection
Order Id

An Amazon-defined order identifier, in 3-7-7 format.

123-1234567-1234567

Get Order Buyer Info

Returns buyer information for the order that you specify. | key: getOrderBuyerInfo

InputNotesExample
Connection
Order Id

An Amazon-defined order identifier, in 3-7-7 format.

123-1234567-1234567

Get Order Items

Returns detailed order item information for the order that you specify. | key: getOrderItems

InputNotesExample
Connection
Next Token

A string token returned in the response of your previous request.

xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234
Order Id

An Amazon-defined order identifier, in 3-7-7 format.

123-1234567-1234567

Get Order Items Buyer Info

Returns buyer information for the order items in the order that you specify. | key: getOrderItemsBuyerInfo

InputNotesExample
Connection
Order Id

An Amazon-defined order identifier, in 3-7-7 format.

123-1234567-1234567

Get Shipment

Returns the shipment information for an existing shipment. | key: getShipment

InputNotesExample
Connection
Shipment Id

The Amazon-defined shipment identifier for the shipment.

123abc

Get Subscription By ID

Returns information about a subscription for the specified notification type. The getSubscriptionById API is grantless. For more information, see Grantless operations in the Selling Partner API Developer Guide. | key: getSubscriptionById

InputNotesExample
Connection
Notification Type

The type of notification.

Subscription Id

The identifier for the subscription that you want to get.

123abc

List Destinations

Returns information about all destinations. | key: listDestinations

InputNotesExample
Connection

List Feeds

Returns feed details for the feeds that match the filters that you specify. | key: listFeeds

InputNotesExample
Connection
Created Since

The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days.

2020-12-07T16:50:06.678Z
Created Until

The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now.

2020-12-07T16:50:06.678Z
Feed Types

A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required.

Marketplace Ids

list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See (https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.

Next Token

A string token returned in the response of your previous request.

xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234
Page Size

The maximum number of feeds to return in a single call.

1
Processing Statuses

A list of processing statuses used to filter feeds.


List Orders

Returns orders created or updated during the time frame indicated by the specified parameters. | key: listOrders

InputNotesExample
Actual Fulfillment Supply Source Id

Denotes the recommended sourceId where the order should be fulfilled from.

123
Amazon Order Ids

A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.

123-1234567-1234567
Buyer Email

The email address of a buyer. Used to select orders that contain the specified email address.

test@test.com
Connection
Created After

A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.

2019-12-07T16:50:06.678Z
Created Before

A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.

2019-12-07T16:50:06.678Z
Debug Request

Enabling this flag will log out the current request.

false
Easy Ship Shipment Statuses

A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.

Electronic Invoice Statuses

A list of ElectronicInvoiceStatus values. Used to select orders with electronic invoice statuses that match the specified values.

Fulfillment Channels

A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: AFN (Fulfillment by Amazon); MFN (Fulfilled by the seller).

Is ISPU

When true, this order is marked to be picked up from a store rather than delivered.

false
Last Updated After

A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.

2019-12-07T16:50:06.678Z
Last Updated Before

A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.

2019-12-07T16:50:06.678Z
Marketplace Ids

list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See (https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.

Max Results Per Page

A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.

1
Next Token

A string token returned in the response of your previous request.

xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234
Order Statuses

A list of OrderStatus values used to filter the results. One of PendingAvailability, Pending, Unshipped, PartiallyShipped, Shipped, Canceled, Unfulfillable, or InvoiceUnconfirmed

Payment Methods

A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS).

Seller Order Id

An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.

123
Store Chain Store Id

The store chain store identifier. Linked to a specific store in a store chain.

123

List Subscription

Returns information about subscriptions of the specified notification type. | key: listSubscriptions

InputNotesExample
Connection
Notification Type

The type of notification.


Raw Request

Send raw HTTP request to Amazon Seller Central | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Debug Request

Enabling this flag will log out the current request.

false
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/orders/v0/orders), The base URL is already included (https://sellingpartnerapi-na.amazon.com/). For example, to connect to https://sellingpartnerapi-na.amazon.com/orders/v0/orders, only /orders/v0/orders is entered in this field.

/orders/v0/orders
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Search Catalog Item

Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. | key: searchCatalogItem

InputNotesExample
Brand Names

A comma-delimited list of brand names to limit the search for keywords-based queries. Note: Cannot be used with identifiers.

LG
Classification Ids

A comma-delimited list of classification identifiers to limit the search for keywords-based queries. Note: Cannot be used with identifiers.

Connection
Identifiers

A comma-delimited list of product identifiers to search the Amazon catalog for. Note: Cannot be used with keywords.

123abc
Identifiers Type

Type of product identifiers to search the Amazon catalog for. Note: Required when identifiers are provided.

Included Data

A comma-delimited list of data sets to include in the response. Default: summaries.

Keywords

A comma-delimited list of words to search the Amazon catalog for. Note: Cannot be used with identifiers.

AKeyword
Keywords Locale

The language of the keywords provided for keywords-based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers.

en_US
Locale

Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.

en_US
Marketplace Ids

list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See (https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.

Page Size

The maximum number of feeds to return in a single call.

1
Page Token

A token to fetch a certain page when there are multiple pages worth of results.

145DWE5s5sd3q8
Seller Id

A selling partner identifier, such as a seller account or vendor code. Note: Required when identifiersType is SKU.

123abc

Update Listings Item

Partially update (patch) a listings item for a selling partner. | key: updateListingsItem

InputNotesExample
Connection
Issue Locale

A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: 'en_US', 'fr_CA', 'fr_FR'. Localized messages default to 'en_US' when a localization is not available in the specified locale.

en_US
Marketplace Ids

list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See (https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.

Patches

One or more JSON Patch operations to perform on the listings item.

Product Type

The Amazon product type of the listings item.

Seller Id

A selling partner identifier, such as a seller account or vendor code. Note: Required when identifiersType is SKU.

123abc
Stock Keeping Unit (SKU)

A selling partner provided identifier for an Amazon listing.

B07H65KP63