Get Single Box - Venddor API Documentation

Overview

This endpoint retrieves detailed information about a specific product box identified by its unique ID. It provides complete configuration information about the box, including its contents, type, status, and other relevant details.

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

Returns detailed information about a specific product box identified by its ID.

Path Parameters

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

Example Request

GET /api/productBoxes/15

Example Response

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

Status Codes

Status Code Description
200 OK Request successful, box details returned
401 Unauthorized Authentication credentials were missing or invalid
404 Not Found Box with the specified ID does not exist
500 Internal Server Error An error occurred on the server
Tip: You can use this endpoint to verify the specific contents of a box before creating products that use this box configuration. This is particularly useful when setting up new product listings that will be sold in pre-defined size assortments.
Copyright © Venddor Tecnologia S.A. All rights reserved.