Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Product

OBJECTProduct
Fields
idString!
skuString!
productTypeProductType!
slugString!
translatedSlugs[TranslatedSlug!]!

Product slugs for all locales

nameString!
descriptionString!
htmlDescriptionString!
shortDescriptionString!
htmlShortDescriptionString!
metaTitleString!
metaDescriptionString!
variantGroupNameString
variantGroupPriorityInt
variantGroupSlugString
variantGroupBaseProductIDString

If the product is flexible will this field contain the base products id

customFields[CustomField!]!
thirdPartyLinks[ThirdPartyLink!]!
packageDimensionsVariantDimensions
productDimensionsVariantDimensions
hasActiveVariantsBoolean!
variants[Variant!]!
images[Image!]!
videos[Video!]!
collections[Collection!]!
attributes[Attribute!]!
brandBrand
relatedProducts[ProductRelation!]!
variantGroups[VariantGroup!]!
createdAtDateTime!
updatedAtDateTime
Example JSON
{
  "id": "string",
  "sku": "string",
  "productType": "FLEXIBLE",
  "slug": "string",
  "translatedSlugs": [
    {
      "locale": "string",
      "value": "string"
    }
  ],
  "name": "string",
  "description": "string",
  "htmlDescription": "string",
  "shortDescription": "string",
  "htmlShortDescription": "string",
  "metaTitle": "string",
  "metaDescription": "string",
  "variantGroupName": "string",
  "variantGroupPriority": 0,
  "variantGroupSlug": "string",
  "variantGroupBaseProductID": "string",
  "customFields": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "thirdPartyLinks": [
    {
      "id": "string",
      "type": "string",
      "title": "string",
      "url": "string",
      "createdAt": "string",
      "updatedAt": null
    }
  ],
  "packageDimensions": {
    "capacityMilliliter": 0,
    "depth": 0,
    "diameter": 0,
    "height": 0,
    "length": 0,
    "weight": 0,
    "width": 0
  },
  "productDimensions": {
    "capacityMilliliter": 0,
    "depth": 0,
    "diameter": 0,
    "height": 0,
    "length": 0,
    "weight": 0,
    "width": 0
  },
  "hasActiveVariants": true,
  "status": "ACTIVE",
  "variants": [
    {
      "id": "string",
      "productId": "string",
      "sku": "string",
      "name": "string",
      "status": "ACTIVE",
      "shippingAttributes": [
        "string"
      ],
      "validateStock": true,
      "createdAt": "string",
      "updatedAt": null,
      "variantGroupId": "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
    }
  ],
  "categories": [
    {
      "id": "string",
      "slug": "string",
      "name": "string",
      "description": "string",
      "seoTitle": "string",
      "seoDescription": "string",
      "parentId": "string",
      "sortOrder": 0,
      "status": "string",
      "coverUrl": "string",
      "fullName": [
        "string"
      ],
      "fullUri": "string",
      "createdAt": null,
      "updatedAt": null,
      "level": 0,
      "is_main_category": true
    }
  ],
  "collections": [
    {
      "id": "string",
      "parentId": "string",
      "uri": "string",
      "title": "string",
      "status": "string",
      "createdAt": null,
      "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
    }
  ],
  "brand": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "description": "string",
    "logoUrl": "string",
    "coverUrl": "string",
    "email": "string"
  },
  "relatedProducts": [
    {
      "name": "string",
      "relationType": "string"
    }
  ],
  "variantGroups": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "slug": "string",
      "priority": 0,
      "hasActiveVariants": true
    }
  ],
  "createdAt": "string",
  "updatedAt": null
}
Used by