Codat · Schema

Record Ref

Unified_API

Properties

Name Type Description
id string The unique identitifer of the record being referenced
type string The type of record being referenced.
View JSON Schema on GitHub

JSON Schema

codat-commercerecordref-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CommerceRecordRef",
  "title": "Record Ref",
  "x-internal": true,
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique identitifer of the record being referenced",
      "type": "string",
      "examples": [
        "13d946f0-c5d5-42bc-b092-97ece17923ab",
        "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
        7110701885,
        "EILBDVJVNUAGVKRQ"
      ]
    },
    "type": {
      "description": "The type of record being referenced.",
      "type": "string"
    }
  },
  "required": [
    "id",
    "type"
  ],
  "description": ""
}