Get Box Info - Venddor API Documentation

Overview

This endpoint retrieves detailed descriptive information for a specific box configuration identified by its ID. It provides supplementary data about a box that can be used for display purposes, reporting, or cross-referencing with product data.

Authentication: Required. Use Basic Authentication with your API credentials.
GET /api/productBoxesDescriptions/{box_id}

Returns descriptive information for a specific box configuration identified by its ID.

Path Parameters

Parameter Type Required Description
box_id integer Yes Unique identifier of the box to retrieve description for

Example Request

GET /api/productBoxesDescriptions/15

Example Response

{
    "description": {
        "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"
    }
}

Response Parameters

Parameter Type Description
description object Box description object containing descriptive information
description.description_id integer Unique identifier for the box description
description.box_id integer Identifier of the box that this description is for
description.lang_code string Language code for the description (e.g., "pt" for Portuguese)
description.title string Display title for the box
description.full_description string Comprehensive description of the box contents, suitable for display on product pages
description.meta_keywords string SEO keywords related to the box
description.meta_description string SEO meta description for the box

Status Codes

Status Code Description
200 OK Request successful, box description returned
401 Unauthorized Authentication credentials were missing or invalid
404 Not Found Box with the specified ID does not exist or does not have a description
500 Internal Server Error An error occurred on the server
Tip: Use this endpoint to retrieve marketing-friendly descriptions that can be directly displayed on product pages or incorporated into product catalogs. The information is particularly useful for improving the user experience when customers are browsing products that are sold in box assortments.
Note: This endpoint returns only descriptive information and does not include the technical box configuration. If you need details about the box contents and structure, use the GET /api/productBoxes/{box_id} endpoint.
Copyright © Venddor Tecnologia S.A. All rights reserved.