commercetools · Schema

Reference

A reference to another resource by typeId and id.

CommerceComposable CommerceE-CommerceGraphQLRESTSDK

Properties

Name Type Description
typeId string The type identifier of the referenced resource.
id string The system-generated unique identifier of the referenced resource.
View JSON Schema on GitHub

JSON Schema

commercetools-reference-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Reference",
  "title": "Reference",
  "type": "object",
  "description": "A reference to another resource by typeId and id.",
  "required": [
    "typeId",
    "id"
  ],
  "properties": {
    "typeId": {
      "type": "string",
      "description": "The type identifier of the referenced resource."
    },
    "id": {
      "type": "string",
      "description": "The system-generated unique identifier of the referenced resource."
    }
  }
}