StatimRx Logistics API Ref
  1. {routeId}
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.
      • items
        • Get the items from multiple orders
      • Create a new order
    • 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
          PATCH
        • Delete a route
          DELETE
        • Get route
          GET
      • Create a route
        POST
    • 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. {routeId}

Get route

Testing Env
https://statimlogistics-test.dsapp.io/integration
Testing Env
https://statimlogistics-test.dsapp.io/integration
GET
https://statimlogistics-test.dsapp.io/integration
/api/v1/routes/{routeId}
Get a route by its id. 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 *****************
Path Params

Query Params

Header Params

Request Code 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 GET 'https://statimlogistics-test.dsapp.io/integration/api/v1/routes/<string>?onlyRouteMetadata=<boolean>' \
--header 'Accept: text/plain' \
--header 'Authorization: Basic Og=='

Responses

🟢200The route for the specified id
text/plain
Body

Example
{
    "id": "string",
    "routePlanId": "integer",
    "routeContainerId": "string",
    "name": "string",
    "ordersCount": "integer",
    "isManuallyCreated": "boolean",
    "isDispatched": "boolean",
    "hexColor": "string | null",
    "startTime": "datetime",
    "allocatedDriver": {
        "email": "string",
        "phoneNumber": "string",
        "firstName": "string",
        "lastName": "string",
        "otherName": "string | null",
        "plateNumber": "string | null",
        "driverNumber": "string",
        "mobileNumber": "string",
        "hasPicture": "boolean",
        "homeAddress": {
            "addressLine1": "string | null",
            "addressLine2": "string | null",
            "company": "string | null",
            "city": "string | null",
            "postalCode": "string | null",
            "stateProvince": "string | null"
        },
        "preferredModeOfCommunication": "string | null",
        "employeeInformation": "string | null",
        "vehicleDescription": "string | null",
        "usesScheduleBasedOptimization": "boolean",
        "zones": "array | null",
        "lockoutEnd": "datetime | null",
        "id": "string",
        "userName": "string",
        "vehicleTypeId": "string",
        "status": "integer",
        "workShiftEndTime": "datetime | null",
        "dispatchNotes": "string | null",
        "latitude": "float",
        "longitude": "float",
        "speed": "float",
        "speedInKmh": "boolean",
        "driverProfileId": "string",
        "payoutScheduleId": "integer",
        "lastPositionUpdate": "datetime | null",
        "disableReturnHome": "boolean",
        "excludeFromAutoDispatch": "boolean",
        "homeLocation": "string | null",
        "isArchived": "boolean",
        "attributeIds": "array | null",
        "driverNotes": "string | null",
        "externalId": "string | null",
        "vehicleWeightAdjustment": "float",
        "vehicleVolumeAdjustment": "float",
        "vehicleNumberOfPiecesAdjustment": "float",
        "settlementCycleId": "integer",
        "settlementTemplateId": "integer | null",
        "hexColor": "string | null",
        "cashSettlementCompanyId": "integer | null",
        "deserializedAttributeIds": "array",
        "isDisconnected": "boolean",
        "fullName": "string",
        "displayName": "string"
    }
}
🟠404Route not found
🔴500An error occurred when trying to get the route
🟠401Unauthorized
Modified at 2025-02-27 09:21:37
Previous
Delete a route
Next
Create a route
Built with