Type Alias Variant

Type declaration

• _links: {
      product_details: HateoasLink;
      product_variants: HateoasLink;
      self: HateoasLink;
      variant_availability: HateoasLink;
      variant_images: HateoasLink;
      variant_prices: HateoasLink;
  }

  HATEOAS links

  • product_details: HateoasLink

    Link to details about the product

  • product_variants: HateoasLink

    Link to a list of all catalog variants that are siblings of this catalog variant, relating to the same catalog product

  • self: HateoasLink

    Link to same resource

  • variant_availability: HateoasLink

    Link to information about the availability of this variant

  • variant_images: HateoasLink

    Link to images related to this variant and details about those images

  • variant_prices: HateoasLink

    Link to pricing information about this catalog variant

• catalog_product_id: number

  ID of the product that this variant belongs to

• color: string | null

  Item color

• color_code: string | null

  Hexadecimal RGB color code. May not exactly reflect the real-world color

• color_code2: string | null

  Secondary hexadecimal RGB color code. May not exactly reflect the real-world color

• id: number

  Variant ID, use this to specify the product when creating orders

• image: string

  URL of a preview image for this variant

• name: string

  Display name

• size: string

  Item size