Purchase

Get a purchase by ID

get
Query parameters
idstringRequired

The UUID of the purchase to retrieve

Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Responses
200

The purchase has been successfully retrieved.

application/json
get
/partners/purchase

Import a single purchase

post

When creating a purchase, if the pair externalId/source already exists, an error is thrown.

Query parameters
allowSurveybooleanOptional

Whether to allow survey processing for these purchases

Default: false
Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Body
externalIdstring | nullableOptional

External identifier (from another system, e.g. e-commerce order ID)

metadataobjectOptional

Additional metadata to store with the purchase

storeIdstringRequired

Store identifier

customerIdstringRequired

Customer identifier

datestring · date-timeRequired

Date of the purchase

startDatestring · date-timeRequired

Start date of the purchase (e.g. for a service)

endDatestring · date-timeRequired

End date of the purchase (e.g. for a service)

Responses
post
/partners/purchase

List purchases

post
Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Body
limitnumber · min: 1 · max: 100Optional

Pagination limit

Default: 10
pagenumber · min: 1Optional

Page to retrieve

Default: 1
fromstring | nullableOptional

Date range start

tostring | nullableOptional

Date range end

storesstring[] | nullableOptional

Store IDs to filter purchases

customersstring[] | nullableOptional

Customer IDs to filter purchases

externalIdsstring[] | nullableOptional

External IDs to filter purchases

Responses
post
/partners/purchase/list

Import a batch of purchase

post

When creating a purchase, if the pair externalId/source already exists, an error is thrown.

Query parameters
allowSurveybooleanOptional

Whether to allow survey processing for these purchases

Default: false
Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Body
Responses
post
/partners/purchase/batch

No content

Last updated