Get All Boxes - Venddor API Documentation

This endpoint retrieves a list of all product boxes available in the Venddor platform. Product boxes allow merchants to sell products in predefined combinations, such as size assortments (grade boxes) or complete sets (closed boxes).

GET /api/productBoxes/

Returns a list of all product boxes configured in the system. Results can be filtered using query parameters.

Query Parameters

Parameter	Type	Required	Description
limit	integer	No	Maximum number of boxes to return
status	string	No	Filter boxes by status: "A" for active boxes or "D" for disabled boxes
box_type	string	No	Filter boxes by type: "G" for grade boxes (size assortments) or "C" for closed boxes (complete sets)

Example Request

GET /api/productBoxes/?limit=10&status=A&box_type=G

Example Response

{
    "boxes": [
        {
            "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"
                }
            ]
        },
        {
            "box_id": 23,
            "title": "F12",
            "description": "2 pares 37/38, 3 pares 39/40 e 1 par 41/42",
            "box_type": "G",
            "size_variant_id": "20270",
            "status": "A",
            "size_qty_info": [
                {
                    "size": "37/38",
                    "amount": "2"
                },
                {
                    "size": "39/40",
                    "amount": "3"
                },
                {
                    "size": "41/42",
                    "amount": "1"
                }
            ]
        }
    ]
}

Response Parameters

Parameter	Type	Description
boxes	array	Array of box objects containing box configuration details
boxes[].box_id	integer	Unique identifier for the box
boxes[].title	string	Identifier code for the box (e.g., "F8", "F12")
boxes[].description	string	Human-readable description of the box contents
boxes[].box_type	string	Box type: "G" for grade box (assortment), "C" for closed box (complete set)
boxes[].size_variant_id	string	ID of the size variant linked to this box
boxes[].status	string	Box status: "A" for active, "D" for disabled
boxes[].size_qty_info	array	Array of size/quantity pairs defining the contents of the box
boxes[].size_qty_info[].size	string	Size identifier (e.g., "35/36", "37/38")
boxes[].size_qty_info[].amount	string	Quantity of items in this size within the box

Status Codes

Status Code	Description
`200 OK`	Request successful, boxes list returned
`401 Unauthorized`	Authentication credentials were missing or invalid
`500 Internal Server Error`	An error occurred on the server