Resources

The Yocuda Receipt API can only be accessed using HTTPS and standard protocols should be followed to ensure that the certificate for the API domain is valid.

The Yocuda Receipt API can be accessed using the following URLs:

• Production: https://api.ereceipts.co.uk/

• Staging: https://api.staging.ereceipts.co.uk/

Versions

Where multiple versions of a resource exists these will, in the tables below, be prefixed with a version number. The version number (without the v) can be used in the ereceipts-api-version header to request a specific version of the resource. See Resource Versions for more information.

Receipts

Resource	Description
v1: GET /receipts v2: GET /receipts	Get a list of receipts.
GET /receipts/_search	Search for receipts.
GET /receipts/{id}	Get a single receipt.
POST /receipts	Post a single receipt.
PATCH /receipts/{id}	Update a single receipt.
POST /receipts/_assign	Assign an identifier to a receipt.
POST /receipts/_send	Send a receipt.

Identifiers

Resource	Description
GET /identifiers	Get a series of Identifiers ordered by latest update_timestamp as first item.
GET /identifiers/_search	Search for an identifier.
GET /identifiers/{identifier}	Get meta-data associated with a consumer’s identifier.
GET /identifiers/{identifier}/passes/{scheme_id}	Get mobile wallet passes associated with a consumer’s identifier.
POST /identifiers	Create a new consumer identifier.
PATCH /identifiers/{identifier}	Associate meta-data with a consumer’s identifier.
POST /identifiers/_validate	Validate an identifier (e.g. email addresses).

Email

Resource	Description
POST /email	deprecated: use POST /receipts/_send instead

Loyalty

Resource	Description
GET /loyalty	Get a list of loyalty programs.
GET /loyalty/{program_id}	Get a single loyalty program.
GET /loyalty/{program_id}/identifiers	Get a list of loyalty identifiers and their values.
GET /loyalty/{program_id}/identifiers/{identifier}	Get a single loyalty identifier and its value.
PATCH /loyalty/{program_id}/identifiers/{identifier}	Update a single loyalty identifier.
GET /loyalty/{program_id}/identifiers/{identifier}/events	Get a list of events associated with a loyalty identifier.
GET /loyalty/{program_id}/rewards	Get a list of loyalty rewards.
GET /loyalty/{program_id}/rewards/{id}	Get a single loyalty reward.
PATCH /loyalty/{program_id}/rewards/{id}	Update a single loyalty reward.

Cards

Resource	Description
POST /cards	Verify a card against a verification code

POS

Resource	Description
GET /pos/status	Get a list of tills and their status.
POST /pos/data	Post a pos data packet.
POST /pos/receipts	Post a raw receipt.

Widgets

Resource	Description
GET /widget	Get an HTML widget.

Stores

Resource	Description
GET /stores	Get a list of all stores.
GET /stores/{reference}	Get a single store.
POST /stores	Create a new store.
PATCH /stores/{reference}	Update a store.
DELETE /stores/{reference}	Delete a store.

Client Credentials

Resource	Description
GET /clients/{authentication}	Get a list of client credentials.
POST /clients/{authentication}	Post a single client credential.
GET /clients/{authentication}/{client_id}	Get a single client credential.
PATCH /clients/{authentication}/{client_id}	Update a single client credential.

Attachments

Resource	Description
POST /attachments	Create a new attachment.

Retailer Portal Users

Resource	Description
GET /portal/users	Get a list of portal users.
GET /portal/user/{email}	Get a single portal user.
PUT /portal/user/{email}	Create or update a portal user.
PATCH /portal/user/{email}	Update an existing portal user.
PATCH /portal/user/{email}/_send_password_reset	Send a password reset email.