A small vocabulary makes the API much easier to understand.
The API is organized around a few business objects: projects, kits, devices, assembled kits, shipping methods, and Sales Orders. You do not need to understand ConnectUs internals to use them.
Your customer identity
The client API is account-scoped. Your Bearer token identifies the ConnectUs customer automatically. This is why client URLs look like /client/projects instead of containing a customer ID.
If an endpoint on this portal begins with /client, send your Bearer token and let ConnectUs resolve the customer account.
Business objects
Project
A 3PL project available to your customer account. Projects can have a default kit and can expose a list of kits.
Key fields: id, name, description, status, default_kit_id
Kit
A configured 3PL kit belonging to a project. A kit has an ID, name, code, and archive state.
Key fields: id, name, code, is_archived
Assembled Kit
A physical/logical assembled instance of a kit. The API exposes its scanned code, validation state, activation requirement, calculated status, and creation time.
Available Device
An item SKU that your account can use, including its description, available quantity, and active state.
Sales Order
A fulfillment request submitted by your system. Your own customer_po_no is the most useful external reference for matching records between systems.
Shipping Method
A shipping option currently available for Sales Orders. Retrieve this list instead of hard-coding shipping names.
Pagination
Project, kit, and assembled-kit list endpoints are paginated. Use page and per_page. The default page is 1 and the default page size is 15.
GET /client/projects?page=2&per_page=50
Paginated responses contain:
{
"data": [ ... ],
"meta": {
"current_page": 2,
"last_page": 4,
"per_page": 50,
"total": 187
}
}
Request tracing with X-Request-ID
The API accepts an optional X-Request-ID header for request tracing / idempotency identification. Using a UUID makes a request easier to trace in logs and easier to discuss with support.
X-Request-ID: 550e8400-e29b-41d4-a716-446655440000
For Sales Order creation, generate a unique request ID for the logical operation and retain it with your integration logs. If you need to discuss the request with ConnectUs support, provide this value.
Sandbox and production are separate environments
| Sandbox | Production | |
|---|---|---|
| Base URL | https://workspace-stage.connectuscorp.com/api/v2 | https://workspace.connectuscorp.com/api/v2 |
| Token | Sandbox Token | Production Token |
| Purpose | Development and validation | Live transactions |