# Tags

## GET

### Route: `/api/v2/tags/{id}` (BETA)

Get tags generated

**Response**

```json
{
    "tags": {
      "physical": {
        "colour": {
          "primary": {
            "value": "Blue",
            "shade": "Medium"
          },
          "secondary": {
            "value": "White",
            "shade": null
          },
          "tertiary": null
        },
        "material": "material",
        "size": "size",
        "pattern": "pattern",
        "lining": "lining",
        "texture": "texture",
        "fit": "fit",
        "gender": "gender",
        "fashionStyle": "fashionStyle",
        "eraTrend": "eraTrend",
        "designElements": "designElements",
        "culturalInfluence": "culturalInfluence",
        "bodyType": ["bt1","bt2"]
      },
      "usage": {
        "occasions": [
          "o1",
          "o2"
        ],
        "season": [
          "s1",
          "s2"
        ],
        "activities": [
          "a1",
          "a2"
        ],
        "careType": [
          "ct1",
          "ct2"
        ],
        "weatherSuitability": [
          "ws1",
          "ws2"
        ],
        "ageGroup": [
          "ag1",
          "ag2"
        ]
      },
      "market": {
        "sustainability": "sustainability",
        "priceRange": "priceRange",
        "locality": "locality"
      },
      "functional": {
        "neckType": "neckType",
        "sleeveLength": "sleeveLength",
        "closure": true,
        "closureType": "closureType",
        "length": "length",
        "collarType": "collarType"
      }
    },
    "category": "category",
    "subcategory": "subcategory",
    "marketingCalendarCollction": {
      "UnitedStates": [
        "ev1",
        "ev2"
      ],
      "India": [
        "ev1",
        "ev2"
      ],
      "Australia": [
        "ev1",
        "ev2"
      ],
      "Canada": [
        "ev1",
        "ev2"
      ],
      "China": [
        "ev1",
        "ev2"
      ],
      "SouthKorea": [
        "ev1",
        "ev2"
      ],
      "Brazil": [
        "ev1",
        "ev2"
      ],
      "Mexico": [
        "ev1",
        "ev2"
      ],
      "Spain": [
        "ev1",
        "ev2"
      ],
      "Malaysia": [
        "ev1",
        "ev2"
      ],
      "Singapore": [
        "ev1",
        "ev2"
      ]
    }
  }
```

#### example

```json
{
  "tags": {
    "physical": {
      "colour": {
        "primary": {
          "value": "Blue",
          "shade": "Medium"
        },
        "secondary": {
          "value": "White",
          "shade": null
        },
        "tertiary": null
      },
      "material": "Cotton",
      "size": "M",
      "pattern": "Checked",
      "lining": null,
      "texture": null,
      "fit": "Regular fit",
      "gender": "Men",
      "fashionStyle": "Casual",
      "eraTrend": "Modern",
      "designElements": null,
      "culturalInfluence": null,
      "bodyType": null
    },
    "usage": {
      "occasions": [
        "Everyday",
        "Casual",
        "Brunch",
        "Shopping",
        "Errands"
      ],
      "season": [
        "All seasons",
        "Spring",
        "Fall"
      ],
      "activities": [
        "Socializing",
        "Dating",
        "Relaxation",
        "Exploration"
      ],
      "careType": [
        "Machine wash cold",
        "Do not bleach",
        "Wash separately",
        "Wash with like colors"
      ],
      "weatherSuitability": [
        "Breathable",
        "Lightweight",
        "Moisture-wicking"
      ],
      "ageGroup": [
        "Young Adults",
        "Adults",
        "Teens"
      ]
    },
    "market": {
      "sustainability": null,
      "priceRange": "Mid-range",
      "locality": "Middle class"
    },
    "functional": {
      "neckType": "Collared",
      "sleeveLength": "Long sleeve",
      "closure": true,
      "closureType": "Buttons",
      "length": null,
      "collarType": "button-down"
    }
  },
  "category": "Clothing",
  "subcategory": "Clothing/Shirts",
  "marketingCalendarCollction": {
    "UnitedStates": [
      "sprng",
      "summer",
      "Labor Day",
      "Independence Day",
      "Thanksgiving",
      "Christmas"
    ],
    "India": [
      "Diwali",
      "Holi",
      "Ganesh Chaturthi",
      "Navratri",
      "Christmas"
    ],
    "Australia": [
      "Australia Day",
      "Easter",
      "Christmas",
      "New Year's Eve"
    ],
    "Canada": [
      "New Year's Day",
      "Canada Day",
      "Thanksgiving",
      "Christmas"
    ],
    "China": [
      "Chinese New Year",
      "Spring Festival",
      "Christmas"
    ],
    "SouthKorea": [
      "Lunar New Year",
      "Chuseok",
      "Christmas"
    ],
    "Brazil": [
      "New Year's Day",
      "Carnival",
      "Christmas"
    ],
    "Mexico": [
      "New Year's Day",
      "Cinco de Mayo",
      "Christmas"
    ],
    "Spain": [
      "New Year's Day",
      "Carnival",
      "Christmas",
      "Semana Santa"
    ],
    "Malaysia": [
      "New Year's Day",
      "Carnival",
      "Christmas"
    ],
    "Singapore": [
      "New Year's Day",
      "Carnival",
      "Christmas"
    ]
  }
}
```

## POST

### Route: `/api/v2/tags/{id}`

Generate tags

**Response**

```json
{
  "message": "tags generated successfully",
  "tags": {
    "tags": {
      "physical": {
        "colour": {
          "primary": {
            "value": "color",
            "shade": "shade"
          },
          "secondary": {
            "value": "color",
            "shade": null
          },
          "tertiary": null
        },
        "material": "material",
        "size": "size",
        "pattern": "pattern",
        "lining": "lining",
        "texture": "texture",
        "fit": "fit",
        "gender": "gender",
        "fashionStyle": "fashionStyle",
        "eraTrend": "eraTrend",
        "designElements": "designElements",
        "culturalInfluence": "culturalInfluence",
        "bodyType": ["bt1","bt2"]
      },
      "usage": {
        "occasions": [
          "o1",
          "o2"
        ],
        "season": [
          "s1",
          "s2"
        ],
        "activities": [
          "a1",
          "a2"
        ],
        "careType": [
          "ct1",
          "ct2"
        ],
        "weatherSuitability": [
          "ws1",
          "ws2"
        ],
        "ageGroup": [
          "ag1",
          "ag2"
        ]
      },
      "market": {
        "sustainability": "sustainability",
        "priceRange": "priceRange",
        "locality": "locality"
      },
      "functional": {
        "neckType": "neckType",
        "sleeveLength": "sleeveLength",
        "closure": true,
        "closureType": "closureType",
        "length": "length",
        "collarType": "collarType"
      }
    },
    "category": "category",
    "subcategory": "subcategory",
    "marketingCalendarCollction": {
      "UnitedStates": [
        "ev1",
        "ev2"
      ],
      "India": [
        "ev1",
        "ev2"
      ],
      "Australia": [
        "ev1",
        "ev2"
      ],
      "Canada": [
        "ev1",
        "ev2"
      ],
      "China": [
        "ev1",
        "ev2"
      ],
      "SouthKorea": [
        "ev1",
        "ev2"
      ],
      "Brazil": [
        "ev1",
        "ev2"
      ],
      "Mexico": [
        "ev1",
        "ev2"
      ],
      "Spain": [
        "ev1",
        "ev2"
      ],
      "Malaysia": [
        "ev1",
        "ev2"
      ],
      "Singapore": [
        "ev1",
        "ev2"
      ]
    }
  }
}
```

#### **example**

```json
{
  "message": "generated tags successfully",
  "tags": {
    "tags": {
      "physical": {
        "colour": {
          "primary": {
            "value": "Blue",
            "shade": "Medium"
          },
          "secondary": {
            "value": "White",
            "shade": "Medium"
          },
          "tertiary": null
        },
        "material": "Cotton",
        "size": "M",
        "pattern": "Checkered",
        "lining": null,
        "texture": "Smooth",
        "fit": "Regular fit",
        "gender": "Men",
        "fashionStyle": "Casual",
        "eraTrend": "Contemporary",
        "designElements": null,
        "culturalInfluence": "Western",
        "bodyType": null
      },
      "usage": {
        "occasions": [
          "Casual",
          "Everyday",
          "Brunch",
          "Lunch",
          "Date night",
          "Shopping",
          "Errands"
        ],
        "season": [
          "Spring",
          "Summer",
          "Fall",
          "All seasons"
        ],
        "activities": [
          "Socializing",
          "Dating",
          "Relaxation",
          "Exploration"
        ],
        "careType": [
          "Machine wash cold",
          "Do not bleach",
          "Wash separately",
          "Wash with like colors"
        ],
        "weatherSuitability": [
          "Breathable",
          "Lightweight",
          "Moisture-wicking"
        ],
        "ageGroup": [
          "Young Adults",
          "Adults",
          "Teens"
        ]
      },
      "market": {
        "sustainability": null,
        "priceRange": "Mid-range",
        "locality": "Urban"
      },
      "functional": {
        "neckType": "Collared",
        "sleeveLength": "Long sleeve",
        "closure": true,
        "closureType": "Buttons",
        "length": null,
        "collarType": "stiff"
      }
    },
    "category": "Clothing",
    "subcategory": "Clothing/Shirts",
    "marketingCalendarCollection": {
      "UnitedStates": [
        "spring",
        "summer",
        "Labor Day",
        "Black Friday",
        "Cyber Monday"
      ],
      "India": [
        "Diwali",
        "Holi",
        "Navratri",
        "Ganesh Chaturthi",
        "Christmas",
        "New Year's Eve"
      ],
      "Australia": [
        "Australia Day",
        "Summer",
        "Christmas",
        "Boxing Day",
        "New Year's Eve"
      ],
      "Canada": [
        "Canada Day",
        "Civic Holiday",
        "Labour Day",
        "Thanksgiving",
        "Christmas"
      ],
      "China": [
        "Chinese New Year",
        "Spring Festival",
        "National Day",
        "Mid-Autumn Festival"
      ],
      "SouthKorea": [
        "Lunar New Year",
        "Chuseok",
        "Halloween",
        "Christmas"
      ],
      "Brazil": [
        "Carnival",
        "Independence Day",
        "Christmas",
        "New Year's Eve",
        "Brazilian Carnival"
      ],
      "Mexico": [
        "Cinco de Mayo",
        "Independence Day",
        "Christmas",
        "New Year's Eve"
      ],
      "Spain": [
        "Carnival",
        "Fiesta Nacional de España",
        "Christmas",
        "New Year's Eve"
      ]
    }
  },
  "product": {
    "id": "8986383647013",
    "title": "Blue Twill Check Casual Shirt",
    "description": "Model Size M Pattern Checkered Color Blue : White Fabric Cotton Sleeve Long Sleeves",
    "image": "https://cdn.shopify.com/s/files/1/0795/9858/4101/products/SUM23SHRT_PNCHK32_M_PLN_BUWH_1_b08e98e1-31ef-4f74-ad8e-7ee4b752c178.jpg?v=1705311522",
    "priceRange": {
      "maxVariantPrice": {
        "currencyCode": "INR",
        "amount": 849
      }
    }
  }
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.heliumbuilder.com/v2-beta/tags.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
