Volumental

Volumental V1Beta API

The V1Beta API from Volumental — 2 operation(s) for v1beta.

GitHub OpenAPI

Operations 6

GET /v1beta/{tenantname} GET /v1beta/{tenantName} #
PATCH /v1beta/{tenantname} PATCH /v1beta/{tenantName} #
PUT /v1beta/{tenantname} PUT /v1beta/{tenantName} #
GET /v1beta/{tenantname}/inventory GET /v1beta/{tenantName}/inventory #
PATCH /v1beta/{tenantname}/inventory PATCH /v1beta/{tenantName}/inventory #
PUT /v1beta/{tenantname}/inventory PUT /v1beta/{tenantName}/inventory #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/volumental/openapi/volumental-v1beta-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/volumental/json-schema/volumental-get-api-v1-some-endpoint-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/volumental/json-schema/volumental-get-api-v1-scans-web-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/volumental/json-schema/volumental-post-api-v1-recommendations-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/volumental/json-schema/volumental-get-v1-beta-tenantname-inventory-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/volumental/json-schema/volumental-get-v1-beta-tenantname-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/volumental/json-schema/volumental-patch-v1-beta-tenantname-inventory-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/volumental:volumental-v1beta-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

volumental-v1beta-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Volumental V1Beta API
  version: '2026-10-15'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-15: 16 operation(s) read from 7 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Volumental has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 11
    documentation: 5
    pages-with-code: 6
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-15'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developer.volumental.com/docs/online-scan-api.md
  - https://developer.volumental.com/docs/inventory-integration.md
  - https://developer.volumental.com/recipes/get-user-data.md
  - https://developer.volumental.com/recipes/get-scan-measurements.md
  - https://developer.volumental.com/docs/inventory-integration
  - https://developer.volumental.com/docs/accessing-myvolumentalcom-with-emails-or-on-your-e-commerce
  - https://developer.volumental.com/docs/online-scan-api
servers:
- url: https://api.volumental.com
security:
- bearer: []
tags:
- name: V1Beta
paths:
  /v1beta/{tenantname}:
    get:
      operationId: get_v1beta_tenantname
      tags:
      - V1Beta
      summary: GET /v1beta/{tenantName}
      x-source: https://developer.volumental.com/docs/inventory-integration.md
      parameters:
      - name: tenantname
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1BetaTenantnameResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --request GET  --url https://api.volumental.com/v1beta/<<tenant_name>>/inventory  --header ''Accept: application/json''  --header ''Authorization: Bearer <access_token>''

          ```'
    patch:
      operationId: patch_v1beta_tenantname
      tags:
      - V1Beta
      summary: PATCH /v1beta/{tenantName}
      x-source: https://developer.volumental.com/docs/inventory-integration.md
      parameters:
      - name: tenantname
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchV1BetaTenantnameResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --request PATCH  --url https://api.volumental.com/v1beta/<<tenant_name>>/inventory  --header 'Accept: application/json'  --header 'Authorization: Bearer <access_token>'  --header 'Content-Type: application/json'  --data '\n[\n     {\n          \"on_hand\": 1,\n          \"pos_id\": \"1\",\n          \"product_id\": \"10002\"\n     },\n     {\n          \"on_hand\": 0,\n          \"pos_id\": \"2\",\n          \"product_"
    put:
      operationId: put_v1beta_tenantname
      tags:
      - V1Beta
      summary: PUT /v1beta/{tenantName}
      x-source: https://developer.volumental.com/docs/inventory-integration.md
      parameters:
      - name: tenantname
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutV1BetaTenantnameResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --request PUT  --url 'https://api.volumental.com/v1beta/<<tenant_name>>/inventory'  --header 'Accept: application/json'  --header 'Authorization: Bearer <access_token>'  --header 'Content-Type: application/json'  --data '\n[\n     {\n          \"on_hand\": 5,\n          \"pos_id\": \"1\",\n          \"product_id\": \"10001\"\n     },\n     {\n          \"on_hand\": 3,\n          \"pos_id\": \"1\",\n          \"product_"
  /v1beta/{tenantname}/inventory:
    get:
      operationId: get_v1beta_tenantname_inventory
      tags:
      - V1Beta
      summary: GET /v1beta/{tenantName}/inventory
      x-source: https://developer.volumental.com/docs/inventory-integration
      parameters:
      - name: tenantname
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1BetaTenantnameInventoryResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --request GET  --url https://api.volumental.com/v1beta/TENANT_NAME/inventory  --header 'Accept: application/json'  --header 'Authorization: Bearer <access_token>' \n The response looks something like this: \n [\n {\n \"product_id\": \"10001\",\n \"pos_id\": \"1\",\n \"on_hand\": 5,\n \"updated_at\": \"2022-03-22T23:04:00.563113Z\"\n },\n {\n \"product_id\": \"10002\",\n \"pos_id\": \"1\",\n \"on_hand\": 3,\n \"updated_at\": \"2022-"
    patch:
      operationId: patch_v1beta_tenantname_inventory
      tags:
      - V1Beta
      summary: PATCH /v1beta/{tenantName}/inventory
      x-source: https://developer.volumental.com/docs/inventory-integration
      parameters:
      - name: tenantname
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchV1BetaTenantnameInventoryResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --request PATCH  --url https://api.volumental.com/v1beta/TENANT_NAME/inventory  --header 'Accept: application/json'  --header 'Authorization: Bearer <access_token>'  --header 'Content-Type: application/json'  --data '\n[\n {\n \"on_hand\": 1,\n \"pos_id\": \"1\",\n \"product_id\": \"10002\"\n },\n {\n \"on_hand\": 0,\n \"pos_id\": \"2\",\n \"product_id\": \"10002\"\n }\n]\n' \n Make a GET request to see the current state of t"
    put:
      operationId: put_v1beta_tenantname_inventory
      tags:
      - V1Beta
      summary: PUT /v1beta/{tenantName}/inventory
      x-source: https://developer.volumental.com/docs/inventory-integration
      parameters:
      - name: tenantname
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutV1BetaTenantnameInventoryResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --request PUT  --url 'https://api.volumental.com/v1beta/TENANT_NAME/inventory'  --header 'Accept: application/json'  --header 'Authorization: Bearer <access_token>'  --header 'Content-Type: application/json'  --data '\n[\n {\n \"on_hand\": 5,\n \"pos_id\": \"1\",\n \"product_id\": \"10001\"\n },\n {\n \"on_hand\": 3,\n \"pos_id\": \"1\",\n \"product_id\": \"10002\"\n },\n {\n \"on_hand\": 5,\n \"pos_id\": \"2\",\n \"product_id\": \"100"
components:
  schemas:
    GetV1BetaTenantnameInventoryResponse:
      type: object
      properties:
        product_id:
          type: string
        pos_id:
          type: string
        on_hand:
          type: integer
        updated_at:
          type: string
          format: date-time
    PatchV1BetaTenantnameInventoryResponse:
      type: object
      properties:
        product_id:
          type: string
        pos_id:
          type: string
        on_hand:
          type: integer
        updated_at:
          type: string
          format: date-time
    PutV1BetaTenantnameInventoryResponse:
      type: object
      properties:
        product_id:
          type: string
        pos_id:
          type: string
        on_hand:
          type: integer
        updated_at:
          type: string
          format: date-time
    PatchV1BetaTenantnameResponse:
      type: object
      properties:
        product_id:
          type: string
        pos_id:
          type: string
        on_hand:
          type: integer
        updated_at:
          type: string
          format: date-time
    GetV1BetaTenantnameResponse:
      type: object
      properties:
        product_id:
          type: string
        pos_id:
          type: string
        on_hand:
          type: integer
        updated_at:
          type: string
          format: date-time
    PutV1BetaTenantnameResponse:
      type: object
      properties:
        product_id:
          type: string
        pos_id:
          type: string
        on_hand:
          type: integer
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    bearer:
      type: http
      scheme: bearer