Get All Product Box Data - Venddor API Documentation

Overview

This endpoint retrieves data about product variants that are associated with box configurations. It allows you to get information about which products are linked to which boxes, making it useful for inventory management and product catalog maintenance.

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

Returns a list of product variants that are associated with box configurations. The results can be filtered using query parameters.

Query Parameters

Parameter Type Required Description
limit integer No Maximum number of product variants to return
product_ids string No Comma-separated list of product IDs to filter by
box_id integer No Filter variants by box ID
box_type string No Filter variants by box type: "G" for grade boxes or "C" for closed boxes

Example Request

GET /api/productBoxesVariants/?box_id=15&limit=10

Example Response

{
    "variants": [
        {
            "variant_id": 65824,
            "product_id": 145632,
            "product_code": "7898765432108",
            "product_feature_id": 575,
            "variant_name": "F8",
            "box_id": 15,
            "box_type": "G",
            "status": "A"
        },
        {
            "variant_id": 65825,
            "product_id": 145633,
            "product_code": "7898765432109",
            "product_feature_id": 575,
            "variant_name": "F8",
            "box_id": 15,
            "box_type": "G",
            "status": "A"
        }
    ]
}

Response Parameters

Parameter Type Description
variants array Array of product variant objects that are associated with box configurations
variants[].variant_id integer Unique identifier for the product variant
variants[].product_id integer Identifier of the product that this variant belongs to
variants[].product_code string Universal product code (barcode) of the product
variants[].product_feature_id integer Feature ID used for the box size (typically 575 for size feature)
variants[].variant_name string Name of the box variant (e.g., "F8", "F12")
variants[].box_id integer Identifier of the box configuration associated with this variant
variants[].box_type string Type of box: "G" for grade box (assortment), "C" for closed box (complete set)
variants[].status string Status of the variant: "A" for active, "D" for disabled

Status Codes

Status Code Description
200 OK Request successful, product box variants returned
401 Unauthorized Authentication credentials were missing or invalid
500 Internal Server Error An error occurred on the server
Tip: This endpoint is particularly useful when you need to understand the relationship between products and box configurations. For example, you can use it to identify all products that are available in a specific box configuration, or to verify which box configurations a specific product is available in.
Note: The product_feature_id is typically set to 575, which is the standard feature ID for size variants in the Venddor platform. This field is used to associate products with their respective size configurations.
Copyright © Venddor Tecnologia S.A. All rights reserved.