External API

Catalog

Endpointhttps://api.datavisual.ca

Items, stock levels, and warehouses

List items

GET

https://api.datavisual.ca

/v1/items

List items › query Parameters

limit

integer · min: 1 · max: 200

Default: 25

cursor

string

modified_after

string · date-time

status

string

active|inactive|all

Default: active

sku

string

manufacturer_sku

string

expand

string

e.g. stock

List items › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List items › Responses

Items

object[]

next_cursor

string | null

GET/v1/items

curl --request GET \
  --url https://api.datavisual.ca/v1/items \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "sku": "DV-1000",
      "name": "Datavisual Product",
      "manufacturer": "Datavisual",
      "status": "active",
      "dealer_price": 49.99,
      "msrp": 79.99,
      "manufacturer_sku": "DV-1000",
      "renewable_sku": null,
      "service_sku": null,
      "dimensions": {
        "weight": 2.5,
        "height": 10,
        "length": 15,
        "width": 8
      },
      "available_stock": 150,
      "last_modified_time": "2025-01-15T14:30:00.000Z"
    }
  ],
  "next_cursor": null
}

json

application/json

Get item by ID

GET

https://api.datavisual.ca

/v1/items/{id}

Get item by ID › path Parameters

id

string · uuid · required

Get item by ID › query Parameters

expand

string

e.g. stock

Get item by ID › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get item by ID › Responses

Item

object

GET/v1/items/{id}

curl --request GET \
  --url https://api.datavisual.ca/v1/items/:id \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "sku": "DV-1000",
    "name": "Datavisual Product",
    "manufacturer": "Datavisual",
    "status": "active",
    "description": "Datavisual Product",
    "dealer_price": 49.99,
    "msrp": 79.99,
    "manufacturer_sku": "DV-1000",
    "part_number": "DV-1000",
    "renewable_sku": null,
    "service_sku": null,
    "dimensions": {
      "weight": 2.5,
      "height": 10,
      "length": 15,
      "width": 8
    },
    "available_stock": 150,
    "item_class": "hardware",
    "webstore_item": true,
    "product_slug": "datavisual-product",
    "manufacturer_id": "00000000-0000-0000-0000-000000000000",
    "last_modified_time": "2025-01-15T14:30:00.000Z"
  }
}

json

application/json

List stock levels

GET

https://api.datavisual.ca

/v1/stock

List stock levels › query Parameters

limit

integer · min: 1 · max: 200

Default: 25

cursor

string

modified_after

string · date-time

expand

string

List stock levels › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List stock levels › Responses

Stock levels

object[]

next_cursor

string | null

GET/v1/stock

curl --request GET \
  --url https://api.datavisual.ca/v1/stock \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "item_id": "00000000-0000-0000-0000-000000000000",
      "warehouse_id": "00000000-0000-0000-0000-000000000000",
      "available_stock": 150,
      "last_updated": "2025-01-15T14:30:00.000Z"
    }
  ],
  "next_cursor": null
}

json

application/json

Get stock level by ID

GET

https://api.datavisual.ca

/v1/stock/{id}

Get stock level by ID › path Parameters

id

string · uuid · required

Get stock level by ID › query Parameters

expand

string

Get stock level by ID › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get stock level by ID › Responses

Stock level

object

GET/v1/stock/{id}

curl --request GET \
  --url https://api.datavisual.ca/v1/stock/:id \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "item_id": "00000000-0000-0000-0000-000000000000",
    "warehouse_id": "00000000-0000-0000-0000-000000000000",
    "available_stock": 150,
    "last_updated": "2025-01-15T14:30:00.000Z"
  }
}

json

application/json

List warehouses

GET

https://api.datavisual.ca

/v1/warehouses

List warehouses › query Parameters

limit

integer · min: 1 · max: 200

Default: 25

cursor

string

modified_after

string · date-time

expand

string

List warehouses › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List warehouses › Responses

Warehouses

object[]

next_cursor

string | null

GET/v1/warehouses

curl --request GET \
  --url https://api.datavisual.ca/v1/warehouses \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Datavisual Warehouse",
      "city": "Ottawa",
      "province": "Ontario",
      "status": "active"
    }
  ],
  "next_cursor": null
}

json

application/json

Get warehouse by ID

GET

https://api.datavisual.ca

/v1/warehouses/{id}

Get warehouse by ID › path Parameters

id

string · uuid · required

Get warehouse by ID › query Parameters

expand

string

Get warehouse by ID › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get warehouse by ID › Responses

Warehouse

object

GET/v1/warehouses/{id}

curl --request GET \
  --url https://api.datavisual.ca/v1/warehouses/:id \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Datavisual Warehouse",
    "address": "2210 Thurston Drive",
    "city": "Ottawa",
    "province": "Ontario",
    "postal_code": "K1G 6C9",
    "phone": "6135550100",
    "status": "active",
    "updated_at": "2025-01-15T14:30:00.000Z"
  }
}

json

application/json

Quotes Orders

List items

GET

https://api.datavisual.ca

/v1/items

List items › query Parameters

limit

integer · min: 1 · max: 200

Default: 25

cursor

string

modified_after

string · date-time

status

string

active|inactive|all

Default: active

sku

string

manufacturer_sku

string

expand

string

e.g. stock

List items › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List items › Responses

Items

object[]

next_cursor

string | null

Get item by ID

GET

https://api.datavisual.ca

/v1/items/{id}

Get item by ID › path Parameters

id

string · uuid · required

Get item by ID › query Parameters

expand

string

e.g. stock

Get item by ID › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get item by ID › Responses

Item

object

{ "data": { "id": "00000000-0000-0000-0000-000000000000", "sku": "DV-1000", "name": "Datavisual Product", "manufacturer": "Datavisual", "status": "active", "description": "Datavisual Product", "dealer_price": 49.99, "msrp": 79.99, "manufacturer_sku": "DV-1000", "part_number": "DV-1000", "renewable_sku": null, "service_sku": null, "dimensions": { "weight": 2.5, "height": 10, "length": 15, "width": 8 }, "available_stock": 150, "item_class": "hardware", "webstore_item": true, "product_slug": "datavisual-product", "manufacturer_id": "00000000-0000-0000-0000-000000000000", "last_modified_time": "2025-01-15T14:30:00.000Z" } }

List stock levels

GET

https://api.datavisual.ca

/v1/stock

List stock levels › query Parameters

limit

integer · min: 1 · max: 200

Default: 25

cursor

string

modified_after

string · date-time

expand

string

List stock levels › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List stock levels › Responses

Stock levels

object[]

next_cursor

string | null

Get stock level by ID

GET

https://api.datavisual.ca

/v1/stock/{id}

Get stock level by ID › path Parameters

id

string · uuid · required

Get stock level by ID › query Parameters

expand

string

Get stock level by ID › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get stock level by ID › Responses

Stock level

object

List warehouses

GET

https://api.datavisual.ca

/v1/warehouses

List warehouses › query Parameters

limit

integer · min: 1 · max: 200

Default: 25

cursor

string

modified_after

string · date-time

expand

string

List warehouses › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List warehouses › Responses

Warehouses

object[]

next_cursor

string | null

Get warehouse by ID

GET

https://api.datavisual.ca

/v1/warehouses/{id}

Get warehouse by ID › path Parameters

id

string · uuid · required

Get warehouse by ID › query Parameters

expand

string

Get warehouse by ID › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get warehouse by ID › Responses

Warehouse

object