API - Scheduled Trips | Wisefish API

Overview

The endpoint is a list of Scheduled Trips. Existing trips can be read and changed (PATCH); new trips cannot be created and trips cannot be deleted through the API.

Endpoint name	`scheduledTrips`
Source table	`WiFi Scheduled Trip`
Fixed view	Shows the whole list (no filter), sorted by status and then departure date/time.
Requests allowed	GET, PATCH (POST and DELETE are not allowed)
Primary key	`No.`
Record ID	`number`
Child Objects	Available with $expand `transportUnits` - the transport units that have been allocated to this trip, see API - Transport Units: API - Transport Units `salesAgreements` - the sales agreements that have been linked to this trip (delivery agreements only), see API - Sales Agreements: API - Sales Agreements
Procedures	None

Data

Field List

	Property	Type	Format	Description
1	`systemId`	string	uuid	The GUID of the record.	non-editable
2	`number`	string	max 20	No. (the unique number of the scheduled trip)	Record ID primary key
3	`shippingAgentCode`	string	max 10	Shipping Agent Code	optional
4	`shippingAgentName`	string	max 50	Shipping Agent Name (looked up from the shipping agent)	non-editable
5	`status`	string	enum	Status. Options: Open, Moving, Completed, Cancelled. Not editable.	non-editable
6	`loadingStatus`	string	enum	Loading Status. Options: (blank), InLoading, LoadingCompleted	optional
7	`isExport`	boolean		True if the trip type is Export (field Type = Export). Calculated, not editable.	non-editable
8	`transportMethod`	string	max 10	Transport Method	optional
9	`departureDate`	string	date	Departure Date	optional
10	`departureTime`	string	time	Departure Time	optional
11	`arrivalDate`	string	date	Arrival Date	optional
12	`arrivalTime`	string	time	Arrival Time	optional
13	`numberOfAgreements`	integer		The number of delivery agreements in this trip. Calculated (Alloc. No. of Delivery Agreements).	non-editable
14	`numberOfTransportUnits`	integer		The number of transport units in this trip. Calculated (No. of Transport Units (Allocated)).	non-editable
15	`transportUnits`	array		A list of the transport units. Properties are as can be seen in the documentation for that object: API - Transport Units
16	`salesAgreements`	array		A list of the sales agreements (delivery agreements) allocated to this trip. Properties are as can be seen in the documentation for that object: API - Sales Agreements
17	`systemRowVersion`	integer		System row version. Increments every time the record is modified.	non-editable
18	`lastModified`	string	date-time	SystemModifiedAt (date and time of last change)	non-editable
19	`modifiedByUser`	string	max 50	The user who last modified the record.	non-editable

Object Example

JSON

{
    "systemId": "5afe5e66-410b-f111-b02e-cfedda509304",
    "number": "TRIP-01",
    "shippingAgentCode": "DHL",
    "shippingAgentName": "DHL Systems, Inc.",
    "status": "Open",
    "loadingStatus": " ",
    "isExport": false,
    "transportMethod": "",
    "departureDate": "2026-02-16",
    "departureTime": "00:00:00",
    "arrivalDate": "2027-01-17",
    "arrivalTime": "00:00:00",
    "numberOfAgreements": 1,
    "numberOfTransportUnits": 2,
    "transportUnits": [],
    "salesAgreements": [],
    "systemRowVersion": 2581734,
    "lastModified": "2026-02-16T14:11:54.78Z",
    "modifiedByUser": "ADMIN"
}

Examples

Read scheduled trips

Read all entries

Reads all scheduled trips, sorted by status and departure date/time (the response is shortened to one trip).

Request:

JSON

GET .../scheduledTrips

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#scheduledTrips",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzI1ODE3MzQ0NzE5MzQ2ODkyMjMxOzAwOyc=\"",
            "systemId": "5afe5e66-410b-f111-b02e-cfedda509304",
            "number": "TRIP-01",
            "shippingAgentCode": "DHL",
            "shippingAgentName": "DHL Systems, Inc.",
            "status": "Open",
            "loadingStatus": " ",
            "isExport": false,
            "transportMethod": "",
            "departureDate": "2026-02-16",
            "departureTime": "00:00:00",
            "arrivalDate": "2027-01-17",
            "arrivalTime": "00:00:00",
            "numberOfAgreements": 1,
            "numberOfTransportUnits": 2,
            "systemRowVersion": 2581734,
            "lastModified": "2026-02-16T14:11:54.78Z",
            "modifiedByUser": "ADMIN"
        }
    ]
}

Read a specific entry

Reads scheduled trip TRIP-01 by its Record ID (number).

Request:

JSON

GET .../scheduledTrips('TRIP-01')

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#scheduledTrips/$entity",
    "@odata.etag": "W/\"JzE5OzI1ODE3MzQ0NzE5MzQ2ODkyMjMxOzAwOyc=\"",
    "systemId": "5afe5e66-410b-f111-b02e-cfedda509304",
    "number": "TRIP-01",
    "shippingAgentCode": "DHL",
    "shippingAgentName": "DHL Systems, Inc.",
    "status": "Open",
    "loadingStatus": " ",
    "isExport": false,
    "transportMethod": "",
    "departureDate": "2026-02-16",
    "departureTime": "00:00:00",
    "arrivalDate": "2027-01-17",
    "arrivalTime": "00:00:00",
    "numberOfAgreements": 1,
    "numberOfTransportUnits": 2,
    "systemRowVersion": 2581734,
    "lastModified": "2026-02-16T14:11:54.78Z",
    "modifiedByUser": "ADMIN"
}

Read trips departing in a date range

Reads the trips departing in February 2026, with selected properties, using $filter and $select.

Request:

JSON

GET .../scheduledTrips?$filter=departureDate ge 2026-02-01 and departureDate le 2026-02-28&$select=number,shippingAgentCode,status,departureDate,departureTime

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#scheduledTrips(number,shippingAgentCode,status,departureDate,departureTime)",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzI1ODE3MzQ0NzE5MzQ2ODkyMjMxOzAwOyc=\"",
            "number": "TRIP-01",
            "shippingAgentCode": "DHL",
            "status": "Open",
            "departureDate": "2026-02-16",
            "departureTime": "00:00:00"
        },
        {
            "@odata.etag": "W/\"JzE5OzE0NzI1ODMwMjk0NzE5MzQ2ODkyOzAwOyc=\"",
            "number": "TRIP-02",
            "shippingAgentCode": "DHL",
            "status": "Open",
            "departureDate": "2026-02-23",
            "departureTime": "14:30:00"
        }
    ]
}

Read scheduled trips with transport units

For example to read scheduled trips with transport units:

JSON

GET .../scheduledTrips?$expand=transportUnits

Response (shortened; the transport unit properties are described on the API - Transport Units page):

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#scheduledTrips",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzI1ODE3MzQ0NzE5MzQ2ODkyMjMxOzAwOyc=\"",
            "systemId": "5afe5e66-410b-f111-b02e-cfedda509304",
            "number": "TRIP-01",
            "shippingAgentCode": "DHL",
            "shippingAgentName": "DHL Systems, Inc.",
            "status": "Open",
            "loadingStatus": " ",
            "isExport": false,
            "transportMethod": "",
            "departureDate": "2026-02-16",
            "departureTime": "00:00:00",
            "arrivalDate": "2027-01-17",
            "arrivalTime": "00:00:00",
            "numberOfAgreements": 1,
            "numberOfTransportUnits": 2,
            "transportUnits": [
                {
                    "id": "TU-0001",
                    "tripNo": "TRIP-01",
                    "status": "Open",
                    ...
                }
            ],
            "systemRowVersion": 2581734,
            "lastModified": "2026-02-16T14:11:54.78Z",
            "modifiedByUser": "ADMIN"
        }
    ]
}

Read the sales agreements of a trip

Reads trip TRIP-01 with its delivery agreements, selecting a few properties of the agreements.

Request:

JSON

GET .../scheduledTrips('TRIP-01')?$select=number,numberOfAgreements&$expand=salesAgreements($select=documentType,documentNo,sellToCustomerNo,sellToCustomerName)

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#scheduledTrips(number,numberOfAgreements,salesAgreements(documentType,documentNo,sellToCustomerNo,sellToCustomerName))/$entity",
    "@odata.etag": "W/\"JzE5OzI1ODE3MzQ0NzE5MzQ2ODkyMjMxOzAwOyc=\"",
    "number": "TRIP-01",
    "numberOfAgreements": 1,
    "salesAgreements": [
        {
            "@odata.etag": "W/\"JzE5OzM4NDcyOTE4MzY0MDI3NDkxMjMxOzAwOyc=\"",
            "documentType": "Delivery",
            "documentNo": "SA-000123",
            "sellToCustomerNo": "10000",
            "sellToCustomerName": "Adatum Corporation"
        }
    ]
}

Change scheduled trips

Change a scheduled trip

Moves trip TRIP-01 to a new departure and arrival date and time. A PATCH request needs the If-Match header with the @odata.etag of the record (or *).

Request:

JSON

PATCH .../scheduledTrips('TRIP-01')
If-Match: *

Body:
{
    "departureDate": "2026-02-18",
    "departureTime": "08:00:00",
    "arrivalDate": "2026-02-21",
    "arrivalTime": "16:00:00"
}

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#scheduledTrips/$entity",
    "@odata.etag": "W/\"JzE5OzI1ODE3OTA0NzE5MzQ2ODkyMjMxOzAwOyc=\"",
    "systemId": "5afe5e66-410b-f111-b02e-cfedda509304",
    "number": "TRIP-01",
    "shippingAgentCode": "DHL",
    "shippingAgentName": "DHL Systems, Inc.",
    "status": "Open",
    "loadingStatus": " ",
    "isExport": false,
    "transportMethod": "",
    "departureDate": "2026-02-18",
    "departureTime": "08:00:00",
    "arrivalDate": "2026-02-21",
    "arrivalTime": "16:00:00",
    "numberOfAgreements": 1,
    "numberOfTransportUnits": 2,
    "systemRowVersion": 2581790,
    "lastModified": "2026-10-21T10:15:32.417Z",
    "modifiedByUser": "ADMIN"
}