Amazon Selling Partner
Procedures and concepts for the Amazon Selling Partner integration.
The following documentation is for Amazon Selling Partner v2.0.1 (BDK).
Overview
Amazon Selling Partner connects you to Amazon's marketplace to automate order retrieval and processing. This integration allows you to pull order data from your Amazon seller account and integrate it seamlessly into your workflows.
Prerequisites
1. Required Books
The following Book(s) need to be added to your agent so it can learn and understand the automation procedures defined within them:
Amazon Selling Partner
How to Add the Book(s)
Go to Books → All Books.
Search for the name of the book and click on it.
Click on Install or Add Connection to add the book to your agent.
If adding a connection, you'll be prompted for connectivity details.
Connectivity
This section outlines the available methods for connecting to the Book, along with the required configuration details for each.
This books supports the connectivity methods described in this section.In here you will find information about what information is required in order to employ each method.
Connect using Refresh Token, Client ID and Client Secret
Connect to Amazon Selling Partner API using LWA OAuth credentials.
Refresh Token
LWA refresh token from Seller Central
sensitive
Client ID
LWA client ID (starts with amzn1.application-oa2-client)
text
Client Secret
LWA client secret
sensitive
Procedures
to retrieve (orders)
Retrieve orders from Amazon Selling Partner API.
Input Concepts
marketplace
Amazon marketplace (e.g., US, CA, GB)
enum[ae, au, be, br, ca, de, eg, es, fr, gb, in, it, jp, mx, nl, pl, sa, sandbox, se, sg, tr, us, za]
No
{'class_name': 'Marketplace', 'name': 'US', 'value': 'US'}
createdafter
Filter orders created after this date (e.g., "2024-11-01T00:00:00Z")
text
No
(no default)
last updated
Filter orders last updated after this date (e.g., "2024-11-01T00:00:00Z")
text
No
(no default)
Output Concepts
Examples
Get orders created after a specific date
Get orders last updated after a specific date
to retrieve an (order) from amazon selling partner
Retrieve order details from Amazon Selling Partner API.
Input Concepts
marketplace
Amazon marketplace (e.g., US, CA, GB)
enum[ae, au, be, br, ca, de, eg, es, fr, gb, in, it, jp, mx, nl, pl, sa, sandbox, se, sg, tr, us, za]
Yes
(no default)
order id
The Amazon order identifier (e.g., "123-4567890-1234567")
text
Yes
(no default)
Output Concepts
Examples
Get a specific order by ID
Get order and check status
Get order and extract buyer email
Concepts
Amazon order
Amazon Selling Partner order information.
amazon_order_id
The unique Amazon order identifier.
text
order_status
The current status of the order.
text
purchase_date
The date when the order was purchased.
text
last_update_date
The date when the order was last updated.
text
marketplace_id
The Amazon marketplace identifier.
optional[text]
fulfillment_channel
The fulfillment channel (e.g., MFN, AFN).
optional[text]
order_type
The type of order.
optional[text]
shipment_service_level_category
The shipment service level category.
optional[text]
earliest_ship_date
The earliest ship date.
optional[text]
latest_ship_date
The latest ship date.
optional[text]
earliest_delivery_date
The earliest delivery date.
optional[text]
latest_delivery_date
The latest delivery date.
optional[text]
number_of_items_shipped
The number of items shipped.
optional[number]
number_of_items_unshipped
The number of items unshipped.
optional[number]
payment_method
The payment method.
optional[text]
payment_method_details
List of payment method details.
optional[list of text]
is_business_order
Whether this is a business order.
optional[boolean]
is_prime
Whether this is a Prime order.
optional[boolean]
is_global_express_enabled
Whether global express is enabled.
optional[boolean]
is_premium_order
Whether this is a premium order.
optional[boolean]
is_sold_by_ab
Whether sold by Amazon Business.
optional[boolean]
is_iba
Whether this is an IBA order.
optional[boolean]
is_ispu
Whether this is an ISPU order.
optional[boolean]
is_access_point_order
Whether this is an access point order.
optional[boolean]
sales_channel
The sales channel.
optional[text]
order_channel
The order channel.
optional[text]
ship_service_level
The ship service level.
optional[text]
order_total
The order total amount.
optional[json]
payment_execution_detail
Payment execution details.
optional[list of json]
Concept attribute specifications
shipping_address (amazon order)
name
optional[text]
address_line1
optional[text]
address_line2
optional[text]
address_line3
optional[text]
city
optional[text]
county
optional[text]
district
optional[text]
state_or_region
optional[text]
municipality
optional[text]
postal_code
optional[text]
country_code
optional[text]
phone
optional[text]
address_type
optional[text]
default_ship_from_location_address (amazon order)
name
optional[text]
address_line1
optional[text]
address_line2
optional[text]
address_line3
optional[text]
city
optional[text]
county
optional[text]
district
optional[text]
state_or_region
optional[text]
municipality
optional[text]
postal_code
optional[text]
country_code
optional[text]
phone
optional[text]
address_type
optional[text]
buyer_info (amazon order)
buyer_email
optional[text]
buyer_name
optional[text]
buyer_county
optional[text]
buyer_tax_info
optional[json]
purchase_order_number
optional[text]
fulfillment_instruction (amazon order)
fulfillment_supply_source_id
optional[text]
automated_shipping_settings (amazon order)
has_automated_shipping_settings
optional[boolean]
automated_carrier
optional[text]
automated_ship_method
optional[text]
Last updated
Was this helpful?