StatimRx Logistics API Ref
  1. search
StatimRx Logistics API Ref
  • Integration API
    • account
      • workflows
        • Get Account Workflows
      • userfields
        • Get Account Order UserFields
    • import
      • mappings
        • Get the import mappings for the account.
      • Create a batch order import request from a file for order imports.
    • orders
      • return
        • Create a return order
      • from-template
        • Create a new order from a template
      • quote
        • Get a quote for an order
      • {orderId}
        • status
          • Get an order status
        • hold
          • Put an order on hold
        • charges
          • Add extra fees to an order
          • Update order extra fees
        • items
          • Get the items from an order
          • Add items to order
          • Update items of an order
          • Delete items from an order
        • trackeditemslog
          • Get the tracked items log from an order
        • barcodes
          • Update items barcodes
        • label
          • {templateId}
            • {format}
              • Download the labels for all items of an order
        • Update an order
        • Get an order
        • Cancel an order
      • search
        • {query}
          • Search for an order. Note: the POST /search endpoint should be favored over this one.
        • Search for orders.
          POST
      • items
        • Get the items from multiple orders
      • Create a new order
        POST
    • order-templates
      • search
        • Search for order templates.
    • routes
      • containers
        • Get containers
      • routes
        • Get routes
      • {routeId}
        • stop-sequence
          • Change the stops sequence of the route
        • convert-orders-to-ondemand
          • Convert to on-demand
        • move-orders-to-next-route
          • Move all orders of the route to the next scheduled route
        • move-orders
          • Move orders from a route to another
        • Update a route
        • Delete a route
        • Get route
      • Create a route
    • subscriptions
      • {subscriptionId}
        • Get a subscription
        • Modify an existing subscription
        • Unsubscribe from order updates
      • Get the subscriptions
      • Subscribe to order updates
    • userfields
      • {orderId}
        • items
          • Get the Order Item Userfields.
        • Get the Order Userfields
        • Update order Userfields
  1. search

Search for orders.

Testing Env
Testing Env
POST
https://statimlogistics-test.dsapp.io/integration/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
Content-Type
string 
required
Example:
application/json
Body Params application/json
query
string 
required
searchFields
array[string]
required
maximumResults
string 
required
operator
integer 
required
Example
{
  "query": "<string>",
  "searchFields": [
    "<string>",
    "<string>"
  ],
  "maximumResults": "<integer>",
  "operator": 1
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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
object {0}
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
Previous
Search for an order. Note: the POST /search endpoint should be favored over this one.
Next
Get the items from multiple orders
Built with