This endpoint retrieves detailed descriptive information for all box configurations available in the Venddor platform. It provides supplementary data about boxes that can be used for display purposes, reporting, or cross-referencing with product data.
Returns descriptive information for all box configurations in the system.
GET /api/productBoxesDescriptions/
{
"descriptions": [
{
"description_id": 28,
"box_id": 15,
"lang_code": "pt",
"title": "Caixa F8",
"full_description": "Caixa grade contendo: 1 par tamanho 35/36, 3 pares tamanho 37/38 e 2 pares tamanho 39/40. Total: 6 pares.",
"meta_keywords": "caixa, grade, F8, calçados",
"meta_description": "Caixa grade F8 - sortimento de calçados com 6 pares em tamanhos variados"
},
{
"description_id": 29,
"box_id": 23,
"lang_code": "pt",
"title": "Caixa F12",
"full_description": "Caixa grade contendo: 2 pares tamanho 37/38, 3 pares tamanho 39/40 e 1 par tamanho 41/42. Total: 6 pares.",
"meta_keywords": "caixa, grade, F12, calçados",
"meta_description": "Caixa grade F12 - sortimento de calçados com 6 pares em tamanhos variados"
}
]
}
| Parameter | Type | Description |
|---|---|---|
| descriptions | array | Array of box description objects |
| descriptions[].description_id | integer | Unique identifier for the box description |
| descriptions[].box_id | integer | Identifier of the box that this description is for |
| descriptions[].lang_code | string | Language code for the description (e.g., "pt" for Portuguese) |
| descriptions[].title | string | Display title for the box |
| descriptions[].full_description | string | Comprehensive description of the box contents, suitable for display on product pages |
| descriptions[].meta_keywords | string | SEO keywords related to the box |
| descriptions[].meta_description | string | SEO meta description for the box |
| Status Code | Description |
|---|---|
200 OK |
Request successful, box descriptions returned |
401 Unauthorized |
Authentication credentials were missing or invalid |
500 Internal Server Error |
An error occurred on the server |
GET /api/productBoxes/ endpoint.