Purchase

Get a purchase by ID

get
Paramètres de requête
idstringRequis

The UUID of the purchase to retrieve

Paramètres d'en-tête
X-API-KEYstringRequis

Partner API Key

X-API-SECRETstringRequis

Partner API Secret

Réponses
chevron-right
200

The purchase has been successfully retrieved.

application/json
idstringRequis

Unique identifier

createdAtstring · date-timeRequis

Creation timestamp

updatedAtstring · date-timeRequis

Last update timestamp

storeIdstringRequis

Store identifier

storeNamestringRequis

Store name

datestring · date-timeRequis

Date of the purchase

startDatestring · date-timeRequis

Start date of the purchase validity (eg. for hotel reservations)

endDatestring · date-timeRequis

End date of the purchase validity (eg. for hotel reservations)

externalIdstringRequis

External identifier of the purchase

sourceall ofRequis

Source of the purchase

string · enumOptionnelValeurs possibles:
get
/partners/purchase

Import a single purchase

post

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

Paramètres de requête
allowSurveybooleanOptionnel

Whether to allow survey processing for these purchases

Default: false
Paramètres d'en-tête
X-API-KEYstringRequis

Partner API Key

X-API-SECRETstringRequis

Partner API Secret

Corps
externalIdstring · nullableOptionnel

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

metadataobjectOptionnel

Additional metadata to store with the purchase

storeIdstringRequis

Store identifier

customerIdstringRequis

Customer identifier

datestring · date-timeRequis

Date of the purchase

startDatestring · date-timeRequis

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

endDatestring · date-timeRequis

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

Réponses
post
/partners/purchase

List purchases

post
Paramètres d'en-tête
X-API-KEYstringRequis

Partner API Key

X-API-SECRETstringRequis

Partner API Secret

Corps
limitnumber · min: 1 · max: 100Optionnel

Pagination limit

Default: 10
pagenumber · min: 1Optionnel

Page to retrieve

Default: 1
fromstring · nullableOptionnel

Date range start

tostring · nullableOptionnel

Date range end

storesstring[] · min: 1 · max: 100 · nullableOptionnel

Store IDs to filter purchases

customersstring[] · min: 1 · max: 100 · nullableOptionnel

Customer IDs to filter purchases

externalIdsstring[] · min: 1 · max: 100 · nullableOptionnel

External IDs to filter purchases

Réponses
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.

Paramètres de requête
allowSurveybooleanOptionnel

Whether to allow survey processing for these purchases

Default: false
Paramètres d'en-tête
X-API-KEYstringRequis

Partner API Key

X-API-SECRETstringRequis

Partner API Secret

Corps
Réponses
post
/partners/purchase/batch

Aucun contenu

Mis à jour