RelatedProduct

Related product with basic information

OBJECTRelatedProduct

Fields

idString!

skuString!

slugString!

Product slug (locale-aware if locale parameter provided)

translatedSlugs[TranslatedSlug!]!

Product slugs for all locales

nameString!

Product name (locale-aware if locale parameter provided)

descriptionString!

Product description (locale-aware if locale parameter provided)

htmlDescriptionString!

Product HTML description (locale-aware if locale parameter provided)

shortDescriptionString!

Product short description (locale-aware if locale parameter provided)

htmlShortDescriptionString!

Product HTML short description (locale-aware if locale parameter provided)

customFields[CustomField!]!

thirdPartyLinks[ThirdPartyLink!]!

statusProductStatus!

brandBrand

images[Image!]!

videos[Video!]!

files[ProductFile!]!

attributes[Attribute!]!

tags[Tag!]!

variantGroups[VariantGroup!]!

variants[Variant!]!

createdAtDateTime!

updatedAtDateTime

Example JSON

{
  "id": "string",
  "sku": "string",
  "slug": "string",
  "translatedSlugs": [
    {
      "locale": "string",
      "value": "string"
    }
  ],
  "name": "string",
  "description": "string",
  "htmlDescription": "string",
  "shortDescription": "string",
  "htmlShortDescription": "string",
  "customFields": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "thirdPartyLinks": [
    {
      "id": "string",
      "type": "string",
      "title": "string",
      "url": "string",
      "createdAt": "string",
      "updatedAt": null
    }
  ],
  "status": "ACTIVE",
  "brand": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "description": "string",
    "logoUrl": "string",
    "coverUrl": "string",
    "email": "string"
  },
  "images": [
    {
      "id": "string",
      "url": "string",
      "title": "string",
      "altText": "string",
      "copyright": "string",
      "sort": 0,
      "status": "ACTIVE",
      "blurhash": "string",
      "createdWithAi": true,
      "createdAt": "string",
      "updatedAt": null
    }
  ],
  "videos": [
    {
      "id": "string",
      "url": "string",
      "title": "string",
      "description": "string",
      "sort": 0,
      "status": "ACTIVE",
      "createdWithAi": true,
      "createdAt": "string",
      "updatedAt": null
    }
  ],
  "files": [
    {
      "id": "string",
      "url": "string",
      "title": "string",
      "fileType": "string",
      "createdWithAi": true,
      "createdAt": "string",
      "updatedAt": null
    }
  ],
  "attributes": [
    {
      "id": "string",
      "key": "string",
      "name": "string",
      "description": "string",
      "templateKey": "string",
      "filterable": true,
      "createdAt": null,
      "updatedAt": null
    }
  ],
  "tags": [
    {
      "id": "string",
      "key": "string",
      "name": "string",
      "filterable": true,
      "status": "string",
      "createdAt": null,
      "updatedAt": null
    }
  ],
  "variantGroups": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "slug": "string",
      "priority": 0,
      "hasActiveVariants": true
    }
  ],
  "variants": [
    {
      "id": "string",
      "productId": "string",
      "sku": "string",
      "name": "string",
      "status": "ACTIVE",
      "shippingAttributes": [
        "string"
      ],
      "validateStock": true,
      "createdAt": "string",
      "updatedAt": null,
      "variantGroupId": "string"
    }
  ],
  "createdAt": "string",
  "updatedAt": null
}

Used by

ProductRelation