Get Product ID Box Data - Venddor API Documentation

Overview

This endpoint retrieves detailed box configuration data for a specific product identified by its product ID. It provides information about which box configuration is associated with the product, allowing you to understand how the product is packaged and sold as part of a box assortment.

Authentication: Required. Use Basic Authentication with your API credentials.
GET /api/productBoxesVariants/{product_id}

Returns box configuration data for a specific product identified by its product ID.

Path Parameters

Parameter Type Required Description
product_id integer Yes Unique identifier of the product to retrieve box data for

Example Request

GET /api/productBoxesVariants/145632

Example Response

{
    "variant": {
        "variant_id": 65824,
        "product_id": 145632,
        "product_code": "7898765432108",
        "product_feature_id": 575,
        "variant_name": "F8",
        "box_id": 15,
        "box_type": "G",
        "status": "A",
        "box_info": {
            "box_id": 15,
            "title": "F8",
            "description": "1 par 35/36, 3 pares 37/38 e 2 pares 39/40",
            "box_type": "G",
            "size_variant_id": "20270",
            "status": "A",
            "size_qty_info": [
                {
                    "size": "35/36",
                    "amount": "1"
                },
                {
                    "size": "37/38",
                    "amount": "3"
                },
                {
                    "size": "39/40",
                    "amount": "2"
                }
            ]
        }
    }
}

Response Parameters

Parameter Type Description
variant object Product variant object containing box configuration details
variant.variant_id integer Unique identifier for the product variant
variant.product_id integer Identifier of the product that this variant belongs to
variant.product_code string Universal product code (barcode) of the product
variant.product_feature_id integer Feature ID used for the box size (typically 575 for size feature)
variant.variant_name string Name of the box variant (e.g., "F8", "F12")
variant.box_id integer Identifier of the box configuration associated with this variant
variant.box_type string Type of box: "G" for grade box (assortment), "C" for closed box (complete set)
variant.status string Status of the variant: "A" for active, "D" for disabled
variant.box_info object Detailed information about the box configuration
variant.box_info.box_id integer Unique identifier for the box
variant.box_info.title string Identifier code for the box (e.g., "F8")
variant.box_info.description string Human-readable description of the box contents
variant.box_info.box_type string Box type: "G" for grade box (assortment), "C" for closed box (complete set)
variant.box_info.size_variant_id string ID of the size variant linked to this box
variant.box_info.status string Box status: "A" for active, "D" for disabled
variant.box_info.size_qty_info array Array of size/quantity pairs defining the contents of the box

Status Codes

Status Code Description
200 OK Request successful, product box variant data returned
401 Unauthorized Authentication credentials were missing or invalid
404 Not Found Product with the specified ID does not exist or is not associated with a box configuration
500 Internal Server Error An error occurred on the server
Tip: This endpoint provides both the product variant data and the complete box configuration in a single request. This is particularly useful when you need to display detailed box contents information for a specific product in your application.
Note: The response includes the full box_info object, which contains the same information that would be returned by the GET /api/productBoxes/{box_id} endpoint. This eliminates the need for a separate request to retrieve the box details.
Copyright © Venddor Tecnologia S.A. All rights reserved.