Procedures

Automation procedures in the Amazon Selling Partner book.

The following documentation is for Amazon Selling Partner v1.0.0 (BDK).

Ensure that you have installed or connected the Amazon Selling Partner book and created a new playground before using these automation procedures.

to retrieve (orders)

Retrieve orders from Amazon Selling Partner API.

Input Concepts

Concept	Description	Type	Required	Default Value
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

Concept	Description	Type
orders	List of Order objects	amazon order

Examples

Get orders created after a specific date

retrieve orders from amazon selling partner with
    the marketplace is "US"
    the createdafter is "2024-11-01T00:00:00Z"
    the limit is 100

Get orders last updated after a specific date

retrieve orders from amazon selling partner with
    the marketplace is "US"
    the last updated is "2024-11-01T00:00:00Z"

to retrieve an (order) from amazon selling partner

Retrieve order details from Amazon Selling Partner API.

Input Concepts

Concept	Description	Type	Required	Default Value
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

Concept	Description	Type
order	Order object with all available information	amazon order

Examples

Get a specific order by ID

retrieve an order from amazon selling partner with
    the marketplace is "US"
    the order id is "902-3159896-1390916"

Get order and check status

retrieve an order from amazon selling partner with
    the marketplace is "US"
    the order id is the customer order number
if the order's order status is "Pending"
    show "Order is pending"

Get order and extract buyer email

retrieve an order from amazon selling partner with
    the marketplace is "US"
    the order id is "123-4567890-1234567"
show the order's buyer info's buyer email