This documentation is currently under development. Certain sections are not yet complete and will be added shortly.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Receipts, vouchers, and sales documents

Use Cegid Retail Y2 sales documents, receipt PDFs, gift cards, and stored value in wallet pass journeys.

Beyond the customer record and loyalty, Cegid Retail Y2 holds transaction history and stored value. The connector exposes both to wallet journeys: sales documents and generated receipt PDFs, and the vouchers, gift cards, and certificates attached to a customer.

Real-world examples
  • A customer opens a recent receipt from a wallet pass instead of keeping the paper copy.

  • A gift card balance appears on a pass and is checked before the customer reaches the till.

  • A click-and-collect order is exposed on the pass so staff can find it by scanning.

Sales documents

The connector reads sales documents individually, by their Cegid key or by an external reference, and can retrieve a list of recent documents for a customer. These populate transaction history in a wallet journey.

Receipt PDFs

Where a rendered document is required rather than the underlying data, the connector generates a receipt PDF through Cegid. Generation is asynchronous: the connector requests the document, waits for Cegid to report it ready, then downloads it.

Which template Cegid uses is set per connection, as described in Configure the Cegid Retail Y2 connector. Leaving the template empty uses the Cegid default.

Vouchers, gift cards, and stored value

Cegid groups vouchers, gift cards, certificates, deposits, and customer accounts together. The connector reads those attached to a customer and exposes them in separate collections, so a template can address the relevant kind directly.

Collection
Contains

y2.bons.giftCards

Gift cards.

y2.bons.giftCertificates

Gift certificates.

y2.bons.loyaltyCertificates

Certificates issued by the loyalty programme.

y2.bons.accounts

Customer accounts.

y2.bons.deposits

Deposits.

Where a pass represents a gift card specifically, its identifier is verified against the card's own customer before the pass is served, so that a gift card pass cannot be used to read another customer's balance.

Held receipts

A flow step can raise a held receipt in Cegid: a document created in advance and completed at the till. It is used for click-and-collect and similar journeys where the transaction is prepared before the customer arrives.

Refreshing passes after an order

A scheduled task refreshes passes affected by recent orders, looking back one hour by default. It provides a reliable refresh where business notifications are not enabled, at a coarser granularity.

FAQ

Why is a receipt not generating?

The configured template identifier is the first thing to check, followed by whether the document exists in Cegid under the key being requested. Generation failures are reported by Cegid rather than by the connector.

Do receipt settings apply to every store?

They apply per connection. Where a brand runs one connection per store, a template set on some connections and not others produces different behaviour by store.

Last updated