API and MCP Reference

{
  "limit": 25,
  "search": "Pack"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "afterId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "search": {
      "type": "string",
      "maxLength": 2000
    },
    "includeInactive": {
      "type": "boolean"
    }
  },
  "required": [
    "limit"
  ],
  "additionalProperties": false
}

{
  "limit": 50
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "afterId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "search": {
      "type": "string",
      "maxLength": 2000
    },
    "includeInactive": {
      "type": "boolean"
    }
  },
  "required": [
    "limit"
  ],
  "additionalProperties": false
}

{
  "limit": 50
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "afterId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "search": {
      "type": "string",
      "maxLength": 2000
    },
    "includeInactive": {
      "type": "boolean"
    }
  },
  "required": [
    "limit"
  ],
  "additionalProperties": false
}

{
  "limit": 50
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "afterId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "includeInactive": {
      "type": "boolean"
    }
  },
  "required": [
    "limit"
  ],
  "additionalProperties": false
}

{
  "limit": 50
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "afterId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "productId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "machineId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "status": {
      "type": "string",
      "enum": [
        "in_stock",
        "sold",
        "removed"
      ]
    }
  },
  "required": [
    "limit"
  ],
  "additionalProperties": false
}

{
  "limit": 50
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "afterId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "category": {
      "type": "string",
      "enum": [
        "product",
        "expense",
        "unfiled"
      ]
    },
    "expenseCategory": {
      "type": "string",
      "enum": [
        "general",
        "location_payout",
        "location_expense",
        "platform_fee"
      ]
    },
    "locationId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "supplier": {
      "type": "string",
      "maxLength": 2000
    },
    "dateFrom": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "dateTo": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "amount": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "sha256": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$"
    }
  },
  "required": [
    "limit"
  ],
  "additionalProperties": false
}

{
  "receiptId": "507f1f77bcf86cd799439011",
  "part": 1
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "receiptId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "part": {
      "default": 1,
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "receiptId",
    "part"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "name": "Example",
  "category": "food"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "category": {
      "type": "string",
      "enum": [
        "food",
        "drink",
        "trading_card",
        "toy",
        "other"
      ]
    },
    "sku": {
      "type": "string",
      "maxLength": 2000
    },
    "unitType": {
      "type": "string",
      "maxLength": 2000
    },
    "brand": {
      "type": "string",
      "maxLength": 2000
    },
    "size": {
      "type": "string",
      "maxLength": 2000
    },
    "setName": {
      "type": "string",
      "maxLength": 2000
    },
    "cardType": {
      "type": "string",
      "enum": [
        "booster_box",
        "elite_trainer_box",
        "case",
        "single_pack",
        "blister",
        "bundle",
        "tin",
        "other"
      ]
    },
    "language": {
      "type": "string",
      "enum": [
        "english",
        "japanese",
        "korean",
        "chinese"
      ]
    },
    "defaultSalePrice": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "targetPurchasePrice": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "desiredStock": {
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    },
    "reorderPoint": {
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    },
    "taxable": {
      "type": "boolean"
    },
    "taxRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 1
    },
    "notes": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "requestId",
    "name",
    "category"
  ],
  "additionalProperties": false
}

{
  "requestId": "product-price-example-001",
  "productId": "507f1f77bcf86cd799439011",
  "expectedUpdatedAt": "2026-10-08T12:00:00.000Z",
  "defaultSalePrice": 15.99,
  "active": false
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "productId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "expectedUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
      "description": "The updatedAt value from the latest record lookup. A stale version is rejected."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "defaultSalePrice": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "targetPurchasePrice": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "desiredStock": {
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    },
    "reorderPoint": {
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    },
    "sku": {
      "type": "string",
      "maxLength": 2000
    },
    "brand": {
      "type": "string",
      "maxLength": 2000
    },
    "size": {
      "type": "string",
      "maxLength": 2000
    },
    "notes": {
      "type": "string",
      "maxLength": 2000
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "requestId",
    "productId",
    "expectedUpdatedAt"
  ],
  "additionalProperties": false
}

{
  "requestId": "stock-price-example-001",
  "previewId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "previewId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "requestId",
    "previewId"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "name": "Example"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "address": {
      "type": "object",
      "properties": {
        "street1": {
          "type": "string",
          "maxLength": 2000
        },
        "street2": {
          "type": "string",
          "maxLength": 2000
        },
        "city": {
          "type": "string",
          "maxLength": 2000
        },
        "state": {
          "type": "string",
          "maxLength": 2000
        },
        "postalCode": {
          "type": "string",
          "maxLength": 2000
        }
      },
      "additionalProperties": false
    },
    "contactName": {
      "type": "string",
      "maxLength": 2000
    },
    "contactPhone": {
      "type": "string",
      "maxLength": 2000
    },
    "contactEmail": {
      "anyOf": [
        {
          "type": "string",
          "format": "email",
          "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
        },
        {
          "type": "string",
          "const": ""
        }
      ]
    },
    "notes": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "requestId",
    "name"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "name": "Example"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "address": {
      "type": "object",
      "properties": {
        "street1": {
          "type": "string",
          "maxLength": 2000
        },
        "street2": {
          "type": "string",
          "maxLength": 2000
        },
        "city": {
          "type": "string",
          "maxLength": 2000
        },
        "state": {
          "type": "string",
          "maxLength": 2000
        },
        "postalCode": {
          "type": "string",
          "maxLength": 2000
        }
      },
      "additionalProperties": false
    },
    "contactName": {
      "type": "string",
      "maxLength": 2000
    },
    "contactPhone": {
      "type": "string",
      "maxLength": 2000
    },
    "contactEmail": {
      "anyOf": [
        {
          "type": "string",
          "format": "email",
          "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
        },
        {
          "type": "string",
          "const": ""
        }
      ]
    },
    "notes": {
      "type": "string",
      "maxLength": 2000
    },
    "payoutModel": {
      "type": "string",
      "enum": [
        "none",
        "gross_percentage",
        "net_profit_share"
      ]
    },
    "payoutPercent": {
      "type": "number",
      "minimum": 0,
      "maximum": 100
    }
  },
  "required": [
    "requestId",
    "name"
  ],
  "additionalProperties": false
}

{
  "requestId": "receipt-create-platform-example-001",
  "category": "expense",
  "supplier": "Example Platform",
  "receiptDate": "2026-10-01",
  "amount": 29,
  "expenseType": "Platform fee",
  "expenseCategory": "platform_fee",
  "platformAllocations": [
    {
      "machineId": "507f1f77bcf86cd799439011",
      "locationId": "507f1f77bcf86cd799439011",
      "serviceFrom": "2026-10-01",
      "serviceTo": "2026-10-31",
      "amount": 29
    }
  ],
  "files": [],
  "allowDuplicate": false
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "category": {
      "type": "string",
      "enum": [
        "product",
        "expense",
        "unfiled"
      ]
    },
    "supplier": {
      "type": "string",
      "maxLength": 2000
    },
    "notes": {
      "description": "Optional receipt annotation for explaining differences between the receipt total and tracked items; does not change amount, tax, lots, or costs.",
      "type": "string",
      "maxLength": 2000
    },
    "receiptDate": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "amount": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "salesTaxAmount": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "expenseType": {
      "type": "string",
      "maxLength": 2000
    },
    "expenseCategory": {
      "description": "Use location_payout for venue payments, location_expense for venue operating costs, or platform_fee for machine service invoices. Platform fees require platformAllocations, not locationId; service dates prorate cost and saved opt-in terms affect net shares only.",
      "type": "string",
      "enum": [
        "general",
        "location_payout",
        "location_expense",
        "platform_fee"
      ]
    },
    "locationId": {
      "description": "Workspace location for a location payout or location expense.",
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "platformAllocations": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "machineId": {
            "type": "string",
            "pattern": "^[a-f0-9]{24}$"
          },
          "locationId": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^[a-f0-9]{24}$"
              },
              {
                "type": "null"
              }
            ]
          },
          "serviceFrom": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
          },
          "serviceTo": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
          },
          "amount": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000
          }
        },
        "required": [
          "machineId",
          "serviceFrom",
          "serviceTo"
        ],
        "additionalProperties": false
      }
    },
    "items": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "mode": {
                "type": "string",
                "const": "existing_lot"
              },
              "lotId": {
                "type": "string",
                "pattern": "^[a-f0-9]{24}$"
              }
            },
            "required": [
              "mode",
              "lotId"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "mode": {
                "type": "string",
                "const": "new_lot"
              },
              "productId": {
                "type": "string",
                "pattern": "^[a-f0-9]{24}$"
              },
              "newProduct": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200
                  },
                  "category": {
                    "type": "string",
                    "enum": [
                      "food",
                      "drink",
                      "trading_card",
                      "toy",
                      "other"
                    ]
                  }
                },
                "required": [
                  "name",
                  "category"
                ],
                "additionalProperties": false
              },
              "source": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "acquiredAt": {
                "type": "string",
                "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
              },
              "productSubtotal": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000
              },
              "salesTaxAmount": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000
              },
              "salesTaxPaid": {
                "type": "boolean"
              },
              "salesTaxReviewed": {
                "type": "boolean"
              },
              "bestByDate": {
                "description": "Lot expiration/best-by date printed on the supplier invoice.",
                "type": "string",
                "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
              },
              "lotQuantity": {
                "type": "integer",
                "minimum": 1,
                "maximum": 100
              },
              "unitCount": {
                "type": "integer",
                "minimum": 1,
                "maximum": 1000
              },
              "listPrice": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000
              }
            },
            "required": [
              "mode",
              "source",
              "acquiredAt",
              "productSubtotal",
              "unitCount"
            ],
            "additionalProperties": false
          }
        ]
      }
    },
    "files": {
      "default": [],
      "maxItems": 3,
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "fileName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "mimeType": {
                "type": "string",
                "enum": [
                  "image/jpeg",
                  "image/png",
                  "image/webp",
                  "image/heic",
                  "image/heif",
                  "application/pdf"
                ]
              },
              "base64": {
                "type": "string",
                "minLength": 4,
                "maxLength": 4194304,
                "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
                "description": "Exact original file bytes encoded as base64. Never invent, summarize, or reconstruct an attachment."
              }
            },
            "required": [
              "fileName",
              "mimeType",
              "base64"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "uploadId": {
                "type": "string",
                "pattern": "^[a-f0-9]{24}$"
              }
            },
            "required": [
              "uploadId"
            ],
            "additionalProperties": false
          }
        ]
      }
    },
    "allowDuplicate": {
      "default": false,
      "type": "boolean"
    }
  },
  "required": [
    "requestId",
    "category",
    "supplier",
    "receiptDate",
    "amount",
    "files",
    "allowDuplicate"
  ],
  "additionalProperties": false
}

{
  "requestId": "receipt-upload-example-001",
  "fileName": "receipt.png",
  "mimeType": "image/png",
  "sizeBytes": 392010,
  "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "fileName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "mimeType": {
      "type": "string",
      "enum": [
        "image/jpeg",
        "image/png",
        "image/webp",
        "image/heic",
        "image/heif",
        "application/pdf"
      ]
    },
    "sizeBytes": {
      "type": "integer",
      "minimum": 1,
      "maximum": 3145728
    },
    "sha256": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$"
    }
  },
  "required": [
    "requestId",
    "fileName",
    "mimeType",
    "sizeBytes"
  ],
  "additionalProperties": false
}

{
  "requestId": "receipt-append-example-001",
  "receiptId": "507f1f77bcf86cd799439011",
  "files": [
    {
      "uploadId": "507f1f77bcf86cd799439011"
    }
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "receiptId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "files": {
      "minItems": 1,
      "maxItems": 3,
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "fileName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "mimeType": {
                "type": "string",
                "enum": [
                  "image/jpeg",
                  "image/png",
                  "image/webp",
                  "image/heic",
                  "image/heif",
                  "application/pdf"
                ]
              },
              "base64": {
                "type": "string",
                "minLength": 4,
                "maxLength": 4194304,
                "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
                "description": "Exact original file bytes encoded as base64. Never invent, summarize, or reconstruct an attachment."
              }
            },
            "required": [
              "fileName",
              "mimeType",
              "base64"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "uploadId": {
                "type": "string",
                "pattern": "^[a-f0-9]{24}$"
              }
            },
            "required": [
              "uploadId"
            ],
            "additionalProperties": false
          }
        ]
      }
    }
  },
  "required": [
    "requestId",
    "receiptId",
    "files"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "receiptId": "507f1f77bcf86cd799439011",
  "confirmReceiptName": "Example"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "receiptId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "confirmReceiptName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "requestId",
    "receiptId",
    "confirmReceiptName"
  ],
  "additionalProperties": false
}

{
  "requestId": "lot-delete-example-001",
  "lotId": "507f1f77bcf86cd799439011",
  "confirmLotId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "lotId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "confirmLotId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "requestId",
    "lotId",
    "confirmLotId"
  ],
  "additionalProperties": false
}

{
  "requestId": "lot-edit-example-001",
  "lotId": "507f1f77bcf86cd799439011",
  "expectedUpdatedAt": "2026-10-08T12:00:00.000Z",
  "bestByDate": "2027-10-01",
  "productSubtotal": 150,
  "confirmHistoricalImpact": true
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "lotId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "expectedUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
      "description": "The updatedAt value from the latest record lookup. A stale version is rejected."
    },
    "source": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "acquiredAt": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "bestByDate": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
        },
        {
          "type": "null"
        }
      ]
    },
    "costBasisType": {
      "type": "string",
      "enum": [
        "documented",
        "estimated"
      ]
    },
    "estimationNotes": {
      "type": "string",
      "maxLength": 2000
    },
    "notes": {
      "type": "string",
      "maxLength": 2000
    },
    "salesTaxPaid": {
      "type": "boolean"
    },
    "salesTaxReviewed": {
      "type": "boolean"
    },
    "productSubtotal": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "salesTaxAmount": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "shippingAmount": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "confirmHistoricalImpact": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "requestId",
    "lotId",
    "expectedUpdatedAt"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "receiptId": "507f1f77bcf86cd799439011",
  "receiptName": "Example",
  "category": "product",
  "supplier": "Example",
  "receiptDate": "2026-10-08",
  "amount": 1
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "receiptId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "expectedUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
      "description": "The updatedAt value from the latest record lookup. A stale version is rejected."
    },
    "receiptName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "category": {
      "type": "string",
      "enum": [
        "product",
        "expense",
        "unfiled"
      ]
    },
    "supplier": {
      "type": "string",
      "maxLength": 2000
    },
    "notes": {
      "description": "Optional receipt annotation for explaining differences between the receipt total and tracked items; does not change amount, tax, lots, or costs.",
      "type": "string",
      "maxLength": 2000
    },
    "receiptDate": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "amount": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "salesTaxAmount": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "expenseType": {
      "type": "string",
      "maxLength": 2000
    },
    "expenseCategory": {
      "description": "Use location_payout for venue payments, location_expense for venue operating costs, or platform_fee for machine service invoices. Platform fees require platformAllocations, not locationId; service dates prorate cost and saved opt-in terms affect net shares only.",
      "type": "string",
      "enum": [
        "general",
        "location_payout",
        "location_expense",
        "platform_fee"
      ]
    },
    "locationId": {
      "description": "Workspace location for a location payout or location expense.",
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "platformAllocations": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "machineId": {
            "type": "string",
            "pattern": "^[a-f0-9]{24}$"
          },
          "locationId": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^[a-f0-9]{24}$"
              },
              {
                "type": "null"
              }
            ]
          },
          "serviceFrom": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
          },
          "serviceTo": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
          },
          "amount": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000
          }
        },
        "required": [
          "machineId",
          "serviceFrom",
          "serviceTo"
        ],
        "additionalProperties": false
      }
    },
    "unlinkLotIds": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-f0-9]{24}$"
      }
    }
  },
  "required": [
    "requestId",
    "receiptId",
    "receiptName",
    "category",
    "supplier",
    "receiptDate",
    "amount"
  ],
  "additionalProperties": false
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "receiptId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "items": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "mode": {
                "type": "string",
                "const": "existing_lot"
              },
              "lotId": {
                "type": "string",
                "pattern": "^[a-f0-9]{24}$"
              }
            },
            "required": [
              "mode",
              "lotId"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "mode": {
                "type": "string",
                "const": "new_lot"
              },
              "productId": {
                "type": "string",
                "pattern": "^[a-f0-9]{24}$"
              },
              "newProduct": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200
                  },
                  "category": {
                    "type": "string",
                    "enum": [
                      "food",
                      "drink",
                      "trading_card",
                      "toy",
                      "other"
                    ]
                  }
                },
                "required": [
                  "name",
                  "category"
                ],
                "additionalProperties": false
              },
              "source": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "acquiredAt": {
                "type": "string",
                "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
              },
              "productSubtotal": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000
              },
              "salesTaxAmount": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000
              },
              "salesTaxPaid": {
                "type": "boolean"
              },
              "salesTaxReviewed": {
                "type": "boolean"
              },
              "bestByDate": {
                "description": "Lot expiration/best-by date printed on the supplier invoice.",
                "type": "string",
                "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
              },
              "lotQuantity": {
                "type": "integer",
                "minimum": 1,
                "maximum": 100
              },
              "unitCount": {
                "type": "integer",
                "minimum": 1,
                "maximum": 1000
              },
              "listPrice": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000
              }
            },
            "required": [
              "mode",
              "source",
              "acquiredAt",
              "productSubtotal",
              "unitCount"
            ],
            "additionalProperties": false
          }
        ]
      }
    }
  },
  "required": [
    "requestId",
    "receiptId",
    "items"
  ],
  "additionalProperties": false
}

{
  "productId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "productId"
  ],
  "additionalProperties": false
}

{
  "supplierId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "supplierId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "supplierId"
  ],
  "additionalProperties": false
}

{
  "locationId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "locationId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "locationId"
  ],
  "additionalProperties": false
}

{
  "machineId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "machineId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "machineId"
  ],
  "additionalProperties": false
}

{
  "lotId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "lotId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "lotId"
  ],
  "additionalProperties": false
}

{
  "unitId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "unitId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "unitId"
  ],
  "additionalProperties": false
}

{
  "receiptId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "receiptId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "receiptId"
  ],
  "additionalProperties": false
}

{
  "limit": 50
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "afterId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "productId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "limit"
  ],
  "additionalProperties": false
}

{}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

{
  "dateFrom": "2026-10-01",
  "dateTo": "2026-10-08"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "dateFrom": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Inclusive first calendar date in the workspace time zone."
    },
    "dateTo": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Inclusive last calendar date in the workspace time zone; the response end is the next local midnight (exclusive)."
    }
  },
  "required": [
    "dateFrom",
    "dateTo"
  ],
  "additionalProperties": false
}

{
  "dateFrom": "2026-08-01",
  "dateTo": "2026-08-31",
  "locationId": "507f1f77bcf86cd799439011",
  "page": 1,
  "limit": 50
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "dateFrom": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Inclusive first calendar date in the workspace time zone."
    },
    "dateTo": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Inclusive last calendar date in the workspace time zone; the response end is the next local midnight (exclusive)."
    },
    "locationId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "page": {
      "default": 1,
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": [
    "dateFrom",
    "dateTo",
    "page",
    "limit"
  ],
  "additionalProperties": false
}

{
  "dateFrom": "2026-10-08",
  "dateTo": "2026-10-08"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "dateFrom": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Inclusive first calendar date in the workspace time zone."
    },
    "dateTo": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Inclusive last calendar date in the workspace time zone; the response end is the next local midnight (exclusive)."
    }
  },
  "required": [
    "dateFrom",
    "dateTo"
  ],
  "additionalProperties": false
}

{
  "dateFrom": "2026-10-08",
  "dateTo": "2026-10-08"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "dateFrom": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Inclusive first calendar date in the workspace time zone."
    },
    "dateTo": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Inclusive last calendar date in the workspace time zone; the response end is the next local midnight (exclusive)."
    }
  },
  "required": [
    "dateFrom",
    "dateTo"
  ],
  "additionalProperties": false
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "productId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "source": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "acquiredAt": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "bestByDate": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "productSubtotal": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "salesTaxAmount": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "salesTaxPaid": {
      "type": "boolean"
    },
    "salesTaxReviewed": {
      "type": "boolean"
    },
    "shippingAmount": {
      "default": 0,
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "unitCount": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    },
    "unitType": {
      "default": "unit",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "listPrice": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "costBasisType": {
      "default": "estimated",
      "type": "string",
      "enum": [
        "documented",
        "estimated"
      ]
    },
    "estimationNotes": {
      "type": "string",
      "maxLength": 2000
    },
    "notes": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "requestId",
    "productId",
    "source",
    "acquiredAt",
    "productSubtotal",
    "shippingAmount",
    "unitCount",
    "unitType",
    "costBasisType"
  ],
  "additionalProperties": false
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "supplierId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "expectedUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
      "description": "The updatedAt value from the latest record lookup. A stale version is rejected."
    },
    "changes": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "address": {
          "type": "object",
          "properties": {
            "street1": {
              "type": "string",
              "maxLength": 2000
            },
            "street2": {
              "type": "string",
              "maxLength": 2000
            },
            "city": {
              "type": "string",
              "maxLength": 2000
            },
            "state": {
              "type": "string",
              "maxLength": 2000
            },
            "postalCode": {
              "type": "string",
              "maxLength": 2000
            }
          },
          "additionalProperties": false
        },
        "contactName": {
          "type": "string",
          "maxLength": 2000
        },
        "contactPhone": {
          "type": "string",
          "maxLength": 2000
        },
        "contactEmail": {
          "anyOf": [
            {
              "type": "string",
              "format": "email",
              "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
            },
            {
              "type": "string",
              "const": ""
            }
          ]
        },
        "notes": {
          "type": "string",
          "maxLength": 2000
        },
        "active": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "requestId",
    "supplierId",
    "expectedUpdatedAt",
    "changes"
  ],
  "additionalProperties": false
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "locationId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "expectedUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
      "description": "The updatedAt value from the latest record lookup. A stale version is rejected."
    },
    "changes": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "address": {
          "type": "object",
          "properties": {
            "street1": {
              "type": "string",
              "maxLength": 2000
            },
            "street2": {
              "type": "string",
              "maxLength": 2000
            },
            "city": {
              "type": "string",
              "maxLength": 2000
            },
            "state": {
              "type": "string",
              "maxLength": 2000
            },
            "postalCode": {
              "type": "string",
              "maxLength": 2000
            }
          },
          "additionalProperties": false
        },
        "contactName": {
          "type": "string",
          "maxLength": 2000
        },
        "contactPhone": {
          "type": "string",
          "maxLength": 2000
        },
        "contactEmail": {
          "anyOf": [
            {
              "type": "string",
              "format": "email",
              "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
            },
            {
              "type": "string",
              "const": ""
            }
          ]
        },
        "notes": {
          "type": "string",
          "maxLength": 2000
        },
        "active": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "requestId",
    "locationId",
    "expectedUpdatedAt",
    "changes"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "name": "Example"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "make": {
      "type": "string",
      "maxLength": 2000
    },
    "modelNumber": {
      "type": "string",
      "maxLength": 2000
    },
    "serialNumber": {
      "type": "string",
      "maxLength": 2000
    },
    "notes": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "requestId",
    "name"
  ],
  "additionalProperties": false
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "machineId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "expectedUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
      "description": "The updatedAt value from the latest record lookup. A stale version is rejected."
    },
    "changes": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "make": {
          "type": "string",
          "maxLength": 2000
        },
        "modelNumber": {
          "type": "string",
          "maxLength": 2000
        },
        "serialNumber": {
          "type": "string",
          "maxLength": 2000
        },
        "notes": {
          "type": "string",
          "maxLength": 2000
        },
        "active": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "requestId",
    "machineId",
    "expectedUpdatedAt",
    "changes"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "machineId": "507f1f77bcf86cd799439011",
  "expectedUpdatedAt": "2026-10-08T12:00:00.000Z",
  "targets": [
    {
      "productId": "507f1f77bcf86cd799439011",
      "parLevel": 1
    }
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "machineId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "expectedUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
      "description": "The updatedAt value from the latest record lookup. A stale version is rejected."
    },
    "targets": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "productId": {
            "type": "string",
            "pattern": "^[a-f0-9]{24}$"
          },
          "parLevel": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1000
          }
        },
        "required": [
          "productId",
          "parLevel"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "requestId",
    "machineId",
    "expectedUpdatedAt",
    "targets"
  ],
  "additionalProperties": false
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "locationId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "expectedUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
      "description": "The updatedAt value from the latest record lookup. A stale version is rejected."
    },
    "payoutModel": {
      "type": "string",
      "enum": [
        "none",
        "gross_percentage",
        "net_profit_share"
      ]
    },
    "payoutPercent": {
      "type": "number",
      "minimum": 0,
      "maximum": 100
    },
    "salesTaxRate": {
      "description": "Location sales tax rate as a fraction (0.07 means 7%). Null clears the override so the workspace default applies.",
      "anyOf": [
        {
          "type": "number",
          "minimum": 0,
          "maximum": 0.25
        },
        {
          "type": "null"
        }
      ]
    },
    "deductPlatformFeesFromNetPayout": {
      "type": "boolean"
    },
    "confirmHistoricalImpact": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "requestId",
    "locationId",
    "expectedUpdatedAt",
    "confirmHistoricalImpact"
  ],
  "additionalProperties": false
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "machineId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "expectedUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
      "description": "The updatedAt value from the latest record lookup. A stale version is rejected."
    },
    "cardFeePercent": {
      "type": "number",
      "minimum": 0,
      "maximum": 1
    },
    "cardFeeFlat": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "monthlyPlatformFee": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "payoutModel": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "none",
            "gross_percentage",
            "net_profit_share"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "payoutPercent": {
      "type": "number",
      "minimum": 0,
      "maximum": 100
    },
    "confirmHistoricalImpact": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "requestId",
    "machineId",
    "expectedUpdatedAt",
    "confirmHistoricalImpact"
  ],
  "additionalProperties": false
}

{
  "unitIds": [
    "507f1f77bcf86cd799439011"
  ],
  "destinationMachineId": null
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "unitIds": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-f0-9]{24}$"
      }
    },
    "destinationMachineId": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[a-f0-9]{24}$"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "unitIds",
    "destinationMachineId"
  ],
  "additionalProperties": false
}

{
  "requestId": "stock-move-example-001",
  "previewId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "previewId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "requestId",
    "previewId"
  ],
  "additionalProperties": false
}

{
  "machineId": "507f1f77bcf86cd799439011",
  "destinationLocationId": "507f1f77bcf86cd799439011",
  "placedAt": "2026-09-29"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "machineId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "destinationLocationId": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[a-f0-9]{24}$"
        },
        {
          "type": "null"
        }
      ]
    },
    "placedAt": {
      "description": "Actual placement date as YYYY-MM-DD (UTC midnight) or a UTC ISO timestamp. Omit to pin the current time in a relocation preview. Supply it with the existing location to correct only the placement date.",
      "anyOf": [
        {
          "type": "string",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
        },
        {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
        }
      ]
    }
  },
  "required": [
    "machineId",
    "destinationLocationId"
  ],
  "additionalProperties": false
}

{
  "requestId": "machine-placement-example-001",
  "previewId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "previewId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "requestId",
    "previewId"
  ],
  "additionalProperties": false
}

{
  "unitIds": [
    "507f1f77bcf86cd799439011"
  ],
  "listPrice": 15.99
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "unitIds": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-f0-9]{24}$"
      }
    },
    "listPrice": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    }
  },
  "required": [
    "unitIds",
    "listPrice"
  ],
  "additionalProperties": false
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "unitIds": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-f0-9]{24}$"
      }
    },
    "eventDate": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "taxRate": {
      "default": 0.06,
      "description": "Use tax fraction applied to purchase cost, such as 0.06 for 6%. Purchase tax already recorded makes additional use tax zero.",
      "type": "number",
      "minimum": 0,
      "maximum": 1
    },
    "notes": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "unitIds",
    "eventDate",
    "taxRate"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "previewId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "previewId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "requestId",
    "previewId"
  ],
  "additionalProperties": false
}

{
  "limit": 50
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "afterId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "operation": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "limit"
  ],
  "additionalProperties": false
}

{
  "auditId": "507f1f77bcf86cd799439011",
  "unitsOffset": 0,
  "unitsLimit": 25
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "auditId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "unitsOffset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "unitsLimit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": [
    "auditId",
    "unitsOffset",
    "unitsLimit"
  ],
  "additionalProperties": false
}

{
  "limit": 50
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "afterId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "search": {
      "type": "string",
      "maxLength": 2000
    },
    "category": {
      "type": "string",
      "enum": [
        "food",
        "drink",
        "trading_card",
        "toy",
        "other"
      ]
    }
  },
  "required": [
    "limit"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "referenceProductId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "referenceProductId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "defaultSalePrice": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "targetPurchasePrice": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    }
  },
  "required": [
    "requestId",
    "referenceProductId"
  ],
  "additionalProperties": false
}

{
  "limit": 50
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "afterId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "dateFrom": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "dateTo": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    }
  },
  "required": [
    "limit"
  ],
  "additionalProperties": false
}

{
  "tripId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "tripId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "tripId"
  ],
  "additionalProperties": false
}

{
  "addresses": [
    "Example",
    "Example"
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "addresses": {
      "minItems": 2,
      "maxItems": 25,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 300
      }
    }
  },
  "required": [
    "addresses"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "tripDate": "2026-10-08",
  "miles": 1,
  "mileageRate": 0.76,
  "stops": [
    {
      "address": "Example"
    },
    {
      "address": "Example"
    }
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "tripDate": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "miles": {
      "type": "number",
      "minimum": 0,
      "maximum": 100000
    },
    "mileageRate": {
      "default": 0.76,
      "type": "number",
      "minimum": 0,
      "maximum": 100
    },
    "stops": {
      "minItems": 2,
      "maxItems": 25,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "address": {
            "type": "string",
            "minLength": 1,
            "maxLength": 300
          },
          "label": {
            "type": "string",
            "maxLength": 2000
          },
          "purpose": {
            "type": "string",
            "maxLength": 2000
          }
        },
        "required": [
          "address"
        ],
        "additionalProperties": false
      }
    },
    "notes": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "requestId",
    "tripDate",
    "miles",
    "mileageRate",
    "stops"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "tripId": "507f1f77bcf86cd799439011",
  "expectedUpdatedAt": "2026-10-08T12:00:00.000Z",
  "tripDate": "2026-10-08",
  "miles": 1,
  "mileageRate": 0.76,
  "stops": [
    {
      "address": "Example"
    },
    {
      "address": "Example"
    }
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "tripId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "expectedUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
      "description": "The updatedAt value from the latest record lookup. A stale version is rejected."
    },
    "tripDate": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "miles": {
      "type": "number",
      "minimum": 0,
      "maximum": 100000
    },
    "mileageRate": {
      "default": 0.76,
      "type": "number",
      "minimum": 0,
      "maximum": 100
    },
    "stops": {
      "minItems": 2,
      "maxItems": 25,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "address": {
            "type": "string",
            "minLength": 1,
            "maxLength": 300
          },
          "label": {
            "type": "string",
            "maxLength": 2000
          },
          "purpose": {
            "type": "string",
            "maxLength": 2000
          }
        },
        "required": [
          "address"
        ],
        "additionalProperties": false
      }
    },
    "notes": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "requestId",
    "tripId",
    "expectedUpdatedAt",
    "tripDate",
    "miles",
    "mileageRate",
    "stops"
  ],
  "additionalProperties": false
}

{}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

{
  "limit": 25
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "afterId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "status": {
      "type": "string",
      "enum": [
        "preview",
        "applied",
        "undone"
      ]
    }
  },
  "required": [
    "limit"
  ],
  "additionalProperties": false
}

{
  "importId": "507f1f77bcf86cd799439011",
  "linesOffset": 0,
  "linesLimit": 100
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "importId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "linesOffset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "linesLimit": {
      "default": 100,
      "type": "integer",
      "minimum": 1,
      "maximum": 500
    }
  },
  "required": [
    "importId",
    "linesOffset",
    "linesLimit"
  ],
  "additionalProperties": false
}

{
  "limit": 50
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "afterId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 200
    },
    "importId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "needsStock": {
      "type": "boolean"
    },
    "taxDiscrepancy": {
      "type": "boolean"
    },
    "status": {
      "type": "string",
      "enum": [
        "applied",
        "undone",
        "refunded"
      ]
    },
    "locationId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "productId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "dateFrom": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "dateTo": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    }
  },
  "required": [
    "limit"
  ],
  "additionalProperties": false
}

{}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "pattern": "^[a-z0-9][a-z0-9_-]{0,39}$",
      "description": "Vendor/report source such as haha, buzzbot, vtm, nayax, or manual. Mappings and duplicate checks are per source."
    },
    "kind": {
      "type": "string",
      "enum": [
        "product",
        "machine"
      ]
    }
  },
  "additionalProperties": false
}

{
  "source": "haha",
  "label": "Haha export October 1-7",
  "lines": [
    {
      "type": "sale",
      "externalTransactionId": "HT-100231",
      "soldAt": "2026-10-01T14:32:00",
      "machineKey": "Library Vend 01",
      "productId": "507f1f77bcf86cd799439011",
      "productKey": "COKE ZERO 12OZ CAN",
      "quantity": 1,
      "grossAmount": 2,
      "paymentMethod": "card"
    },
    {
      "type": "sale",
      "externalTransactionId": "HT-100244",
      "soldAt": "2026-10-01T16:05:00",
      "machineId": "507f1f77bcf86cd799439011",
      "machineKey": "Library Vend 01",
      "productKey": "COKE ZERO 12OZ CAN",
      "quantity": 2,
      "grossAmount": 4,
      "taxCollected": 0.24,
      "paymentMethod": "card",
      "cardFee": 0.34
    }
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "pattern": "^[a-z0-9][a-z0-9_-]{0,39}$",
      "description": "Vendor/report source such as haha, buzzbot, vtm, nayax, or manual. Mappings and duplicate checks are per source."
    },
    "label": {
      "type": "string",
      "maxLength": 2000
    },
    "lines": {
      "minItems": 1,
      "maxItems": 500,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "lineRef": {
            "description": "Optional row reference from the report, echoed in the preview.",
            "type": "string",
            "maxLength": 2000
          },
          "type": {
            "default": "sale",
            "description": "Omit declined, failed, or canceled vends entirely. Use refund only for completed refunds of an earlier sale.",
            "type": "string",
            "enum": [
              "sale",
              "refund"
            ]
          },
          "externalTransactionId": {
            "description": "Vendor transaction/order ID. Strongly preferred: makes re-imports and overlapping reports safe. Required for refunds.",
            "type": "string",
            "maxLength": 2000
          },
          "soldAt": {
            "type": "string",
            "minLength": 10,
            "maxLength": 40,
            "description": "Report timestamp as YYYY-MM-DD or YYYY-MM-DDTHH:mm[:ss]. Timestamps without an offset are interpreted in the workspace time zone (get_sales_settings)."
          },
          "machineId": {
            "description": "Coil machine ID when you know it. With machineKey, a successful apply remembers the mapping.",
            "type": "string",
            "pattern": "^[a-f0-9]{24}$"
          },
          "machineKey": {
            "description": "Vendor machine identifier (device ID, serial, or name). Resolved through saved mappings; unknown machines block the preview.",
            "type": "string",
            "maxLength": 2000
          },
          "machineLabel": {
            "type": "string",
            "maxLength": 2000
          },
          "locationId": {
            "description": "Coil location ID when the report has no machine. A machine's current location is used otherwise.",
            "type": "string",
            "pattern": "^[a-f0-9]{24}$"
          },
          "productId": {
            "description": "Coil product ID you matched. With productKey, a successful apply remembers the mapping for future reports.",
            "type": "string",
            "pattern": "^[a-f0-9]{24}$"
          },
          "productKey": {
            "description": "Vendor product name/code/slot item exactly as reported. Resolved through saved mappings.",
            "type": "string",
            "maxLength": 2000
          },
          "productLabel": {
            "type": "string",
            "maxLength": 2000
          },
          "quantity": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100
          },
          "grossAmount": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000,
            "description": "Total charged for this line before any separately listed tax (unit price x quantity). If the report shows no separate tax, this is the full amount charged and Coil backs out the tax."
          },
          "taxCollected": {
            "description": "Sales tax listed separately on the report for this line. Omit or 0 when no separate tax was charged.",
            "type": "number",
            "minimum": 0,
            "maximum": 1000000
          },
          "paymentMethod": {
            "default": "card",
            "type": "string",
            "enum": [
              "card",
              "cash",
              "other"
            ]
          },
          "cardFee": {
            "description": "Actual processing fee from the report for this line. Omit to use the machine's configured card fee; cash has no fee.",
            "type": "number",
            "minimum": 0,
            "maximum": 1000000
          }
        },
        "required": [
          "type",
          "soldAt",
          "quantity",
          "grossAmount",
          "paymentMethod"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "source",
    "lines"
  ],
  "additionalProperties": false
}

{
  "requestId": "sales-apply-example-001",
  "importId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "importId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "requestId",
    "importId"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "importId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "importId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "requestId",
    "importId"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "importId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "importId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "requestId",
    "importId"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "saleLineId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "saleLineId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "requestId",
    "saleLineId"
  ],
  "additionalProperties": false
}

{
  "requestId": "sales-allocate-example-001",
  "saleLineId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "saleLineId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "quantity": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "unitIds": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-f0-9]{24}$"
      }
    }
  },
  "required": [
    "requestId",
    "saleLineId"
  ],
  "additionalProperties": false
}

{
  "requestId": "sales-mapping-example-001",
  "source": "haha",
  "kind": "product",
  "externalKey": "COKE ZERO 12OZ CAN",
  "targetId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "source": {
      "type": "string",
      "pattern": "^[a-z0-9][a-z0-9_-]{0,39}$",
      "description": "Vendor/report source such as haha, buzzbot, vtm, nayax, or manual. Mappings and duplicate checks are per source."
    },
    "kind": {
      "type": "string",
      "enum": [
        "product",
        "machine"
      ]
    },
    "externalKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000
    },
    "externalLabel": {
      "type": "string",
      "maxLength": 2000
    },
    "targetId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "requestId",
    "source",
    "kind",
    "externalKey",
    "targetId"
  ],
  "additionalProperties": false
}

{
  "requestId": "example-request-001",
  "aliasId": "507f1f77bcf86cd799439011"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Unique identifier for this write. Reuse it with identical inputs when retrying; never generate a new identifier for a retry."
    },
    "aliasId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "requestId",
    "aliasId"
  ],
  "additionalProperties": false
}