Skip to main content
POST
Simulate Purchase
Subtotal Connector tool: simulate_purchase Creates a simulated purchase on one of your simulated connections, with random products from the connection’s retailer, dated now, and sends purchase.created to webhook destinations that accept simulated events. Every call creates a new purchase. Read it with Get a purchase. The purchase includes at least one of your brands’ products when the retailer sells one. A real, deleted or unknown connection returns 404, and nothing is created. Call it with your API key, or with a Subtotal Connector OAuth token that includes simulator:write. A token without it receives 403 insufficient_scope. Partner app tokens don’t include it.

Headers

authorization
string | null
x-api-key
string | null

Path Parameters

connection_id
string
required

Response

Successful Response

purchase_id
string
required

The simulated purchase, readable like any other purchase

Example:

"01J51S0JYV6N7K1030CV1ZKSCA"