API Documentation: Get list of orders

Overview

This API allows customers to verify which orders already exist on SolBox. The endpoint accepts a list of orders which you can also see its manifest.

Authentication Endpoint

Before accessing other API endpoints, you must authenticate using the following endpoint:

POST https://smartmove.solbox.it/API/Auth/Login

Request Body

The request body should include the following fields in x-www-form-urlencoded format:

Key		Value
`AccountName`		Your account name for SolBox.
`Username`		Your username for SolBox.
`Password`		Your password for SolBox.
`APIKey`		The API key associated with your account.

Response

On successful authentication, you will receive a bearer token to use for subsequent API calls.

Example Response

{
    "role": "user",
    "isRepairer": false,
    "onBoardingCompleted": true,
    "inactiveDays": 0,
    "inActive": false,
    "trialPeriod": false,
    "locale": "en-AU"
}

Order List Endpoint

After authenticating, you can retrieve and filter orders using the following endpoint:

POST https://smartmove.solbox.it/API/v2/Order/OrderList

Request Body

The request body should be a JSON object to specify filters for retrieving orders:

Field	Type	Description
`onlyShowTodaysOrders`	Integer	Show only today's orders (1) or not (0).
`loadOrdersBetweenDates`	Integer	Load orders within a date range (1) or not (0).
`loadOrdersEndDate`	String	End date for filtering orders (YYYY-MM-DD).
`loadOrdersStartDate`	String	Start date for filtering orders (YYYY-MM-DD).
`loadOrdersModifiedAfter`	String	Load orders modified after this timestamp.
`excludeManifestOrders`	Integer	Exclude manifest orders (1) or not (0).
`excludeUnattachedOrders`	Integer	Exclude unattached orders (1) or not (0).
`loadPickupOrders`	Integer	Load pickup orders (1) or not (0).
`loadDeliveryOrders`	Integer	Load delivery orders (1) or not (0).
`loadServiceOrders`	Integer	Load service orders (1) or not (0).
`loadPendingOrders`	Integer	Load pending orders (1) or not (0).
`loadDeliveringOrders`	Integer	Load delivering orders (1) or not (0).
`loadDeliveredOrders`	Integer	Load delivered orders (1) or not (0).
`loadCancelledOrders`	Integer	Load canceled orders (1) or not (0).
`start`	Integer	Pagination start index.
`len`	Integer	Number of records to retrieve.

Example

{
    "onlyShowTodaysOrders": 0,
    "loadOrdersBetweenDates": 1,
    "loadOrdersEndDate": "2025-01-13",
    "loadOrdersStartDate": "2025-01-13",
    "loadOrdersModifiedAfter": "2025-01-12 19:00:00",
    "excludeManifestOrders": 0,
    "excludeUnattachedOrders": 0,
    "loadPickupOrders": 1,
    "loadDeliveryOrders": 1,
    "loadServiceOrders": 1,
    "loadPendingOrders": 1,
    "loadDeliveringOrders": 1,
    "loadDeliveredOrders": 1,
    "loadCancelledOrders": 1,
    "start": 0,
    "len": 100
}

Response

The response will include the filtered list of orders and their details.