Search for orders.

Testing Env

https://statimlogistics-test.dsapp.io/integration

POST

/api/v1/orders/search

Search for orders. Note that Basic Authentication is required for all requests
as such, make sure to provide the Authorization header with a valid value.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Header Params

Body Params application/json

Example

{
  "query": "<string>",
  "searchFields": [
    "<string>",
    "<string>"
  ],
  "maximumResults": "<integer>",
  "operator": 1
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://statimlogistics-test.dsapp.io/integration/api/v1/orders/search' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
  "query": "<string>",
  "searchFields": [
    "<string>",
    "<string>"
  ],
  "maximumResults": "<integer>",
  "operator": 1
}'

Responses

🟢200The matching orders

text/plain

Body

Example

{
    "totalCount": "integer",
    "searchFields": [
        "string"
    ],
    "items": [
        {
            "orderId": "string",
            "accountId": "string",
            "driverId": "string",
            "driverName": "string",
            "status": "integer",
            "isFromRecurringOrder": "boolean",
            "createdAt": "string",
            "pickupAddress": {
                "addressLine1": "string",
                "addressLine2": "string",
                "company": "string",
                "city": "string",
                "postalCode": "string",
                "stateProvince": "string"
            },
            "pickupLocation": {
                "latitude": "float",
                "longitude": "float",
                "isValid": "boolean"
            },
            "pickupFromTime": "string",
            "pickupToTime": "string",
            "pickupNotes": "string | null",
            "pickupContactInfo": {
                "id": "string | null",
                "name": "string",
                "phoneNumber": "string | null",
                "email": "string | null",
                "language": "string | null"
            },
            "dropoffAddress": {
                "addressLine1": "string",
                "addressLine2": "string",
                "company": "string",
                "city": "string",
                "postalCode": "string",
                "stateProvince": "string"
            },
            "dropoffLocation": {
                "latitude": "float",
                "longitude": "float",
                "isValid": "boolean"
            },
            "dropoffFromTime": "string",
            "dropoffToTime": "string",
            "dropoffNotes": "string | null",
            "dropoffContactInfo": {
                "id": "string | null",
                "name": "string",
                "phoneNumber": "string | null",
                "email": "string | null",
                "language": "string | null"
            },
            "serviceLevelScheduleId": "integer",
            "serviceLevelId": "string",
            "isOnHold": "boolean",
            "holdExceptionCodeId": "string | null",
            "holdNotes": "string | null",
            "referenceNumber1": "string",
            "referenceNumber2": "string",
            "referenceNumber3": "string"
        }
    ]
}

🟠400Request has missing/invalid values

🔴500An error occurred when trying to search for the orders

🟠401Unauthorized

Modified at 2025-02-27 08:47:04

Search for an order. Note: the POST /search endpoint should be favored over this one.

Get the items from multiple orders