Thanx · JSON Structure

Loyalty Api Basket Input Structure

BasketInput schema from Thanx Loyalty API

Type: object Properties: 9 Required: 5

RestaurantLoyaltyGuest EngagementMarketingCRMOnline OrderingWebhooksPointsRewardsCampaigns

BasketInput is a JSON Structure definition published by Thanx, describing 9 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id state order_timestamp location_uid rewards points_products payments items subtotal

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/loyalty-api-basket-input-structure.json",
  "name": "BasketInput",
  "description": "BasketInput schema from Thanx Loyalty API",
  "required": [
    "state",
    "order_timestamp",
    "location_uid",
    "items",
    "subtotal"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "92b7b0dac4"
    },
    "state": {
      "type": "string",
      "enum": [
        "open",
        "validated",
        "billed",
        "checkout"
      ],
      "example": "open"
    },
    "order_timestamp": {
      "type": "datetime",
      "example": "2025-06-01T18:02:05Z"
    },
    "location_uid": {
      "type": "string",
      "example": "92b7b0dac4"
    },
    "rewards": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "points_products": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "payments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "issuer": {
            "type": "string",
            "example": "example"
          },
          "last4": {
            "type": "string",
            "example": "1234"
          },
          "amount": {
            "type": "double",
            "example": 9.99
          },
          "authorized_at": {
            "type": "datetime",
            "example": "2025-06-01T18:02:05Z"
          }
        }
      }
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "92b7b0dac4"
          },
          "name": {
            "type": "string",
            "example": "Pizza Town Co"
          },
          "price": {
            "type": "double",
            "example": 9.99
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "modifiers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "price": {
                  "type": "double"
                },
                "item_base_price": {
                  "type": "double"
                }
              }
            }
          }
        }
      }
    },
    "subtotal": {
      "type": "double",
      "example": 9.99
    }
  }
}