External API

Fulfillment

Endpointhttps://api.datavisual.ca

Shipments and packages

List shipments

GET

https://api.datavisual.ca

/v1/shipments

List shipments › query Parameters

limit

integer · min: 1 · max: 200

Default: 25

cursor

string

created_after

string · date-time

modified_after

string · date-time

status

string

expand

string

List shipments › 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 › Responses

Shipments

object[]

next_cursor

string | null

GET/v1/shipments

curl --request GET \
  --url https://api.datavisual.ca/v1/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-15",
      "last_modified": "2025-01-15T14:30:00.000Z"
    }
  ],
  "next_cursor": null
}

json

application/json

Get shipment by ID

GET

https://api.datavisual.ca

/v1/shipments/{id}

Get shipment by ID › path Parameters

id

string · uuid · required

Get shipment by ID › query Parameters

expand

string

e.g. packages,line_items,invoices

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

Shipment

object

GET/v1/shipments/{id}

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

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "shipment_number": "SHP-00000",
    "status": "shipped",
    "shipment_status": "in_transit",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "customer_name": "Datavisual",
    "salesorder_id": "00000000-0000-0000-0000-000000000000",
    "salesorder_number": "SO-00000",
    "date": "2025-01-15",
    "shipping_date": "2025-01-15",
    "expected_delivery_date": "2025-01-20",
    "delivery_method": null,
    "carrier": "Canada Post",
    "tracking_number": "CP0000000000",
    "tracking_link": "https://www.canadapost-postescanada.ca/track/CP0000000000",
    "currency_code": "CAD",
    "total": 67.79,
    "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,
        "rate": 59.99,
        "item_total": 59.99,
        "tax_name": "HST",
        "tax_percentage": 13,
        "is_invoiced": false
      }
    ]
  }
}

json

application/json

List shipment line items

GET

https://api.datavisual.ca

/v1/shipments/{id}/line-items

List shipment line items › path Parameters

id

string · uuid · required

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

Line items

object[]

GET/v1/shipments/{id}/line-items

curl --request GET \
  --url https://api.datavisual.ca/v1/shipments/: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,
      "rate": 59.99,
      "item_total": 59.99,
      "tax_name": "HST",
      "tax_percentage": 13,
      "is_invoiced": false
    }
  ]
}

json

application/json

List packages

GET

https://api.datavisual.ca

/v1/packages

List packages › query Parameters

limit

integer · min: 1 · max: 200

Default: 25

cursor

string

created_after

string · date-time

modified_after

string · date-time

status

string

tracking_number

string

expand

string

List packages › 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 packages › Responses

Packages

object[]

next_cursor

string | null

GET/v1/packages

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

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "package_number": "PKG-00000",
      "status": "not_shipped",
      "customer_name": "Datavisual",
      "tracking_number": null,
      "carrier": null,
      "date": "2025-01-15",
      "last_modified": "2025-01-15T14:30:00.000Z"
    }
  ],
  "next_cursor": null
}

json

application/json

Get package by ID

GET

https://api.datavisual.ca

/v1/packages/{id}

Get package by ID › path Parameters

id

string · uuid · required

Get package by ID › query Parameters

expand

string

e.g. line_items,shipment

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

Package

object

GET/v1/packages/{id}

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

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "package_number": "PKG-00000",
    "status": "not_shipped",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "customer_name": "Datavisual",
    "salesorder_id": "00000000-0000-0000-0000-000000000000",
    "salesorder_number": "SO-00000",
    "shipment_id": "00000000-0000-0000-0000-000000000000",
    "shipment_number": "SHP-00000",
    "date": "2025-01-15",
    "shipping_date": null,
    "expected_delivery_date": null,
    "delivery_method": null,
    "carrier": null,
    "tracking_number": null,
    "tracking_link": null,
    "total_quantity": 1,
    "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,
        "warehouse_id": null,
        "warehouse_name": null,
        "salesorder_id": "00000000-0000-0000-0000-000000000000",
        "salesorder_number": "SO-00000",
        "is_invoiced": null
      }
    ]
  }
}

json

application/json

List package line items

GET

https://api.datavisual.ca

/v1/packages/{id}/line-items

List package line items › path Parameters

id

string · uuid · required

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

Line items

object[]

GET/v1/packages/{id}/line-items

curl --request GET \
  --url https://api.datavisual.ca/v1/packages/: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,
      "warehouse_id": null,
      "warehouse_name": null,
      "salesorder_id": "00000000-0000-0000-0000-000000000000",
      "salesorder_number": "SO-00000",
      "is_invoiced": null
    }
  ]
}

json

application/json

Billing

External API

Fulfillment

Endpointhttps://api.datavisual.ca

Shipments and packages

List shipments

GET

https://api.datavisual.ca

/v1/shipments

List shipments › query Parameters

limit

integer · min: 1 · max: 200

Default: 25

cursor

string

created_after

string · date-time

modified_after

string · date-time

status

string

expand

string

List shipments › 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 › Responses

Shipments

object[]

next_cursor

string | null

GET/v1/shipments

curl --request GET \
  --url https://api.datavisual.ca/v1/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-15",
      "last_modified": "2025-01-15T14:30:00.000Z"
    }
  ],
  "next_cursor": null
}

json

application/json

Get shipment by ID

GET

https://api.datavisual.ca

/v1/shipments/{id}

Get shipment by ID › path Parameters

id

string · uuid · required

Get shipment by ID › query Parameters

expand

string

e.g. packages,line_items,invoices

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

Shipment

object

GET/v1/shipments/{id}

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

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "shipment_number": "SHP-00000",
    "status": "shipped",
    "shipment_status": "in_transit",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "customer_name": "Datavisual",
    "salesorder_id": "00000000-0000-0000-0000-000000000000",
    "salesorder_number": "SO-00000",
    "date": "2025-01-15",
    "shipping_date": "2025-01-15",
    "expected_delivery_date": "2025-01-20",
    "delivery_method": null,
    "carrier": "Canada Post",
    "tracking_number": "CP0000000000",
    "tracking_link": "https://www.canadapost-postescanada.ca/track/CP0000000000",
    "currency_code": "CAD",
    "total": 67.79,
    "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,
        "rate": 59.99,
        "item_total": 59.99,
        "tax_name": "HST",
        "tax_percentage": 13,
        "is_invoiced": false
      }
    ]
  }
}

json

application/json

List shipment line items

GET

https://api.datavisual.ca

/v1/shipments/{id}/line-items

List shipment line items › path Parameters

id

string · uuid · required

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

Line items

object[]

GET/v1/shipments/{id}/line-items

curl --request GET \
  --url https://api.datavisual.ca/v1/shipments/: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,
      "rate": 59.99,
      "item_total": 59.99,
      "tax_name": "HST",
      "tax_percentage": 13,
      "is_invoiced": false
    }
  ]
}

json

application/json

List packages

GET

https://api.datavisual.ca

/v1/packages

List packages › query Parameters

limit

integer · min: 1 · max: 200

Default: 25

cursor

string

created_after

string · date-time

modified_after

string · date-time

status

string

tracking_number

string

expand

string

List packages › 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 packages › Responses

Packages

object[]

next_cursor

string | null

GET/v1/packages

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

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "package_number": "PKG-00000",
      "status": "not_shipped",
      "customer_name": "Datavisual",
      "tracking_number": null,
      "carrier": null,
      "date": "2025-01-15",
      "last_modified": "2025-01-15T14:30:00.000Z"
    }
  ],
  "next_cursor": null
}

json

application/json

Get package by ID

GET

https://api.datavisual.ca

/v1/packages/{id}

Get package by ID › path Parameters

id

string · uuid · required

Get package by ID › query Parameters

expand

string

e.g. line_items,shipment

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

Package

object

GET/v1/packages/{id}

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

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "package_number": "PKG-00000",
    "status": "not_shipped",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "customer_name": "Datavisual",
    "salesorder_id": "00000000-0000-0000-0000-000000000000",
    "salesorder_number": "SO-00000",
    "shipment_id": "00000000-0000-0000-0000-000000000000",
    "shipment_number": "SHP-00000",
    "date": "2025-01-15",
    "shipping_date": null,
    "expected_delivery_date": null,
    "delivery_method": null,
    "carrier": null,
    "tracking_number": null,
    "tracking_link": null,
    "total_quantity": 1,
    "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,
        "warehouse_id": null,
        "warehouse_name": null,
        "salesorder_id": "00000000-0000-0000-0000-000000000000",
        "salesorder_number": "SO-00000",
        "is_invoiced": null
      }
    ]
  }
}

json

application/json

List package line items

GET

https://api.datavisual.ca

/v1/packages/{id}/line-items

List package line items › path Parameters

id

string · uuid · required

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

Line items

object[]

GET/v1/packages/{id}/line-items

curl --request GET \
  --url https://api.datavisual.ca/v1/packages/: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,
      "warehouse_id": null,
      "warehouse_name": null,
      "salesorder_id": "00000000-0000-0000-0000-000000000000",
      "salesorder_number": "SO-00000",
      "is_invoiced": null
    }
  ]
}

json

application/json

Billing