ORDER_CONFIRMED
Buy with Prime API is now available for early access
Sign up for early access to the Buy with Prime API using the 'Sign Up' button below. The API may change as Amazon receives feedback and iterates on it.
The ORDER_CONFIRMED event is published when a new order is placed.
The following examples are ways that you might use this event:
- To serve as an initial notification for dependent systems that handle fulfillment.
- To inform your own reporting and customer communication processes.
Required permission
To subscribe to this event, your API credentials must have at least Read Order permission. You choose permissions when you generate your API credentials. For details, see Authenticate to the Buy with Prime API.
Schema
Schema for webhook destinations
{
"idempotencyKey":"example-idempotency-key",
"eventDescriptor": "ORDER_CONFIRMED",
"resources": [
"businessProduct/business-product-id/order/order-id"
],
"eventId":"example-event-id",
"apiVersion": "2024-11-01",
"subscriptionId": "example-subscription-id",
"eventTime":"2025-01-20T12:34:56Z",
"data": {
"order": {
"id": "example-order-id",
"metadata": [
{
"createdAt": "2025-01-20T12:34:56Z",
"executionState": "example-execution-state"
}
],
"aliases": [
{
"aliasId": "example-alias-id",
"aliasType": "example-alias-type"
}
],
"orderLinks": [
{
"destinationType": "example-destination-type",
"displayMessage": "example-display-message",
"url": "example-order-link-url"
}
],
"customer": [
{
"bwpCustomerId": "example-bwp-customer-id",
"contact": {
"email": "example-contact-email",
"id": "example-contact-id",
"name": "example-contact-name"
}
}
],
"lineItems": [
{
"id": "example-line-item-id",
"aliases": {
"aliasId": "example-alias-id",
"aliasType": "example-alias-type"
},
"amount": {
"unit": "example-amount-unit",
"value": "example-amount"
},
"product": {
"amazonSku": {
"marketplaceId": "example-amazonsku-marketplace-id",
"value": "example-amazonsku"
},
"externalId": {
"value": "example-external-id"
},
"image": {
"displayReadyUrl": "example-display-ready-url"
},
"offerPrime": "true",
"price": {
"amount": "20.0",
"currencyCode": "example-currency-code-string"
},
"productDetailPageUrl": "example-product-detail-page-url",
"productId": {
"value": "example-product-id"
},
"purchaseGroupMembership": {
"memberAmount": {
"unit": "example-member-amount-unit",
"value": "example-member-amount"
}
},
"sku": {
"value": "example-sku"
},
"title": "example-title",
"variationSelections": {
"dimension": "example-variation-selections-dimension",
"value": "example-variation-selections"
}
},
"taxes": {
"summary": {
"collectableTaxAmount": {
"amount": "example-taxes-amount",
"currencyCode": "example-currency-code-string"
}
}
}
}
],
"payments": [
{
"details": {
"aliases": {
"aliasId": "example-alias-id",
"aliasType": "example-alias-type"
},
"amount": {
"amount": "example-payments-amount",
"currencyCode": "example-currency-code-string"
},
"id": "example-payments-id",
"paymentMethod": {
"displayString": "example-payment-method-display-string",
"type": "example-payment-method-type"
}
},
"summary": {
"amount": {
"amount": "example-summary-amount",
"currencyCode": "example-currency-code-string"
}
}
}
],
"recipient": [
{
"id": "example-recipient-id",
"contact": {
"id": "example-contact-id",
"email": "example-contact-email",
"name": "example-contact-name"
},
"deliveryAddress": {
"id": "example-delivery-address-id",
"countryCode": "example-delivery-address-country-code",
"extendedAddress": "example-delivery-address-extended-address",
"locality": "example-delivery-address-locality",
"name": "example-delivery-address-name",
"phoneNumber": "example-delivery-address-phone-number",
"postalCode": "example-delivery-address-postal-code",
"region": "example-delivery-address-region",
"streetAddress": "example-delivery-address-street-address",
"timezoneId": "example-delivery-address-time-zone-id",
}
}
],
"taxes": [
{
"summary": {
"collectableTaxAmount": {
"amount": "example-collectable-tax-amount",
"currencyCode": "example-currency-code-string"
}
}
}
],
"totalPrice": [
{
"rollupCharges": {
"rollupChargeType": "example-roll-up-charge-type",
"value": {
"amount": "example-roll-up-charge-value",
"currencyCode": "example-currency-code-string"
}
},
"value": {
"amount": "total-price-amount",
"currencyCode": "example-currency-code-string"
},
"verified": "true"
}
]
}
}
}
Schema for Amazon EventBridge destinations
{
"version": "0",
"id": "example-event-id",
"detail-type": "ORDER_CONFIRMED",
"source": "aws.partner/buywithprime/partner-event-source-name",
"account": "example-aws-account-id",
"time": "2025-01-20T12:34:56Z",
"region": "us-east-1",
"resources": [
"businessProduct/business-product-id/order/order-id"
],
"detail": {
"idempotencyKey":"example-idempotency-key",
"eventDescriptor": "ORDER_CONFIRMED",
"resources": [
"businessProduct/business-product-id/order/order-id"
],
"eventId":"example-event-id",
"apiVersion": "2024-11-01",
"subscriptionId": "example-subscription-id",
"eventTime":"2025-01-20T12:34:56Z",
"data": {
"order": {
"id": "example-order-id",
"metadata": [
{
"createdAt": "2025-01-20T12:34:56Z",
"executionState": "example-execution-state"
}
],
"aliases": [
{
"aliasId": "example-alias-id",
"aliasType": "example-alias-type"
}
],
"orderLinks": [
{
"destinationType": "example-destination-type",
"displayMessage": "example-display-message",
"url": "example-order-link-url"
}
],
"customer": [
{
"bwpCustomerId": "example-bwp-customer-id",
"contact": {
"email": "example-contact-email",
"id": "example-contact-id",
"name": "example-contact-name"
}
}
],
"lineItems": [
{
"id": "example-line-item-id",
"aliases": {
"aliasId": "example-alias-id",
"aliasType": "example-alias-type"
},
"amount": {
"unit": "example-amount-unit",
"value": "example-amount"
},
"product": {
"amazonSku": {
"marketplaceId": "example-amazonsku-marketplace-id",
"value": "example-amazonsku"
},
"externalId": {
"value": "example-external-id"
},
"image": {
"displayReadyUrl": "example-display-ready-url"
},
"offerPrime": "true",
"price": {
"amount": "20.0",
"currencyCode": "example-currency-code-string"
},
"productDetailPageUrl": "example-product-detail-page-url",
"productId": {
"value": "example-product-id"
},
"purchaseGroupMembership": {
"memberAmount": {
"unit": "example-member-amount-unit",
"value": "example-member-amount"
}
},
"sku": {
"value": "example-sku"
},
"title": "example-title",
"variationSelections": {
"dimension": "example-variation-selections-dimension",
"value": "example-variation-selections"
}
},
"taxes": {
"summary": {
"collectableTaxAmount": {
"amount": "example-taxes-amount",
"currencyCode": "example-currency-code-string"
}
}
}
}
],
"payments": [
{
"details": {
"aliases": {
"aliasId": "example-alias-id",
"aliasType": "example-alias-type"
},
"amount": {
"amount": "example-payments-amount",
"currencyCode": "example-currency-code-string"
},
"id": "example-payments-id",
"paymentMethod": {
"displayString": "example-payment-method-display-string",
"type": "example-payment-method-type"
}
},
"summary": {
"amount": {
"amount": "example-summary-amount",
"currencyCode": "example-currency-code-string"
}
}
}
],
"recipient": [
{
"id": "example-recipient-id",
"contact": {
"id": "example-contact-id",
"email": "example-contact-email",
"name": "example-contact-name"
},
"deliveryAddress": {
"id": "example-delivery-address-id",
"countryCode": "example-delivery-address-country-code",
"extendedAddress": "example-delivery-address-extended-address",
"locality": "example-delivery-address-locality",
"name": "example-delivery-address-name",
"phoneNumber": "example-delivery-address-phone-number",
"postalCode": "example-delivery-address-postal-code",
"region": "example-delivery-address-region",
"streetAddress": "example-delivery-address-street-address",
"timezoneId": "example-delivery-address-time-zone-id",
}
}
],
"taxes": [
{
"summary": {
"collectableTaxAmount": {
"amount": "example-collectable-tax-amount",
"currencyCode": "example-currency-code-string"
}
}
}
],
"totalPrice": [
{
"rollupCharges": {
"rollupChargeType": "example-roll-up-charge-type",
"value": {
"amount": "example-roll-up-charge-value",
"currencyCode": "example-currency-code-string"
}
},
"value": {
"amount": "total-price-amount",
"currencyCode": "example-currency-code-string"
},
"verified": "true"
}
]
}
}
}
}
Fields
| Key | Data type | Description |
|---|---|---|
version | String | Amazon EventBridge event version. |
id | String | Amazon EventBridge-generated UUID for an event. |
detail-type | String | Type schema for the detail of the event, which in this case is ORDER_CONFIRMED. |
source | String | Name of the partner event source in Amazon EventBridge. For details, see Subscribe to Events. |
account | String | AWS account ID that hosts the partner event source. |
time | String | ISO 8601 timestamp that indicates when the event was published. |
region | String | AWS region from which the event was published. |
resources | Array of strings | Array of identifiers for the resources that triggered the event, in key-value pair format. Each resource identifier is a string that starts with businessProduct/{businessProductId}/, followed by resource types (keys) and resource IDs (values) separated by forward slashes. For details about how to interpret resources, see Subscribe to Events. |
detail | Object | JSON object that contains details about the event. You can call the Buy with Prime API to find further information about the resource(s) specified in the resources array. For details, see detail fields. |
Detail fields
| Key | Data type | Description |
|---|---|---|
idempotencyKey | String | Unique identifier to detect duplicate events. |
eventDescriptor | String | Event type that determines the default query. |
resources | Array of strings | Array of identifiers for the resources that triggered the event, in key-value pair format. Each resource identifier is a string that starts with businessProduct/{businessProductId}/, followed by resource types (keys) and resource IDs (values) separated by forward slashes. This field is the same value as resources at the top level. |
eventId | String | Unique identifier for this event. This field is the same value as id at the top level. |
apiVersion | String | Buy with Prime API version associated with this event. |
subscriptionId | String | Unique identifier for an event subscription. |
eventTime | String | ISO 8601 timestamp that indicates when the event was published. This field is the same value as time at the top level. |
data | Object | JSON object that can contain API response data. The ORDER_CONFIRMED event's data payload contains the associated order object. |
Handling the event
When you receive this event, you typically parse the included order information found in the data object to fetch more information about all line items in the order.
If you require information not found in the data object, query the order using the order ID found in the resources array.
Related topics
Updated 1 day ago