Amazon Seller Central Component
Manage product listings, orders, inventory, and fulfillment in Amazon Seller Central.
Component key: amazon-seller-central
Description
Amazon Seller Central is Amazon's platform for managing third-party seller businesses on the Amazon marketplace. This component allows you to retrieve and update product listings, process orders, manage inventory, and handle fulfillment information.
API Documentation
This component was built using the Amazon Selling Partner API.
Connections
Amazon Seller Central OAuth 2.0 Client Credentials
key: clientCredentials| Input | Notes | Example |
|---|---|---|
| Authorize URL | The OAuth 2.0 Authorization URL for Amazon Seller Central. For the {Seller Central URL} use one of the 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, add the version=beta parameter to the URL. | {Seller Central URL}/apps/authorize/consent?application_id={YOUR_APPLICATION_ID} |
| Client ID | Client ID from your Amazon Seller Central application. Find this on the Developer Central page. | amzn1.application-oa2-client.1234567890abcdef |
| Client Secret | Client Secret from your Amazon Seller Central application. Find this on the Developer Central page. | |
| Is Sandbox Environment | When set to Yes, the connection will use the Amazon SP-API sandbox environment for testing. Leave blank or select No for production use. | |
| 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. Learn more | sellingpartnerapi-na.amazon.com |
| Scopes | Space-delimited set of one or more scopes to get the user's permission to access. | sellingpartnerapi::migration |
| 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
key: oauth2To connect to Amazon Seller Central, register an application in the Developer Central console and configure OAuth 2.0 authentication.
For detailed information, refer to the Amazon Selling Partner API documentation.
Prerequisites
- An Amazon Seller Central account with developer access
- Access to the Developer Central console
Setup Steps
To register the application for public or private seller use:
- Sign into Seller Central using developer credentials and navigate to Developer Central.
- On the Developer Central page, select Add new app client.
- Enter the OAuth Redirect URI:
https://oauth2.prismatic.io/callback - Save the application configuration.
- View the LWA Credentials section to access the Client ID and Client Secret.
Configure the Connection
- Enter the Client ID and Client Secret from the LWA Credentials section
- Select the appropriate Region for the Seller Central account
- Configure the Authorize URL based on the Seller Central region:
- For the Seller Central URL, refer to Amazon's region URLs
- Replace
{YOUR_APPLICATION_ID}with the application ID from the Developer Central page - For applications not yet in production, add
version=betato the URL parameter
- If connecting to a Sandbox environment, select Yes for the Is Sandbox Environment field
For information on required scopes and permissions, refer to the SP-API authorization documentation.
When connecting to the Sandbox environment, some fields require different value formats than Production to succeed. The expected values can be referenced in the Selling Partner API Models.
Orders Example (Model Reference):
- Created After:
TEST_CASE_200orTEST_CASE_200_NEXT_TOKEN - Created Before:
TEST_CASE_200orTEST_CASE_200_NEXT_TOKEN - Order ID:
TEST_CASE_200
Notifications Example (Model Reference):
- Subscription ID:
TEST_CASE_200_SUBSCRIPTION_ID - Created Before:
TEST_CASE_200_DESTINATION_ID
| Input | Notes | Example |
|---|---|---|
| Authorize URL | The OAuth 2.0 Authorization URL for Amazon Seller Central. For the {Seller Central URL} use one of the 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, add the version=beta parameter to the URL. | {Seller Central URL}/apps/authorize/consent?application_id={YOUR_APPLICATION_ID} |
| Client ID | Client ID from your Amazon Seller Central application. Find this on the Developer Central page. | amzn1.application-oa2-client.1234567890abcdef |
| Client Secret | Client Secret from your Amazon Seller Central application. Find this on the Developer Central page. | |
| Is Sandbox Environment | When set to Yes, the connection will use the Amazon SP-API sandbox environment for testing. Leave blank or select No for production use. | |
| 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. Learn more | sellingpartnerapi-na.amazon.com |
| Scopes | 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
Select AWS Region
Select an AWS region | key: selectRegion | type: picklist
Select Destinations
Select a destination from your Amazon Seller Central account | key: selectDestinations | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. |
{
"result": [
{
"label": "Production SQS Queue",
"key": "d0e9e693-cd56-4d1f-b63a-418f2d169d4a"
},
{
"label": "EventBridge Destination",
"key": "f1a2b3c4-d5e6-7f8a-9b0c-1d2e3f4a5b6c"
}
]
}
Select Feed
Select a feed from your Amazon Seller Central account | key: selectFeed | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| 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. | 2024-01-01T00:00:00.000Z |
| Created Until | The latest feed creation date and time for feeds included in the response in ISO 8601 format. The default is now. | 2024-12-31T23:59:59.999Z |
| Feed Types | 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. <strong>Important:</strong> Either feedTypes or nextToken is required. | POST_PRODUCT_DATA |
| Marketplace Ids | List of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the Marketplace IDs documentation for a complete list of marketplaceId values. | |
| Processing Statuses | List of processing statuses used to filter feeds. |
{
"result": [
{
"label": "23492834092 - POST_PRODUCT_DATA (DONE)",
"key": "23492834092"
},
{
"label": "23492834091 - POST_INVENTORY_AVAILABILITY_DATA (IN_PROGRESS)",
"key": "23492834091"
},
{
"label": "23492834090 - POST_PRODUCT_PRICING_DATA (CANCELLED)",
"key": "23492834090"
}
]
}
Select Order
Select an order from your Amazon Seller Central account | key: selectOrder | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Created After | Date used for selecting orders created after (or at) a specified time in ISO 8601 format. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. | 2024-01-15T10:30:00.000Z |
| Created Before | Date used for selecting orders created before (or at) a specified time in ISO 8601 format. Only orders placed before the specified time are returned. | 2024-12-31T23:59:59.999Z |
| Last Updated After | Date used for selecting orders that were last updated after (or at) a specified time in ISO 8601 format. 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. | 2024-01-15T10:30:00.000Z |
| Last Updated Before | Date used for selecting orders that were last updated before (or at) a specified time in ISO 8601 format. 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. | 2024-12-31T23:59:59.999Z |
| Marketplace Ids | List of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the Marketplace IDs documentation for a complete list of marketplaceId values. |
{
"result": [
{
"label": "902-3159896-1390916 - Shipped",
"key": "902-3159896-1390916"
},
{
"label": "112-7628145-8392418 - Pending",
"key": "112-7628145-8392418"
}
]
}
Actions
Cancel Feed
Cancels the feed that you specify. | key: cancelFeed
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Feed Id | The identifier for the feed. This identifier is unique only in combination with a seller ID. | 50017017797 |
{
"data": {}
}
Cancel Shipment
Cancel the shipment indicated by the specified shipment identifier. | key: cancelShipment
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Shipment Id | The Amazon-defined shipment identifier for the shipment to cancel. | 6f77095e-9f75-47eb-aaab-a42d5428fa1a |
{
"data": {
"Shipment": {
"ShipmentId": "MWSTestShipment123456789",
"AmazonOrderId": "902-3159896-1390916",
"Status": "Cancelled",
"CreatedDate": "2024-01-15T10:30:45.123Z",
"LastUpdatedDate": "2024-01-15T11:15:30.456Z"
}
}
}
Confirm Order Shipment
Updates the shipment confirmation status for a specified order. | key: confirmOrderShipment
| Input | Notes | Example |
|---|---|---|
| Carrier Code | Identifies the carrier that will deliver the package. | USPS |
| Carrier Name | Carrier name that will deliver the package. <strong>Important:</strong> Required when carrierCode is 'Others'. | Amazon Logistics |
| COD Collection Method | The COD collection method. Supported in Japan marketplace only. | |
| Connection | The Amazon Seller Central connection to use. | |
| Marketplace Id | The marketplace identifier. See the Marketplace IDs documentation for available marketplaces. | ATVPDKIKX0DER |
| 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. | 12345 |
| Ship Date | The shipping date for the package in ISO 8601 date/time format. | 2024-03-15T14:30:00.000Z |
| Ship From Supply Source Id | The unique identifier of the supply source. | SUPPLY-12345 |
| Shipping Method | Ship method to be used for shipping the order. | Standard |
| Tracking Number | The tracking number used to obtain tracking and delivery information. | 1Z999AA10123456784 |
{
"data": {}
}
Create Destination
Creates a destination resource to receive notifications. | key: createDestination
| Input | Notes | Example |
|---|---|---|
| Account Id | The identifier for the AWS account that is responsible for charges related to receiving notifications. | 123456789012 |
| ARN | The Amazon Resource Name (ARN) associated with the SQS queue. | arn:aws:sqs:us-east-1:123456789012:my-notification-queue |
| Connection | The Amazon Seller Central connection to use. | |
| Name | A developer-defined name to help identify this destination. | MyNotificationDestination |
| AWS Region | AWS provides services in multiple regions, like us-west-2 or eu-west-1. | us-east-1 |
{
"data": {
"name": "Production SQS Queue",
"destinationId": "d0e9e693-cd56-4d1f-b63a-418f2d169d4a",
"resource": {
"sqs": {
"arn": "arn:aws:sqs:us-east-1:123456789012:SellerCentral-Notifications"
}
}
}
}
Create Feed
Creates a feed. Upload the contents of the feed document before calling this operation. | key: createFeed
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Feed Options | Additional options to control the feed. These vary by feed type. | |
| Feed Type | The feed type. See the Feeds API documentation for available feed types. | POST_PRODUCT_DATA |
| Input Feed Document Id | The document identifier returned by the createFeedDocument operation. Upload the feed document contents before calling the createFeed operation. | amzn1.tortuga.3.edbcd0d8-3434-8222-ac6f-bac123456789.T1URXX1LHU1Q |
| Marketplace Ids | List of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the Marketplace IDs documentation for a complete list of marketplaceId values. |
{
"data": {
"feedId": "23492834093"
}
}
Create Feed Document
Creates a feed document for the feed type that you specify. | key: createFeedDocument
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Content Type | The content type of the feed. | text/xml; charset=UTF-8 |
{
"data": {
"feedDocumentId": "amzn1.tortuga.3.920614b0-fc4c-4393-b0d9-fff175300000.T29XK4YL08B2VM",
"url": "https://tortuga-prod-na.s3.amazonaws.com/%2FNinetyDays/amzn1.tortuga.3.920614b0-fc4c-4393-b0d9-fff175300000.T29XK4YL08B2VM?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240115T103045Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=300&X-Amz-Credential=AKIAIN7EXAMPLE%2F20240115%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=example1234567890abcdef1234567890abcdef1234567890abcdef12345678"
}
}
Create Listings Item
Creates a new or fully-updates an existing listings item for a selling partner. | key: createListingsItem
| Input | Notes | Example |
|---|---|---|
| Attributes | JSON object containing structured listings item attribute data keyed by attribute name. | |
| Connection | The Amazon Seller Central connection to use. | |
| 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 the Marketplace IDs documentation for a complete list of marketplaceId values. | |
| Product Type | The Amazon product type of the listings item. | LUGGAGE |
| 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. <strong>Important:</strong> Required when identifiersType is SKU. | A2EXAMPLE123456 |
| Stock Keeping Unit (SKU) | A selling partner provided identifier for an Amazon listing. | MY-PRODUCT-SKU-001 |
{
"data": {
"sku": "MY-SKU-12345",
"status": "ACCEPTED",
"submissionId": "f1dc291475dd11eaa671df34d64cc222",
"issues": []
}
}
Create Shipment
Create a shipment with the information provided. | key: createShipment
| Input | Notes | Example |
|---|---|---|
| Amazon Order Id | An Amazon-defined order identifier in 3-7-7 format. | 123-1234567-1234567 |
| Connection | The Amazon Seller Central connection to use. | |
| 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. | 2024-03-20T23:59:59.999Z |
| Package Dimensions | The package dimensions. | |
| Seller Order Id | A seller-defined order identifier. | ORDER-12345 |
| Ship Date | The shipping date for the package in ISO 8601 date/time format. | 2024-03-15T14:30:00.000Z |
| Ship From Address | The address of the sender. | |
| Shipment Level Seller Inputs List | Additional seller-provided inputs for the shipment. | |
| Shipping Service Id | An Amazon-defined shipping service identifier. | USPS-PTP-PRI |
| Shipping Service Offer Id | Identifies a shipping service order made by a carrier. | OFFER-12345 |
| Shipping Service Options | Extra services offered by the carrier. | |
| Weight | The package weight unit. |
{
"data": {
"Shipment": {
"ShipmentId": "MWSTestShipment123456789",
"AmazonOrderId": "902-3159896-1390916",
"SellerOrderId": "MY-ORDER-123",
"ItemList": [
{
"OrderItemId": "52852651034158",
"Quantity": 1
}
],
"ShipFromAddress": {
"Name": "ACME Warehouse",
"AddressLine1": "456 ACME Blvd",
"AddressLine2": "Suite 200",
"City": "Seattle",
"StateOrProvinceCode": "WA",
"PostalCode": "98101",
"CountryCode": "US",
"Email": "warehouse@example.com",
"Phone": "555-987-6543"
},
"ShipToAddress": {
"Name": "John Doe",
"AddressLine1": "123 Main Street",
"AddressLine2": "Apt 4B",
"City": "Seattle",
"StateOrProvinceCode": "WA",
"PostalCode": "98101",
"CountryCode": "US",
"Email": null,
"Phone": "555-123-4567"
},
"PackageDimensions": {
"Length": 10,
"Width": 8,
"Height": 6,
"Unit": "inches",
"PredefinedPackageDimensions": "FedEx_Box_10kg"
},
"Weight": {
"Value": 2.5,
"Unit": "pounds"
},
"Insurance": {
"Amount": {
"CurrencyCode": "USD",
"Amount": 0
}
},
"ShippingService": {
"ShippingServiceName": "USPS Priority Mail",
"CarrierName": "USPS",
"ShippingServiceId": "usps-priority-mail",
"ShippingServiceOfferId": "offer123456",
"ShipDate": "2024-01-15T08:00:00Z",
"EarliestEstimatedDeliveryDate": "2024-01-17T08:00:00Z",
"LatestEstimatedDeliveryDate": "2024-01-19T20:00:00Z",
"Rate": {
"CurrencyCode": "USD",
"Amount": 7.5
},
"ShippingServiceOptions": {
"DeliveryExperience": "DeliveryConfirmationWithSignature",
"DeclaredValue": {
"CurrencyCode": "USD",
"Amount": 99.99
},
"CarrierWillPickUp": false,
"CarrierWillPickUpOption": null,
"LabelFormat": "PNG"
},
"AvailableLabelFormats": [
"PNG",
"PDF"
],
"AvailableFormatOptionsForLabel": [
{
"IncludePackingSlipWithLabel": false
}
],
"RequiresAdditionalSellerInputs": false
},
"Label": {
"CustomTextForLabel": null,
"Dimensions": {
"Length": 4,
"Width": 6,
"Unit": "inches"
},
"FileContents": {
"Contents": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwo+Pg==",
"FileType": "application/pdf",
"Checksum": "5d41402abc4b2a76b9719d911017c592"
},
"LabelFormat": "PDF",
"StandardIdForLabel": "AmazonOrderId"
},
"TrackingId": "1234567890123456789012",
"Status": "Purchased",
"CreatedDate": "2024-01-15T10:30:45.123Z",
"LastUpdatedDate": "2024-01-15T10:30:45.123Z"
}
}
}
Create Subscription
Creates a subscription for the specified notification type to be delivered to the specified destination. | key: createSubscription
| Input | Notes | Example |
|---|---|---|
| Aggregation Time Period | The 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 | The Amazon Seller Central connection to use. | |
| Destination Id | The identifier for the destination where notifications will be delivered. | amzn1.sp-api.destination.12345678-90ab-cdef-1234-567890abcdef |
| 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 Notifications Use Case Guide for 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. See the Notifications API documentation for available notification types. | |
| Order Change Types | 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 |
{
"data": {
"subscriptionId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f9a",
"payloadVersion": "1.0",
"destinationId": "d0e9e693-cd56-4d1f-b63a-418f2d169d4a"
}
}
Delete Destination
Deletes the destination that you specify. | key: deleteDestination
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Destination Id | The identifier for the destination that you want to delete. | amzn1.sp-api.destination.12345678-90ab-cdef-1234-567890abcdef |
{
"data": {}
}
Delete Listings Item
Delete a listings item for a selling partner. | key: deleteListingsItem
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| 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 the Marketplace IDs documentation for a complete list of marketplaceId values. | |
| Seller Id | A selling partner identifier, such as a seller account or vendor code. <strong>Important:</strong> Required when identifiersType is SKU. | A2EXAMPLE123456 |
| Stock Keeping Unit (SKU) | A selling partner provided identifier for an Amazon listing. | MY-PRODUCT-SKU-001 |
{
"data": {
"sku": "MY-SKU-12345",
"status": "ACCEPTED",
"submissionId": "h3fe493697ff33gcc893fh56f86ee444",
"issues": []
}
}
Delete Subscription By ID
Deletes the subscription indicated by the subscription identifier and notification type that you specify. | key: deleteSubscription
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Notification Type | The type of notification. See the Notifications API documentation for available notification types. | |
| Subscription Id | The identifier for the subscription that you want to delete. | 7fcacc7e-727b-11e9-8848-1681be663d3e |
{
"data": {}
}
Get Catalog Item
Retrieves details for an item in the Amazon catalog. | key: getCatalogItem
| Input | Notes | Example |
|---|---|---|
| Amazon Standard Identification Number (ASIN) | The Amazon Standard Identification Number (ASIN) of the item. | B07H65KP63 |
| Connection | The Amazon Seller Central connection to use. | |
| Included Data | 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 the Marketplace IDs documentation for a complete list of marketplaceId values. |
{
"data": {
"asin": "B07XJ8C8F5",
"attributes": {
"condition_type": [
{
"value": "new_new",
"language": "en_US"
}
],
"item_name": [
{
"value": "ACME Product Name - Premium Edition",
"language": "en_US",
"marketplace_id": "ATVPDKIKX0DER"
}
],
"brand": [
{
"value": "ACME",
"language": "en_US"
}
],
"list_price": [
{
"value": 99.99,
"currency": "USD",
"marketplace_id": "ATVPDKIKX0DER"
}
],
"product_category": [
{
"value": "ELECTRONIC_COMPONENTS_AND_EQUIPMENT"
}
],
"item_dimensions": [
{
"height": {
"value": 10,
"unit": "centimeters"
},
"width": {
"value": 20,
"unit": "centimeters"
},
"length": {
"value": 15,
"unit": "centimeters"
},
"weight": {
"value": 0.5,
"unit": "kilograms"
}
}
]
},
"identifiers": [
{
"identifierType": "ASIN",
"identifier": "B07XJ8C8F5"
},
{
"identifierType": "EAN",
"identifier": "1234567890123"
},
{
"identifierType": "UPC",
"identifier": "123456789012"
}
],
"images": [
{
"variant": "MAIN",
"link": "https://m.media-amazon.com/images/I/acme-image._AC_US200_.jpg",
"height": 200,
"width": 200
},
{
"variant": "PT01",
"link": "https://m.media-amazon.com/images/I/acme-image-2._AC_US200_.jpg",
"height": 200,
"width": 200
}
],
"productTypes": [
{
"productType": "ELECTRONIC_COMPONENT",
"marketplaceId": "ATVPDKIKX0DER"
}
],
"salesRanks": [
{
"classificationRanks": [
{
"rank": 42,
"title": "Electronics",
"link": "https://www.amazon.com/gp/bestsellers/electronics"
}
],
"displayGroupRanks": []
}
],
"summaries": [
{
"marketplaceId": "ATVPDKIKX0DER",
"adultProduct": false,
"autographed": false,
"brand": "ACME",
"browseClassification": {
"displayName": "Electronics",
"classificationId": "12345678"
},
"color": "Black",
"itemClassification": "BASE_PRODUCT",
"itemName": "ACME Product Name - Premium Edition",
"manufacturer": "ACME Corporation",
"memorabilia": false,
"modelNumber": "EX-123-BLK",
"packageQuantity": 1,
"partNumber": "EX-123-BLK-US",
"releaseDate": "2023-06-15T00:00:00Z",
"size": "Medium",
"style": "Modern",
"tradeInEligible": false,
"websiteDisplayGroup": "electronics_display_on_website"
}
],
"vendorDetails": []
}
}
Get Destination
Returns information about the destination that you specify. | key: getDestination
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Destination Id | The identifier generated when you created the destination. | amzn1.sp-api.destination.12345678-90ab-cdef-1234-567890abcdef |
{
"data": {
"name": "Production SQS Queue",
"destinationId": "d0e9e693-cd56-4d1f-b63a-418f2d169d4a",
"resource": {
"sqs": {
"arn": "arn:aws:sqs:us-east-1:123456789012:SellerCentral-Notifications"
}
}
}
}
Get Feed
Returns feed details (including the resultDocumentId, if available) for the feed that you specify. | key: getFeed
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Feed Id | The identifier for the feed. This identifier is unique only in combination with a seller ID. | 50017017797 |
{
"data": {
"feedId": "23492834092",
"feedType": "POST_PRODUCT_DATA",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"createdTime": "2024-01-15T10:30:45.123Z",
"processingStatus": "DONE",
"processingStartTime": "2024-01-15T10:31:00.456Z",
"processingEndTime": "2024-01-15T10:35:22.789Z",
"resultFeedDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-ac12-1212121abcde.T3YUVYPGKE9BMY"
}
}
Get Feed Document
Returns the information required for retrieving a feed document's contents. | key: getFeedDocument
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Feed Document Id | The identifier of the feed document. | amzn1.tortuga.3.edbcd0d8-3434-8222-ac6f-bac123456789.T1URXX1LHU1Q |
{
"data": {
"feedDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-ac12-1212121abcde.T3YUVYPGKE9BMY",
"url": "https://tortuga-prod-na.s3.amazonaws.com/%2FNinetyDays/amzn1.tortuga.3.edbcd0d8-3434-8222-ac12-1212121abcde.T3YUVYPGKE9BMY?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240115T103545Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Credential=AKIAIN7EXAMPLE%2F20240115%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=example1234567890abcdef1234567890abcdef1234567890abcdef12345678",
"compressionAlgorithm": "GZIP"
}
}
Get Listings Item
Returns details about a listings item for a selling partner. | key: getListingsItem
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Included Data | 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 the Marketplace IDs documentation for a complete list of marketplaceId values. | |
| Seller Id | A selling partner identifier, such as a merchant account or vendor code. | A2EXAMPLE123456 |
| Stock Keeping Unit (SKU) | A selling partner provided identifier for an Amazon listing. | MY-PRODUCT-SKU-001 |
{
"data": {
"sku": "MY-SKU-12345",
"summaries": [
{
"marketplaceId": "ATVPDKIKX0DER",
"asin": "B07XJ8C8F5",
"productType": "ELECTRONIC_COMPONENT",
"conditionType": "new_new",
"status": [
"BUYABLE"
],
"fnSku": "X001234567",
"itemName": "ACME Product Name - Premium Edition",
"createdDate": "2023-06-15T10:30:00Z",
"lastUpdatedDate": "2024-01-10T14:22:10Z",
"mainImage": {
"link": "https://m.media-amazon.com/images/I/acme-image._AC_US200_.jpg",
"height": 200,
"width": 200
}
}
],
"attributes": {
"condition_type": [
{
"value": "new_new",
"marketplace_id": "ATVPDKIKX0DER"
}
],
"item_name": [
{
"value": "ACME Product Name - Premium Edition",
"language_tag": "en_US",
"marketplace_id": "ATVPDKIKX0DER"
}
],
"brand": [
{
"value": "ACME",
"marketplace_id": "ATVPDKIKX0DER"
}
],
"externally_assigned_product_identifier": [
{
"value": "1234567890123",
"type": "ean",
"marketplace_id": "ATVPDKIKX0DER"
}
],
"purchasable_offer": [
{
"currency": "USD",
"our_price": [
{
"schedule": [
{
"value_with_tax": 99.99
}
]
}
],
"marketplace_id": "ATVPDKIKX0DER"
}
],
"fulfillment_availability": [
{
"fulfillment_channel_code": "DEFAULT",
"quantity": 100,
"marketplace_id": "ATVPDKIKX0DER"
}
]
},
"issues": [],
"offers": [
{
"marketplaceId": "ATVPDKIKX0DER",
"offerType": "B2C",
"price": {
"listingPrice": {
"amount": 99.99,
"currencyCode": "USD"
},
"shippingPrice": {
"amount": 0,
"currencyCode": "USD"
}
},
"pointsGranted": null
}
],
"fulfillmentAvailability": [
{
"fulfillmentChannelCode": "DEFAULT",
"quantity": 100
}
],
"procurement": []
}
}
Get Order
Returns the order that you specify. | key: getOrder
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Order Id | An Amazon-defined order identifier in 3-7-7 format. | 123-1234567-1234567 |
{
"data": {
"AmazonOrderId": "902-3159896-1390916",
"PurchaseDate": "2024-01-15T10:30:45.123Z",
"LastUpdateDate": "2024-01-15T14:22:10.456Z",
"OrderStatus": "Shipped",
"FulfillmentChannel": "MFN",
"SalesChannel": "Amazon.com",
"OrderChannel": "AFN",
"ShipServiceLevel": "Std US D2D Dom",
"OrderTotal": {
"CurrencyCode": "USD",
"Amount": "99.99"
},
"NumberOfItemsShipped": 1,
"NumberOfItemsUnshipped": 0,
"PaymentMethod": "Other",
"PaymentMethodDetails": [
"Standard"
],
"MarketplaceId": "ATVPDKIKX0DER",
"ShipmentServiceLevelCategory": "Standard",
"OrderType": "StandardOrder",
"EarliestShipDate": "2024-01-15T08:00:00Z",
"LatestShipDate": "2024-01-16T07:59:59Z",
"EarliestDeliveryDate": "2024-01-18T08:00:00Z",
"LatestDeliveryDate": "2024-01-20T07:59:59Z",
"IsBusinessOrder": false,
"IsPrime": false,
"IsGlobalExpressEnabled": false,
"IsPremiumOrder": false,
"IsSoldByAB": false,
"IsIBA": false,
"DefaultShipFromLocationAddress": {
"City": "Seattle",
"StateOrRegion": "WA",
"PostalCode": "98101",
"CountryCode": "US",
"Name": "ACME Warehouse",
"AddressLine1": "123 Main St"
},
"FulfillmentInstruction": {
"FulfillmentSupplySourceId": "sampleSupplySourceId"
},
"IsISPU": false,
"IsAccessPointOrder": false,
"AutomatedShippingSettings": {
"HasAutomatedShippingSettings": false
},
"EasyShipShipmentStatus": null,
"ElectronicInvoiceStatus": null
}
}
Get Order Address
Returns the shipping address for the order that you specify. | key: getOrderAddress
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Order Id | An Amazon-defined order identifier in 3-7-7 format. | 123-1234567-1234567 |
{
"data": {
"AmazonOrderId": "902-3159896-1390916",
"ShippingAddress": {
"Name": "John Doe",
"AddressLine1": "123 Main Street",
"AddressLine2": "Apt 4B",
"AddressLine3": null,
"City": "Seattle",
"County": null,
"District": null,
"StateOrRegion": "WA",
"Municipality": null,
"PostalCode": "98101",
"CountryCode": "US",
"Phone": "555-123-4567",
"AddressType": "Residential"
}
}
}
Get Order Buyer Info
Returns buyer information for the order that you specify. | key: getOrderBuyerInfo
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Order Id | An Amazon-defined order identifier in 3-7-7 format. | 123-1234567-1234567 |
{
"data": {
"AmazonOrderId": "902-3159896-1390916",
"BuyerEmail": "buyer-email@marketplace.amazon.com",
"BuyerName": "John Doe",
"BuyerCounty": null,
"BuyerTaxInfo": {
"CompanyLegalName": null,
"TaxingRegion": null,
"TaxClassifications": []
},
"PurchaseOrderNumber": null
}
}
Get Order Items
Returns detailed order item information for the order that you specify. | key: getOrderItems
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Next Token | String token returned in the response of your previous request for pagination. | amzn1.aos.4e9ba8a1-1234-5678-90ab-cdef12345678 |
| Order Id | An Amazon-defined order identifier in 3-7-7 format. | 123-1234567-1234567 |
{
"data": {
"AmazonOrderId": "902-3159896-1390916",
"OrderItems": [
{
"ASIN": "B00X4WHP5E",
"SellerSKU": "MY-SKU-12345",
"OrderItemId": "52852651034158",
"Title": "ACME Product Title",
"QuantityOrdered": 1,
"QuantityShipped": 1,
"ProductInfo": {
"NumberOfItems": 1
},
"PointsGranted": null,
"ItemPrice": {
"CurrencyCode": "USD",
"Amount": "89.99"
},
"ShippingPrice": {
"CurrencyCode": "USD",
"Amount": "5.00"
},
"ItemTax": {
"CurrencyCode": "USD",
"Amount": "7.65"
},
"ShippingTax": {
"CurrencyCode": "USD",
"Amount": "0.45"
},
"ShippingDiscount": {
"CurrencyCode": "USD",
"Amount": "0.00"
},
"ShippingDiscountTax": {
"CurrencyCode": "USD",
"Amount": "0.00"
},
"PromotionDiscount": {
"CurrencyCode": "USD",
"Amount": "0.00"
},
"PromotionDiscountTax": {
"CurrencyCode": "USD",
"Amount": "0.00"
},
"PromotionIds": [],
"CODFee": {
"CurrencyCode": "USD",
"Amount": "0.00"
},
"CODFeeDiscount": {
"CurrencyCode": "USD",
"Amount": "0.00"
},
"IsGift": false,
"ConditionNote": null,
"ConditionId": "New",
"ConditionSubtypeId": "New",
"ScheduledDeliveryStartDate": null,
"ScheduledDeliveryEndDate": null,
"PriceDesignation": null,
"TaxCollection": {
"Model": "MarketplaceFacilitator",
"ResponsibleParty": "Amazon Services, Inc."
},
"SerialNumberRequired": false,
"IsTransparency": false,
"IossNumber": null,
"StoreChainStoreId": null,
"DeemedResellerCategory": "IOSS",
"BuyerInfo": null
}
],
"NextToken": null
}
}
Get Order Items Buyer Info
Returns buyer information for the order items in the order that you specify. | key: getOrderItemsBuyerInfo
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Order Id | An Amazon-defined order identifier in 3-7-7 format. | 123-1234567-1234567 |
{
"data": {
"AmazonOrderId": "902-3159896-1390916",
"OrderItems": [
{
"OrderItemId": "52852651034158",
"BuyerCustomizedInfo": {
"CustomizedURL": null
},
"GiftWrapPrice": {
"CurrencyCode": "USD",
"Amount": "0.00"
},
"GiftWrapTax": {
"CurrencyCode": "USD",
"Amount": "0.00"
},
"GiftMessageText": null,
"GiftWrapLevel": null
}
],
"NextToken": null
}
}
Get Shipment
Returns the shipment information for an existing shipment. | key: getShipment
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Shipment Id | The Amazon-defined shipment identifier for the shipment. | 6f77095e-9f75-47eb-aaab-a42d5428fa1a |
{
"data": {
"Shipment": {
"ShipmentId": "MWSTestShipment123456789",
"AmazonOrderId": "902-3159896-1390916",
"SellerOrderId": "MY-ORDER-123",
"ItemList": [
{
"OrderItemId": "52852651034158",
"Quantity": 1
}
],
"ShipFromAddress": {
"Name": "ACME Warehouse",
"AddressLine1": "456 ACME Blvd",
"AddressLine2": "Suite 200",
"City": "Seattle",
"StateOrProvinceCode": "WA",
"PostalCode": "98101",
"CountryCode": "US",
"Email": "warehouse@example.com",
"Phone": "555-987-6543"
},
"ShipToAddress": {
"Name": "John Doe",
"AddressLine1": "123 Main Street",
"AddressLine2": "Apt 4B",
"City": "Seattle",
"StateOrProvinceCode": "WA",
"PostalCode": "98101",
"CountryCode": "US",
"Email": null,
"Phone": "555-123-4567"
},
"PackageDimensions": {
"Length": 10,
"Width": 8,
"Height": 6,
"Unit": "inches",
"PredefinedPackageDimensions": "FedEx_Box_10kg"
},
"Weight": {
"Value": 2.5,
"Unit": "pounds"
},
"Insurance": {
"Amount": {
"CurrencyCode": "USD",
"Amount": 0
}
},
"ShippingService": {
"ShippingServiceName": "USPS Priority Mail",
"CarrierName": "USPS",
"ShippingServiceId": "usps-priority-mail",
"ShippingServiceOfferId": "offer123456",
"ShipDate": "2024-01-15T08:00:00Z",
"EarliestEstimatedDeliveryDate": "2024-01-17T08:00:00Z",
"LatestEstimatedDeliveryDate": "2024-01-19T20:00:00Z",
"Rate": {
"CurrencyCode": "USD",
"Amount": 7.5
},
"ShippingServiceOptions": {
"DeliveryExperience": "DeliveryConfirmationWithSignature",
"DeclaredValue": {
"CurrencyCode": "USD",
"Amount": 99.99
},
"CarrierWillPickUp": false,
"CarrierWillPickUpOption": null,
"LabelFormat": "PDF"
},
"AvailableLabelFormats": [
"PNG",
"PDF"
],
"AvailableFormatOptionsForLabel": [
{
"IncludePackingSlipWithLabel": false
}
],
"RequiresAdditionalSellerInputs": false
},
"Label": {
"CustomTextForLabel": null,
"Dimensions": {
"Length": 4,
"Width": 6,
"Unit": "inches"
},
"FileContents": {
"Contents": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwo+Pg==",
"FileType": "application/pdf",
"Checksum": "5d41402abc4b2a76b9719d911017c592"
},
"LabelFormat": "PDF",
"StandardIdForLabel": "AmazonOrderId"
},
"TrackingId": "1234567890123456789012",
"Status": "Purchased",
"CreatedDate": "2024-01-15T10:30:45.123Z",
"LastUpdatedDate": "2024-01-15T10:30:45.123Z"
}
}
}
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
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Notification Type | The type of notification. See the Notifications API documentation for available notification types. | |
| Subscription Id | The identifier for the subscription that you want to get. | 7fcacc7e-727b-11e9-8848-1681be663d3e |
{
"data": {
"subscriptionId": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
"payloadVersion": "1.0",
"destinationId": "d0e9e693-cd56-4d1f-b63a-418f2d169d4a",
"processingDirective": {
"eventFilter": {
"eventFilterType": "ANY_OFFER_CHANGED",
"marketplaceIds": [
"ATVPDKIKX0DER"
]
}
}
}
}
List Destinations
Returns information about all destinations. | key: listDestinations
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. |
{
"data": {
"destinations": [
{
"name": "Production SQS Queue",
"destinationId": "d0e9e693-cd56-4d1f-b63a-418f2d169d4a",
"resource": {
"sqs": {
"arn": "arn:aws:sqs:us-east-1:123456789012:SellerCentral-Notifications"
}
}
},
{
"name": "EventBridge Destination",
"destinationId": "f1a2b3c4-d5e6-7f8a-9b0c-1d2e3f4a5b6c",
"resource": {
"eventBridge": {
"accountId": "123456789012",
"region": "us-east-1",
"name": "aws.partner/sellingpartnerapi.amazon.com/456789/sellercentral-notifications"
}
}
}
]
}
}
List Feeds
Returns feed details for the feeds that match the filters that you specify. | key: listFeeds
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| 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. | 2024-01-01T00:00:00.000Z |
| Created Until | The latest feed creation date and time for feeds included in the response in ISO 8601 format. The default is now. | 2024-12-31T23:59:59.999Z |
| Feed Types | 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. <strong>Important:</strong> Either feedTypes or nextToken is required. | POST_PRODUCT_DATA |
| Marketplace Ids | List of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the Marketplace IDs documentation for a complete list of marketplaceId values. | |
| Next Token | String token returned in the response of your previous request for pagination. | amzn1.aos.4e9ba8a1-1234-5678-90ab-cdef12345678 |
| Page Size | The maximum number of feeds to return in a single call. | 25 |
| Processing Statuses | List of processing statuses used to filter feeds. |
{
"data": {
"feeds": [
{
"feedId": "23492834092",
"feedType": "POST_PRODUCT_DATA",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"createdTime": "2024-01-15T10:30:45.123Z",
"processingStatus": "DONE",
"processingStartTime": "2024-01-15T10:31:00.456Z",
"processingEndTime": "2024-01-15T10:35:22.789Z",
"resultFeedDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-ac12-1212121abcde.T3YUVYPGKE9BMY"
},
{
"feedId": "23492834091",
"feedType": "POST_INVENTORY_AVAILABILITY_DATA",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"createdTime": "2024-01-14T15:22:30.123Z",
"processingStatus": "IN_PROGRESS",
"processingStartTime": "2024-01-14T15:23:00.456Z",
"processingEndTime": null,
"resultFeedDocumentId": null
},
{
"feedId": "23492834090",
"feedType": "POST_PRODUCT_PRICING_DATA",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"createdTime": "2024-01-13T08:15:10.123Z",
"processingStatus": "CANCELLED",
"processingStartTime": null,
"processingEndTime": null,
"resultFeedDocumentId": null
}
],
"nextToken": "MjAyNC0wMS0xM1QwODoxNToxMC4xMjNa"
}
}
List Orders
Returns orders created or updated during the time frame indicated by the specified parameters. | key: listOrders
| Input | Notes | Example |
|---|---|---|
| Actual Fulfillment Supply Source Id | Denotes the recommended sourceId where the order should be fulfilled from. | SOURCE-12345 |
| Amazon Order Ids | 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. | buyer@example.com |
| Connection | The Amazon Seller Central connection to use. | |
| Created After | Date used for selecting orders created after (or at) a specified time in ISO 8601 format. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. | 2024-01-15T10:30:00.000Z |
| Created Before | Date used for selecting orders created before (or at) a specified time in ISO 8601 format. Only orders placed before the specified time are returned. | 2024-12-31T23:59:59.999Z |
| Easy Ship Shipment Statuses | 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 | List of ElectronicInvoiceStatus values. Used to select orders with electronic invoice statuses that match the specified values. | |
| Fulfillment Channels | 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 | Date used for selecting orders that were last updated after (or at) a specified time in ISO 8601 format. 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. | 2024-01-15T10:30:00.000Z |
| Last Updated Before | Date used for selecting orders that were last updated before (or at) a specified time in ISO 8601 format. 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. | 2024-12-31T23:59:59.999Z |
| Marketplace Ids | List of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the Marketplace IDs documentation for a complete list of marketplaceId values. | |
| Max Results Per Page | Maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. | 50 |
| Next Token | String token returned in the response of your previous request for pagination. | amzn1.aos.4e9ba8a1-1234-5678-90ab-cdef12345678 |
| Order Statuses | List of OrderStatus values used to filter the results. Select one or more of: PendingAvailability, Pending, Unshipped, PartiallyShipped, Shipped, Canceled, Unfulfillable, or InvoiceUnconfirmed. | |
| Payment Methods | 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. <strong>Important:</strong> If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified. | ORDER-12345 |
| Store Chain Store Id | The store chain store identifier. Linked to a specific store in a store chain. | STORE-12345 |
{
"data": {
"Orders": [
{
"AmazonOrderId": "902-3159896-1390916",
"PurchaseDate": "2024-01-15T10:30:45.123Z",
"LastUpdateDate": "2024-01-15T14:22:10.456Z",
"OrderStatus": "Shipped",
"FulfillmentChannel": "MFN",
"SalesChannel": "Amazon.com",
"OrderChannel": "AFN",
"ShipServiceLevel": "Std US D2D Dom",
"OrderTotal": {
"CurrencyCode": "USD",
"Amount": "99.99"
},
"NumberOfItemsShipped": 1,
"NumberOfItemsUnshipped": 0,
"PaymentMethod": "Other",
"PaymentMethodDetails": [
"Standard"
],
"MarketplaceId": "ATVPDKIKX0DER",
"ShipmentServiceLevelCategory": "Standard",
"OrderType": "StandardOrder",
"EarliestShipDate": "2024-01-15T08:00:00Z",
"LatestShipDate": "2024-01-16T07:59:59Z",
"IsBusinessOrder": false,
"IsPrime": false,
"IsPremiumOrder": false
},
{
"AmazonOrderId": "112-7628145-8392418",
"PurchaseDate": "2024-01-14T15:22:30.789Z",
"LastUpdateDate": "2024-01-14T16:45:55.123Z",
"OrderStatus": "Pending",
"FulfillmentChannel": "AFN",
"SalesChannel": "Amazon.com",
"OrderChannel": "AFN",
"ShipServiceLevel": "Expedited",
"OrderTotal": {
"CurrencyCode": "USD",
"Amount": "149.99"
},
"NumberOfItemsShipped": 0,
"NumberOfItemsUnshipped": 2,
"PaymentMethod": "Other",
"PaymentMethodDetails": [
"Standard"
],
"MarketplaceId": "ATVPDKIKX0DER",
"ShipmentServiceLevelCategory": "Expedited",
"OrderType": "StandardOrder",
"EarliestShipDate": "2024-01-14T08:00:00Z",
"LatestShipDate": "2024-01-15T07:59:59Z",
"IsBusinessOrder": false,
"IsPrime": true,
"IsPremiumOrder": false
}
],
"NextToken": "2YgYW55IGNhcm5hbCBwbGVhc3VyZS4",
"CreatedBefore": "2024-01-15T23:59:59Z"
}
}
List Subscription
Returns information about subscriptions of the specified notification type. | key: listSubscriptions
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| Notification Type | The type of notification. See the Notifications API documentation for available notification types. |
{
"data": {
"subscriptions": [
{
"subscriptionId": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
"payloadVersion": "1.0",
"destinationId": "d0e9e693-cd56-4d1f-b63a-418f2d169d4a",
"processingDirective": {
"eventFilter": {
"eventFilterType": "ANY_OFFER_CHANGED",
"marketplaceIds": [
"ATVPDKIKX0DER"
]
}
}
},
{
"subscriptionId": "b2c3d4e5-f6a7-8b9c-0d1e-2f3a4b5c6d7e",
"payloadVersion": "1.0",
"destinationId": "d0e9e693-cd56-4d1f-b63a-418f2d169d4a",
"processingDirective": {
"eventFilter": {
"eventFilterType": "ORDER_CHANGE",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"orderChangeTypes": [
"OrderStatusChange",
"BuyerRequestedChange"
]
}
}
},
{
"subscriptionId": "c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f",
"payloadVersion": "1.0",
"destinationId": "d0e9e693-cd56-4d1f-b63a-418f2d169d4a",
"processingDirective": {
"eventFilter": {
"eventFilterType": "FEED_PROCESSING_FINISHED"
}
}
}
]
}
}
Raw Request
Send raw HTTP request to Amazon Seller Central | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| 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
| Input | Notes | Example |
|---|---|---|
| Brand Names | List of brand names to limit the search for keywords-based queries. <strong>Important:</strong> Cannot be used with identifiers. | Samsung |
| Classification Ids | List of classification identifiers to limit the search for keywords-based queries. <strong>Important:</strong> Cannot be used with identifiers. | 12345678 |
| Connection | The Amazon Seller Central connection to use. | |
| Identifiers | List of product identifiers to search the Amazon catalog for. <strong>Important:</strong> Cannot be used with keywords. | B07H65KP63 |
| Identifiers Type | Type of product identifiers to search the Amazon catalog for. <strong>Important:</strong> Required when identifiers are provided. | |
| Included Data | List of data sets to include in the response. Default: summaries. | |
| Keywords | List of words to search the Amazon catalog for. <strong>Important:</strong> Cannot be used with identifiers. | laptop |
| Keywords Locale | The language of the keywords provided for keywords-based queries. Defaults to the primary locale of the marketplace. <strong>Important:</strong> 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 the Marketplace IDs documentation for a complete list of marketplaceId values. | |
| Page Size | The maximum number of feeds to return in a single call. | 25 |
| Page Token | Token to fetch a certain page when there are multiple pages worth of results. | amzn1.page.12345678-90ab-cdef-1234-567890abcdef |
| Seller Id | A selling partner identifier, such as a seller account or vendor code. <strong>Important:</strong> Required when identifiersType is SKU. | A2EXAMPLE123456 |
{
"data": {
"numberOfResults": 2,
"pagination": {
"nextToken": "Q3VzdG9tZXJGZWVkYmFjazoxOjE"
},
"refinements": {
"brands": [
{
"numberOfResults": 2,
"brandName": "ACME"
}
],
"classifications": [
{
"numberOfResults": 2,
"displayName": "Electronics",
"classificationId": "12345678"
}
]
},
"items": [
{
"asin": "B07XJ8C8F5",
"attributes": {
"condition_type": [
{
"value": "new_new",
"language": "en_US"
}
],
"item_name": [
{
"value": "ACME Product Name - Premium Edition",
"language": "en_US",
"marketplace_id": "ATVPDKIKX0DER"
}
],
"brand": [
{
"value": "ACME",
"language": "en_US"
}
],
"list_price": [
{
"value": 99.99,
"currency": "USD",
"marketplace_id": "ATVPDKIKX0DER"
}
],
"product_category": [
{
"value": "ELECTRONIC_COMPONENTS_AND_EQUIPMENT"
}
]
},
"identifiers": [
{
"identifierType": "ASIN",
"identifier": "B07XJ8C8F5"
},
{
"identifierType": "EAN",
"identifier": "1234567890123"
}
],
"images": [
{
"variant": "MAIN",
"link": "https://m.media-amazon.com/images/I/acme-image._AC_US200_.jpg",
"height": 200,
"width": 200
}
],
"productTypes": [
{
"productType": "ELECTRONIC_COMPONENT"
}
],
"salesRanks": [
{
"classificationRanks": [
{
"rank": 42,
"title": "Electronics",
"link": "https://www.amazon.com/gp/bestsellers/electronics"
}
],
"displayGroupRanks": []
}
],
"summaries": [
{
"marketplaceId": "ATVPDKIKX0DER",
"adultProduct": false,
"autographed": false,
"brand": "ACME",
"browseClassification": {
"displayName": "Electronics",
"classificationId": "12345678"
},
"color": "Black",
"itemClassification": "BASE_PRODUCT",
"itemName": "ACME Product Name - Premium Edition",
"manufacturer": "ACME Corporation",
"memorabilia": false,
"modelNumber": "EX-123-BLK",
"packageQuantity": 1,
"size": "Medium",
"style": "Modern"
}
],
"vendorDetails": []
},
{
"asin": "B08N5WRWNW",
"attributes": {
"condition_type": [
{
"value": "new_new",
"language": "en_US"
}
],
"item_name": [
{
"value": "Another ACME Product",
"language": "en_US",
"marketplace_id": "ATVPDKIKX0DER"
}
],
"brand": [
{
"value": "ACME",
"language": "en_US"
}
],
"list_price": [
{
"value": 149.99,
"currency": "USD",
"marketplace_id": "ATVPDKIKX0DER"
}
]
},
"identifiers": [
{
"identifierType": "ASIN",
"identifier": "B08N5WRWNW"
}
],
"productTypes": [
{
"productType": "ELECTRONIC_COMPONENT"
}
],
"summaries": [
{
"marketplaceId": "ATVPDKIKX0DER",
"adultProduct": false,
"autographed": false,
"brand": "ACME",
"itemClassification": "BASE_PRODUCT",
"itemName": "Another ACME Product",
"packageQuantity": 1
}
]
}
]
}
}
Update Listings Item
Partially update (patch) a listings item for a selling partner. | key: updateListingsItem
| Input | Notes | Example |
|---|---|---|
| Connection | The Amazon Seller Central connection to use. | |
| 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 the Marketplace IDs documentation 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. | LUGGAGE |
| Seller Id | A selling partner identifier, such as a seller account or vendor code. <strong>Important:</strong> Required when identifiersType is SKU. | A2EXAMPLE123456 |
| Stock Keeping Unit (SKU) | A selling partner provided identifier for an Amazon listing. | MY-PRODUCT-SKU-001 |
{
"data": {
"sku": "MY-SKU-12345",
"status": "ACCEPTED",
"submissionId": "g2ed392586ee22fbb782eg45e75dd333",
"issues": []
}
}
Changelog
2026-01-28
Added inline data sources for Order ID, Feed ID, and Destination ID inputs to enable dynamic dropdowns.