External API

Orders

Endpointhttps://api.datavisual.ca

Sales orders and order creation

List sales orders

GET

https://api.datavisual.ca

/v1/sales-orders

List sales orders › query Parameters

limit

integer · min: 1 · max: 200

Default: 25

cursor

string

updated_since

string · date-time

ISO 8601 timestamp — return records modified on or after this time

created_after

string · date-time

ISO 8601 timestamp — orders created on or after this time

status

string

reference_number

string

expand

string

Comma-separated expansions, e.g. line_items

List sales orders › 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 sales orders › Responses

Sales orders

object[]

next_cursor

string | null

GET/v1/sales-orders

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

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "salesorder_number": "SO-00000",
      "reference_number": "PO-00000",
      "customer_name": "Datavisual",
      "status": "confirmed",
      "order_status": "open",
      "total": 67.79,
      "order_date": "2025-01-15",
      "created_date": "2025-01-15T14:30:00.000Z",
      "shipment_date": null,
      "last_modified": "2025-01-15T14:30:00.000Z"
    }
  ],
  "next_cursor": null
}

json

application/json

Create a sales order

POST

https://api.datavisual.ca

/v1/sales-orders

Create a sales order › 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.

Create a sales order › Request Body

object · required

object[] · minItems: 1 · required

po_number

string

contact_email

string · email · maxLength: 255

Optional buyer contact email persisted on the queued order. Validated for email format and length only; the mailbox is not verified.

quote_number

string · pattern: ^DV-[QD]\d+$

Optional quote or deal reference number. Must match the pattern DV-Q##### (quote) or DV-D##### (deal). Trimmed before validation; stored as null if omitted.

notes

string

Create a sales order › Responses

Order queued for processing

object

POST/v1/sales-orders

curl --request POST \
  --url https://api.datavisual.ca/v1/sales-orders \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "po_number": "PO-00000",
  "contact_email": "[email protected]",
  "quote_number": "DV-Q00000",
  "shipping_address": {
    "street": "2210 Thurston Drive",
    "city": "Ottawa",
    "state": "ON",
    "zip": "K1G 6C9",
    "country": "CA"
  },
  "line_items": [
    {
      "sku": "DV-1000",
      "quantity": 2,
      "unit_price": 49.99
    }
  ],
  "notes": null
}
'

shell

Example Request Body

{
  "po_number": "PO-00000",
  "contact_email": "[email protected]",
  "quote_number": "DV-Q00000",
  "shipping_address": {
    "street": "2210 Thurston Drive",
    "city": "Ottawa",
    "state": "ON",
    "zip": "K1G 6C9",
    "country": "CA"
  },
  "line_items": [
    {
      "sku": "DV-1000",
      "quantity": 2,
      "unit_price": 49.99
    }
  ],
  "notes": null
}

json

application/json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "queued",
    "created_at": "2025-01-15T14:30:00.000Z",
    "_links": {
      "self": "/v1/sales-orders/00000000-0000-0000-0000-000000000000"
    }
  }
}

json

application/json

List sales order line items

GET

https://api.datavisual.ca

/v1/sales-orders/{id}/line-items

List sales order line items › path Parameters

id

string · uuid · required

List sales order line 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 sales order line items › Responses

Line items

object[]

GET/v1/sales-orders/{id}/line-items

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

shell

Example Responses

{
  "data": [
    {
      "line_item_id": "00000000-0000-0000-0000-000000000000",
      "item_id": "00000000-0000-0000-0000-000000000000",
      "sku": "DV-1000",
      "name": "Datavisual Product",
      "description": null,
      "quantity": 1,
      "quantity_shipped": 0,
      "quantity_invoiced": 0,
      "quantity_packed": 0,
      "quantity_backordered": 0,
      "quantity_cancelled": 0,
      "quantity_returned": 0,
      "rate": 59.99,
      "discount_amount": 0,
      "item_total": 59.99,
      "tax_name": "HST",
      "tax_percentage": 13,
      "warehouse_id": "00000000-0000-0000-0000-000000000000",
      "warehouse_name": "Datavisual Warehouse",
      "is_invoiced": false
    }
  ]
}

json

application/json

List invoices for a sales order

GET

https://api.datavisual.ca

/v1/sales-orders/{id}/invoices

Returns invoices linked to a sales order, resolved by the order's public ID.

List invoices for a sales order › path Parameters

id

string · uuid · required

List invoices for a sales order › 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 invoices for a sales order › Responses

Invoices linked to the sales order

object[]

GET/v1/sales-orders/{id}/invoices

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

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "invoice_number": "INV-00000",
      "customer_name": "Datavisual",
      "status": "sent",
      "total": 67.79,
      "balance": 67.79,
      "date": "2025-01-16",
      "due_date": "2025-02-15",
      "last_modified": "2025-01-16T14:30:00.000Z"
    }
  ]
}

json

application/json

List shipments for a sales order

GET

https://api.datavisual.ca

/v1/sales-orders/{id}/shipments

Returns shipments linked to a sales order, resolved by the order's public ID.

List shipments for a sales order › path Parameters

id

string · uuid · required

List shipments for a sales order › 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 shipments for a sales order › Responses

Shipments linked to the sales order

object[]

GET/v1/sales-orders/{id}/shipments

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

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "shipment_number": "SHP-00000",
      "status": "shipped",
      "customer_name": "Datavisual",
      "tracking_number": "CP0000000000",
      "carrier": "Canada Post",
      "date": "2025-01-17",
      "last_modified": "2025-01-17T14:30:00.000Z"
    }
  ]
}

json

application/json

Get sales order by ID

GET

https://api.datavisual.ca

/v1/sales-orders/{id}

Get sales order by ID › path Parameters

id

string · uuid · required

Get sales order by ID › query Parameters

expand

string

Comma-separated expansions, e.g. line_items

Get sales order 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 sales order by ID › Responses

Sales order

object

GET/v1/sales-orders/{id}

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

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "salesorder_number": "SO-00000",
    "reference_number": "PO-00000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "customer_name": "Datavisual",
    "status": "confirmed",
    "order_status": "open",
    "shipped_status": "not_shipped",
    "invoiced_status": "not_invoiced",
    "paid_status": "unpaid",
    "order_date": "2025-01-15",
    "shipment_date": null,
    "currency_code": "CAD",
    "sub_total": 59.99,
    "tax_total": 7.8,
    "shipping_charge": 0,
    "discount_total": 0,
    "total": 67.79,
    "balance": 67.79,
    "payment_terms_label": "Net 30",
    "delivery_method": null,
    "notes": null,
    "billing_address": {},
    "shipping_address": {},
    "last_modified": "2025-01-15T14:30:00.000Z",
    "line_items": [
      {
        "line_item_id": "00000000-0000-0000-0000-000000000000",
        "item_id": "00000000-0000-0000-0000-000000000000",
        "sku": "DV-1000",
        "name": "Datavisual Product",
        "description": null,
        "quantity": 1,
        "quantity_shipped": 0,
        "quantity_invoiced": 0,
        "quantity_packed": 0,
        "quantity_backordered": 0,
        "quantity_cancelled": 0,
        "quantity_returned": 0,
        "rate": 59.99,
        "discount_amount": 0,
        "item_total": 59.99,
        "tax_name": "HST",
        "tax_percentage": 13,
        "warehouse_id": "00000000-0000-0000-0000-000000000000",
        "warehouse_name": "Datavisual Warehouse",
        "is_invoiced": false
      }
    ]
  }
}

json

application/json

Catalog Billing

External API

Orders

Endpointhttps://api.datavisual.ca

Sales orders and order creation

List sales orders

GET

https://api.datavisual.ca

/v1/sales-orders

List sales orders › query Parameters

limit

integer · min: 1 · max: 200

Default: 25

cursor

string

updated_since

string · date-time

ISO 8601 timestamp — return records modified on or after this time

created_after

string · date-time

ISO 8601 timestamp — orders created on or after this time

status

string

reference_number

string

expand

string

Comma-separated expansions, e.g. line_items

List sales orders › 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 sales orders › Responses

Sales orders

object[]

next_cursor

string | null

GET/v1/sales-orders

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

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "salesorder_number": "SO-00000",
      "reference_number": "PO-00000",
      "customer_name": "Datavisual",
      "status": "confirmed",
      "order_status": "open",
      "total": 67.79,
      "order_date": "2025-01-15",
      "created_date": "2025-01-15T14:30:00.000Z",
      "shipment_date": null,
      "last_modified": "2025-01-15T14:30:00.000Z"
    }
  ],
  "next_cursor": null
}

json

application/json

Create a sales order

POST

https://api.datavisual.ca

/v1/sales-orders

Create a sales order › 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.

Create a sales order › Request Body

object · required

object[] · minItems: 1 · required

po_number

string

contact_email

string · email · maxLength: 255

Optional buyer contact email persisted on the queued order. Validated for email format and length only; the mailbox is not verified.

quote_number

string · pattern: ^DV-[QD]\d+$

Optional quote or deal reference number. Must match the pattern DV-Q##### (quote) or DV-D##### (deal). Trimmed before validation; stored as null if omitted.

notes

string

Create a sales order › Responses

Order queued for processing

object

POST/v1/sales-orders

curl --request POST \
  --url https://api.datavisual.ca/v1/sales-orders \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "po_number": "PO-00000",
  "contact_email": "[email protected]",
  "quote_number": "DV-Q00000",
  "shipping_address": {
    "street": "2210 Thurston Drive",
    "city": "Ottawa",
    "state": "ON",
    "zip": "K1G 6C9",
    "country": "CA"
  },
  "line_items": [
    {
      "sku": "DV-1000",
      "quantity": 2,
      "unit_price": 49.99
    }
  ],
  "notes": null
}
'

shell

Example Request Body

{
  "po_number": "PO-00000",
  "contact_email": "[email protected]",
  "quote_number": "DV-Q00000",
  "shipping_address": {
    "street": "2210 Thurston Drive",
    "city": "Ottawa",
    "state": "ON",
    "zip": "K1G 6C9",
    "country": "CA"
  },
  "line_items": [
    {
      "sku": "DV-1000",
      "quantity": 2,
      "unit_price": 49.99
    }
  ],
  "notes": null
}

json

application/json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "queued",
    "created_at": "2025-01-15T14:30:00.000Z",
    "_links": {
      "self": "/v1/sales-orders/00000000-0000-0000-0000-000000000000"
    }
  }
}

json

application/json

List sales order line items

GET

https://api.datavisual.ca

/v1/sales-orders/{id}/line-items

List sales order line items › path Parameters

id

string · uuid · required

List sales order line 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 sales order line items › Responses

Line items

object[]

GET/v1/sales-orders/{id}/line-items

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

shell

Example Responses

{
  "data": [
    {
      "line_item_id": "00000000-0000-0000-0000-000000000000",
      "item_id": "00000000-0000-0000-0000-000000000000",
      "sku": "DV-1000",
      "name": "Datavisual Product",
      "description": null,
      "quantity": 1,
      "quantity_shipped": 0,
      "quantity_invoiced": 0,
      "quantity_packed": 0,
      "quantity_backordered": 0,
      "quantity_cancelled": 0,
      "quantity_returned": 0,
      "rate": 59.99,
      "discount_amount": 0,
      "item_total": 59.99,
      "tax_name": "HST",
      "tax_percentage": 13,
      "warehouse_id": "00000000-0000-0000-0000-000000000000",
      "warehouse_name": "Datavisual Warehouse",
      "is_invoiced": false
    }
  ]
}

json

application/json

List invoices for a sales order

GET

https://api.datavisual.ca

/v1/sales-orders/{id}/invoices

Returns invoices linked to a sales order, resolved by the order's public ID.

List invoices for a sales order › path Parameters

id

string · uuid · required

List invoices for a sales order › 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 invoices for a sales order › Responses

Invoices linked to the sales order

object[]

GET/v1/sales-orders/{id}/invoices

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

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "invoice_number": "INV-00000",
      "customer_name": "Datavisual",
      "status": "sent",
      "total": 67.79,
      "balance": 67.79,
      "date": "2025-01-16",
      "due_date": "2025-02-15",
      "last_modified": "2025-01-16T14:30:00.000Z"
    }
  ]
}

json

application/json

List shipments for a sales order

GET

https://api.datavisual.ca

/v1/sales-orders/{id}/shipments

Returns shipments linked to a sales order, resolved by the order's public ID.

List shipments for a sales order › path Parameters

id

string · uuid · required

List shipments for a sales order › 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 shipments for a sales order › Responses

Shipments linked to the sales order

object[]

GET/v1/sales-orders/{id}/shipments

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

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "shipment_number": "SHP-00000",
      "status": "shipped",
      "customer_name": "Datavisual",
      "tracking_number": "CP0000000000",
      "carrier": "Canada Post",
      "date": "2025-01-17",
      "last_modified": "2025-01-17T14:30:00.000Z"
    }
  ]
}

json

application/json

Get sales order by ID

GET

https://api.datavisual.ca

/v1/sales-orders/{id}

Get sales order by ID › path Parameters

id

string · uuid · required

Get sales order by ID › query Parameters

expand

string

Comma-separated expansions, e.g. line_items

Get sales order 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 sales order by ID › Responses

Sales order

object

GET/v1/sales-orders/{id}

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

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "salesorder_number": "SO-00000",
    "reference_number": "PO-00000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "customer_name": "Datavisual",
    "status": "confirmed",
    "order_status": "open",
    "shipped_status": "not_shipped",
    "invoiced_status": "not_invoiced",
    "paid_status": "unpaid",
    "order_date": "2025-01-15",
    "shipment_date": null,
    "currency_code": "CAD",
    "sub_total": 59.99,
    "tax_total": 7.8,
    "shipping_charge": 0,
    "discount_total": 0,
    "total": 67.79,
    "balance": 67.79,
    "payment_terms_label": "Net 30",
    "delivery_method": null,
    "notes": null,
    "billing_address": {},
    "shipping_address": {},
    "last_modified": "2025-01-15T14:30:00.000Z",
    "line_items": [
      {
        "line_item_id": "00000000-0000-0000-0000-000000000000",
        "item_id": "00000000-0000-0000-0000-000000000000",
        "sku": "DV-1000",
        "name": "Datavisual Product",
        "description": null,
        "quantity": 1,
        "quantity_shipped": 0,
        "quantity_invoiced": 0,
        "quantity_packed": 0,
        "quantity_backordered": 0,
        "quantity_cancelled": 0,
        "quantity_returned": 0,
        "rate": 59.99,
        "discount_amount": 0,
        "item_total": 59.99,
        "tax_name": "HST",
        "tax_percentage": 13,
        "warehouse_id": "00000000-0000-0000-0000-000000000000",
        "warehouse_name": "Datavisual Warehouse",
        "is_invoiced": false
      }
    ]
  }
}

json

application/json

Catalog Billing