Lightspeed Commerce · Schema
Store Credit Transaction for Customer
A store credit operation
CommercePoint-of-SaleRetailRestaurantInventoryLoyaltyPaymentsE-CommerceOmnichannelCanada
Properties
| Name | Type | Description |
|---|---|---|
| amount | number | The amount of the transaction |
| client_id | string | An operation idempotency identifier. The client must provide this and normally it should be the transaction id from the client system. An operation and it's reverse operation must have the same client |
| created_at | string | The date time the transaction was created. |
| id | string | transaction unique identifier (base64 encoded) |
| notes | string | The notes associated with the transaction. |
| sale_id | string | The sale id the transaction is associated with. This should be null for transactions initiated outside of Lightspeed Retail. If it is a sale id, it will be in UUID format. |
| type | string | The type of the transaction |
| user_id | string | The user id of the person who performed the transaction (during a sale or a manual issue) |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed/main/json-schema/lightspeed-store-credit-transaction-schema.json",
"title": "Store Credit Transaction for Customer",
"description": "A store credit operation",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/lightspeed-store-credits-api-openapi.yml#/components/schemas/StoreCreditTransaction",
"properties": {
"amount": {
"description": "The amount of the transaction",
"format": "double",
"type": "number"
},
"client_id": {
"description": "An operation idempotency identifier.\nThe client must provide this and normally it should be the transaction id from the client system.\nAn operation and it's reverse operation must have the same client_id\n",
"type": "string"
},
"created_at": {
"description": "The date time the transaction was created.",
"format": "date-time",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(Z|[+-]\\d{2}:\\d{2})$",
"type": "string"
},
"id": {
"description": "transaction unique identifier (base64 encoded)",
"type": "string"
},
"notes": {
"description": "The notes associated with the transaction.",
"type": "string"
},
"sale_id": {
"description": "The sale id the transaction is associated with. This should be null for transactions initiated outside of Lightspeed Retail. If it is a sale id, it will be in UUID format.",
"format": "uuid",
"type": "string"
},
"type": {
"description": "The type of the transaction",
"enum": [
"ISSUE",
"REDEMPTION",
"REVERSE"
],
"type": "string"
},
"user_id": {
"description": "The user id of the person who performed the transaction (during a sale or a manual issue)",
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/lightspeed-store-credit-transaction"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.