ToolStation - Internal Docs
Routes

Vcat

Introduction

This Page provides an overview of the routes defined for the Vcat purpose endpoints in the Toolstation E-Comm Api.

List of Routes for Vcat

  1. /vcat/_ping
  2. /vcat/config
  3. /vcat/get-boxes

GET: vcat/_ping

  • Method: GET
  • Controller: PingController
  • Description: Endpoint to check if the Payments is valid and running successfully. This is a common endpoint for health checks or status pings.

GET: vcat/config

  • Method: GET
  • Controller: CatalogueController
  • Description: Endpoint to retrieve a catalogue configuration.

This code defines a method named getConfig that returns a JSON response containing a catalogue configuration. The method retrieves a configuration array from an unknown source using the _tsrc function, and then processes the array to convert its keys to snake case. The processed array is then returned as a JSON response.

public function getConfig(): JsonResponse
{
    // Function implementation goes here
}

Request Parameters for /vcat/config:

  • Header :- Accept-Language:- en-UK,en,
  • x-toolstation-customer-id:- Token Id of the customer

Response

Response Code: 200 OK

Response:

{
    "data": {
        "catalogue_id": 173SSDX,
        "js": {
            "cat_num_pages": 568WSX,
            "cat_prefix": "//SSDDW/DDSES",
            "cat_link_prefix": "/shop/p",
            "json_boxes_url": "/api/vcat/get-boxes",
            "spacer_img": "/img/vcat/blank.gif",
            "progress_indicator": "/img/vcat/fancybox.png",
            "highlight_image": "/img/vcat/highlight.png"
        }
    }
}

Response Code: 403 Forbidden

Response:

{
    "error": {
        "code": "403.99",
        "message": "Forbidden",
        "info": "https://developers.example.com",
        "data": null
    }
}

GET: vcat/get-boxes

  • Method: GET
  • Controller: CatalogueController
  • Request: Request
  • Description: Endpoint to retrieve a catalogue configuration.

The getBoxes function retrieves box data for a given set of pages and returns it in a JSON format. It validates incoming request data, retrieves configuration values, and applies layout override settings to update box coordinates. The function is designed for e-commerce platforms, inventory management, and shipping logistics.

public function getBoxes(Request $request): JsonResponse
{
    // Function implementation goes here
}

Request Parameters for /vcat/get-boxes:

  • Header :- Accept-Language:- en-UK,en,
  • x-toolstation-customer-id:- Token Id of the customer

Response

Response Code: 403 Forbidden

Response:

<!doctype html><meta charset="utf-8"><meta name=viewport content="width=device-width, initial-scale=1"><title>403</title>403 Forbidden

Stock

Webhooks

Copyright © 2026