API ReferenceLoyalty API

Create a loyalty transaction

The Loyalty API is currently in beta.

Please contact our Support Team via our JIRA Service Desk for access to the Beta. If you don’t have access, please contact your account administrator for assistance.

Not yet integrated with Primer and interested in learning more? Contact us.

Create an API key with the loyalty-transactions:write scopes.

Create a loyalty transaction. This is either a points redemption or a points refund.

Headers

X-API-KEYstringRequired

Request

This endpoint expects an object.
connectionIdstringRequiredformat: "uuid"

ID of the Primer connection configuration.

customerIdstringRequired

The unique identifier for the customer on the loyalty provider.

orderIdstringRequired

Unique identifier for the order.

valueintegerRequired

The value of points to redeem.

typeenumOptional

The type of the transaction.

Allowed values:

Response

Successful Response

datedatetimeOptional

Creation date & time of the transaction (UTC)

idstringOptional

Unique Primer identifier for the loyalty transaction.

connectionIdstringOptionalformat: "uuid"

ID of the Primer connection configuration.

customerIdstringOptional

The unique identifier for the customer on the loyalty provider.

orderIdstringOptional

Unique identifier for the order.

connectionTransactionIdstringOptional

ID of the transaction on the loyalty provider’s side.

connectionNamestringOptional

Name of the loyalty provider.

typeenumOptional

The type of the transaction.

Allowed values:
valueintegerOptional

The value of the transaction.

Errors