Block · Schema

Order

Represents an order for products and services.

CommerceCryptocurrencyeCommerceFintechPaymentsPoint Of SaleSquare

Properties

Name Type Description
id string Unique ID for this order.
location_id string The ID of the seller location that this order is associated with.
state string Current state of the order.
version integer Version number for optimistic concurrency control.
total_money object Total amount for the order.
created_at string
updated_at string
View JSON Schema on GitHub

JSON Schema

block-order-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/block/main/json-schema/block-order-schema.json",
  "title": "Order",
  "description": "Represents an order for products and services.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique ID for this order.",
      "example": "CAISENgvlJ6jLWAzERDzjyHVybY"
    },
    "location_id": {
      "type": "string",
      "description": "The ID of the seller location that this order is associated with.",
      "example": "L1234567890"
    },
    "state": {
      "type": "string",
      "description": "Current state of the order.",
      "enum": ["OPEN", "COMPLETED", "CANCELED", "DRAFT"],
      "example": "OPEN"
    },
    "version": {
      "type": "integer",
      "description": "Version number for optimistic concurrency control.",
      "example": 1
    },
    "total_money": {
      "type": "object",
      "description": "Total amount for the order.",
      "properties": {
        "amount": { "type": "integer", "example": 3000 },
        "currency": { "type": "string", "example": "USD" }
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2026-01-15T10:05:00Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2026-01-15T10:05:00Z"
    }
  }
}