Cegid

Retrieve Cegid receipt/ticket data

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/cegid/sandbox

Sandbox endpoint to retrieve receipt data from Cegid Y2 for testing and development. Returns raw JSON receipt structure for pass generation validation.

Authorization

Requires TenantConfigurationAccessControlled authorization

Path parameters

tenantIdstringRequired

Query parameters

keystringRequired

Receipt composite key in the form stump-number (e.g., ABC-1234).

Pattern: (?<Stump>.*)-(?<Number>\d+)

externalReferencestringRequired

External reference of the receipt used when key is not provided.

Responses

200

Receipt data returned

text/plainapplication/jsontext/json

anyOptional

400

Invalid receipt identifier

text/plainapplication/jsontext/json

401

Not authorized

text/plainapplication/jsontext/json

404

Receipt not found

text/plainapplication/jsontext/json

500

Internal server error while retrieving receipt

get

/api/{tenantId}/cegid/sandbox

HTTPcURLJavaScriptPython

GET /api/{tenantId}/cegid/sandbox?key=text&externalReference=text HTTP/1.1
Host: app.neostore.cloud
Accept: */*

No content

Simulate Cegid Y2 customer registration

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/cegid/sandbox/attachReceiptToCustomer

Test endpoint for customer registration workflow validation without connecting to production Cegid Y2. Simulates customer data creation and retrieval flows for sandbox testing.

Use Cases

• Validate customer registration form data

• Test receipt generation workflows

• Debug data transformation logic

• Verify webhook processing

Authorization

Requires TenantConfigurationAccessControlled authorization

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Query parameters

keystringRequired

Receipt composite key in the form stump-number (e.g., ABC-1234).

Pattern: (?<Stump>.*)-(?<Number>\d+)

externalReferencestringRequired

External reference of the receipt used when key is not provided.

Body

application/jsontext/jsonapplication/*+json

anyOptional

Responses

200

Customer linked to receipt successfully

text/plainapplication/jsontext/json

stringOptional

400

Invalid input payload or receipt identifier

text/plainapplication/jsontext/json

401

Not authorized

text/plainapplication/jsontext/json

500

Internal server error while attaching receipt

post

/api/{tenantId}/cegid/sandbox/attachReceiptToCustomer

HTTPcURLJavaScriptPython

POST /api/{tenantId}/cegid/sandbox/attachReceiptToCustomer?key=text&externalReference=text HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*

application/jsontext/jsonapplication/*+json

text

List Cegid civilities (titles)

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/cegid/settings/civilities

Retrieves available civility titles (Mr., Mrs., Dr., Prof., etc.) from Cegid Y2 system. Civilities are localized based on configured language and used in customer registration.

Civility Types

Common civilities include:

• Mr. (M., Monsieur, Herr, etc.)

• Mrs. (Mme., Madame, Frau, etc.)

• Ms. (Mlle., Mademoiselle, Fräulein, etc.)

• Dr., Prof., Dr.-Ing., and other professional titles

Use Cases

• Populate civility dropdown in registration forms

• Support culturally appropriate title selection

• Enable localized customer communication

Authorization

Requires Y2Settings.Read scope

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Civilities returned

No content

401

Not authorized

text/plainapplication/jsontext/json

500

Internal server error while retrieving civilities

get

/api/{tenantId}/cegid/settings/civilities

HTTPcURLJavaScriptPython

GET /api/{tenantId}/cegid/settings/civilities HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

List Cegid countries and regions

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/cegid/settings/countries

Retrieves supported countries and regions from Cegid Y2 system with ISO codes and localization. Used for customer registration form building and address validation configuration.

Use Cases

• Populate country dropdowns in registration forms

• Validate addresses against supported locations

• Configure locale-specific field requirements

• Support multi-country deployments

Authorization

Requires Y2Settings.Read scope

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Countries and regions returned

No content

401

Not authorized

text/plainapplication/jsontext/json

500

Internal server error while retrieving countries

get

/api/{tenantId}/cegid/settings/countries

HTTPcURLJavaScriptPython

GET /api/{tenantId}/cegid/settings/countries HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Verify country ISO code uniqueness

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/cegid/settings/countries/test

Validates that all country ISO codes in Cegid Y2 are unique with no conflicts. Used for configuration diagnostics and integration health checks.

Validation Rules

• ISO 3166-1 numeric codes (e.g., 250 for France) must be unique

• ISO 3166-1 alpha-2 codes (e.g., FR) must be unique

• ISO 3166-1 alpha-3 codes (e.g., FRA) must be unique

• Duplicate values may indicate data corruption or configuration issues

Use Cases

• Health check during integration setup

• Diagnose duplicate country entries

• Validate data integrity before production rollout

Authorization

Requires Y2Settings.Read scope

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Duplicate ISO report returned

No content

401

Not authorized

text/plainapplication/jsontext/json

500

Internal server error while testing countries

get

/api/{tenantId}/cegid/settings/countries/test

HTTPcURLJavaScriptPython

GET /api/{tenantId}/cegid/settings/countries/test HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

List Cegid supported languages

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/cegid/settings/languages

Retrieves available language options from Cegid Y2 system for customer communication and interface localization. Languages define how customer data and system text appear.

Language Configuration

Each language includes:

• Language ID and code (e.g., "FR", "EN", "DE")

• Localized name (e.g., "Français", "English", "Deutsch")

• Character encoding and collation settings

• Regional locale configuration

Use Cases

• Set customer preferred language for communication

• Configure system UI language for country/region

• Localize customer data entry and reporting

• Support multi-language merchant deployments

Authorization

Requires Y2Settings.Read scope

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Languages returned

No content

401

Not authorized

text/plainapplication/jsontext/json

500

Internal server error while retrieving languages

get

/api/{tenantId}/cegid/settings/languages

HTTPcURLJavaScriptPython

GET /api/{tenantId}/cegid/settings/languages HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

List all Cegid Y2 stores

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/cegid/stores

Retrieves the complete store catalog from Cegid Y2 system. Primarily used as a configuration helper for administrative setup and integration diagnostics.

Use Cases

• Configure store identifiers for transaction webhooks

• Validate store existence before setting up locations

• Display store list in admin configuration UI

• Map incoming webhooks to correct tenant stores

Authorization

Requires Y2Store.Read scope

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Stores returned

No content

401

Not authorized

text/plainapplication/jsontext/json

500

Internal server error while retrieving stores

get

/api/{tenantId}/cegid/stores

HTTPcURLJavaScriptPython

GET /api/{tenantId}/cegid/stores HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Redirect to LiveStore form with session context

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/external/livestore

Redirects customer to Cegid LiveStore form with pre-populated session and context data. Used for seamless transitions between web experiences and in-store kiosks.

Redirect Parameters

Query parameters are passed as form pre-fill data to enable:

• Customer context preservation

• Session correlation

• Pre-populated form fields

Use Cases

• Mobile → Kiosk handoff (customer scans QR and gets LiveStore form with context)

• Session recovery and continuity

• Store-specific form customization

Authorization

Tenant context required via route parameter

Path parameters

tenantIdstringRequired

Query parameters

Responses

204

No content when session ID is missing.

302

Redirect to LiveStore form with session context.

400

Bad request for invalid parameters.

text/plainapplication/jsontext/json

500

Unexpected server error.

get

/api/{tenantId}/external/livestore

HTTPcURLJavaScriptPython

GET /api/{tenantId}/external/livestore HTTP/1.1
Host: app.neostore.cloud
Accept: */*

No content

Health check endpoint for LiveStore connectivity

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/external/livestore/session

Lightweight health check called by LiveStore to verify system availability. Supports both GET and HEAD requests for bandwidth optimization.

Path parameters

tenantIdstringRequired

Responses

204

Service reachable.

500

Unexpected server error.

get

/api/{tenantId}/external/livestore/session

HTTPcURLJavaScriptPython

GET /api/{tenantId}/external/livestore/session HTTP/1.1
Host: app.neostore.cloud
Accept: */*

No content

Establish LiveStore session with customer context

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/external/livestore/session

Called by Cegid LiveStore to create a user session with customer information and context. Enables seamless handoff from in-store kiosk to mobile or web experiences.

Session Purpose

• Preserves customer context across devices

• Links kiosk interactions to customer profiles

• Enables offer personalization by store and location

• Supports omnichannel retail scenarios

Customer Payload

Contains customer identification and context:

• Customer ID and identifiers

• Store context and location

• Session metadata and flags

• Custom attributes from CRM

Authorization

Requires LiveStore.Access scope with store provider validation.

Session Lifecycle

1. LiveStore creates session and sends customer payload

2. System stores session with TTL (time-to-live)

3. Customer can use sessionId to access personalized experiences

4. Session expires after configured timeout

Use Cases

• Kiosk → Mobile transition (customer scans QR to complete on phone)

• Store-specific offers and messaging

• Loyalty integration at point-of-sale

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Query parameters

sessionIdstringOptional

Session identifier.

storeIdstringOptional

Optional store identifier.

Body

application/jsontext/jsonapplication/*+json

callbackUrlstring · nullableRequired

customerIdstring · nullableOptional

storeIdstring · nullableOptional

Other propertiesanyOptional

Responses

200

Session stored.

No content

401

Unauthorized LiveStore access.

text/plainapplication/jsontext/json

500

Unexpected server error.

post

/api/{tenantId}/external/livestore/session

HTTPcURLJavaScriptPython

POST /api/{tenantId}/external/livestore/session HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "callbackUrl": null,
  "customerId": null,
  "storeId": null,
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

application/jsontext/jsonapplication/*+json

No content

Health check endpoint for LiveStore connectivity

head

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/external/livestore/session

Lightweight health check called by LiveStore to verify system availability. Supports both GET and HEAD requests for bandwidth optimization.

Path parameters

tenantIdstringRequired

Responses

204

Service reachable.

500

Unexpected server error.

head

/api/{tenantId}/external/livestore/session

HTTPcURLJavaScriptPython

HEAD /api/{tenantId}/external/livestore/session HTTP/1.1
Host: app.neostore.cloud
Accept: */*

No content

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/webhooks/listeners/cegid/{connectionId}

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

connectionIdstringRequired

tenantIdstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

enabledbooleanOptional

idstring · nullableOptional

namestring · nullableOptional

urlstring · nullableOptional

headersobject · nullableOptional

get

/api/{tenantId}/webhooks/listeners/cegid/{connectionId}

HTTPcURLJavaScriptPython

GET /api/{tenantId}/webhooks/listeners/cegid/{connectionId} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

OK

{
  "enabled": true,
  "id": null,
  "name": null,
  "url": null,
  "headers": null,
  "user": {
    "userName": null,
    "password": null
  },
  "filters": [
    {
      "eventSources": [
        "text"
      ],
      "userIds": [
        "text"
      ],
      "action": 0
    }
  ]
}

Process Cegid Y2 business notifications

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/webhooks/listeners/cegid/{connectionId}

Receives real-time business event notifications from Cegid Y2 retail system.

Supported Event Types

• Customer Events: Create, update, loyalty changes

• Sales Events: Receipt creation, transaction completion

• Product Events: Catalog changes (if configured)

Connection-Based Routing

Multiple Cegid Y2 connections can be configured per tenant. The connectionId parameter routes events to the correct configuration.

Event Processing

1. Validates connection exists in tenant configuration

2. Parses event type from notification header

3. Retrieves full entity data from Y2 if needed

4. Triggers corresponding business logic (pass updates, customer sync, etc.)

5. Emits internal events for further processing

Authorization

Requires Y2Listener.Write scope - typically configured with Cegid Y2 webhook signature validation.

Example Events

• CustomerCreated: New loyalty member enrolled

• CustomerUpdated: Profile or tier change

• ReceiptCreated: Purchase transaction completed

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

connectionIdstringRequired

Identifier of the configured Y2 connection

tenantIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

No content

post

/api/{tenantId}/webhooks/listeners/cegid/{connectionId}

HTTPcURLJavaScriptPython

POST /api/{tenantId}/webhooks/listeners/cegid/{connectionId} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 216

{
  "__id": null,
  "__creationDate": "2026-03-05T00:03:47.016Z",
  "__eventName": null,
  "Header": {
    "EventId": null,
    "EventSource": null,
    "ContentType": null,
    "SourceId": null,
    "UserId": null,
    "Date": "2026-03-05T00:03:47.016Z"
  },
  "Body": null
}

application/jsontext/jsonapplication/*+json

200

OK

No content

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/webhooks/listeners/cegid/{connectionId}/Register

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

connectionIdstringRequired

tenantIdstringRequired

Responses

200

OK

No content

post

/api/{tenantId}/webhooks/listeners/cegid/{connectionId}/Register

HTTPcURLJavaScriptPython

POST /api/{tenantId}/webhooks/listeners/cegid/{connectionId}/Register HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

OK

No content