StatimRx Logistics API Ref
  1. {orderId}
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
          PATCH
        • Get an order
          GET
        • Cancel an order
          DELETE
      • 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
        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. {orderId}

Get an order

Testing Env
Testing Env
GET
https://statimlogistics-test.dsapp.io/integration/api/v1/orders/{orderID}
Gets an order from the system. 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
orderID
string 
required

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 GET 'https://statimlogistics-test.dsapp.io/integration/api/v1/orders/' \
--header 'Authorization: Basic Og=='

Responses

🟢200Order returned
text/plain
Body
object {0}
Example
{
  "orderId": "string",
  "status": "number",
  "driverId": "string | null",
  "driverName": "string | null",
  "accountId": "string",
  "accountNumber": "string",
  "createdByUserId": "string",
  "createdByUserName": "string",
  "isFromRecurringOrder": "boolean",
  "pickupAddress": {
    "addressLine1": "string",
    "addressLine2": "string | null",
    "company": "string | null",
    "city": "string",
    "postalCode": "string",
    "stateProvince": "string"
  },
  "pickupLocation": {
    "latitude": "number",
    "longitude": "number",
    "isValid": "boolean"
  },
  "pickupTimeZone": {
    "systemTimeZoneId": "string",
    "ianaTimeZoneId": "string",
    "shortDisplayName": "string",
    "longDisplayName": "string",
    "isDaylightSavingTime": "boolean",
    "offset": "number"
  },
  "pickupContactInfo": {
    "id": "string | null",
    "name": "string",
    "phoneNumber": "string",
    "email": "string",
    "language": "string"
  },
  "pickupNotes": "string",
  "dropoffAddress": {
    "addressLine1": "string",
    "addressLine2": "string | null",
    "company": "string | null",
    "city": "string",
    "postalCode": "string",
    "stateProvince": "string"
  },
  "dropoffLocation": {
    "latitude": "number",
    "longitude": "number",
    "isValid": "boolean"
  },
  "dropoffTimeZone": {
    "systemTimeZoneId": "string",
    "ianaTimeZoneId": "string",
    "shortDisplayName": "string",
    "longDisplayName": "string",
    "isDaylightSavingTime": "boolean",
    "offset": "number"
  },
  "dropoffContactInfo": {
    "id": "string | null",
    "name": "string",
    "phoneNumber": "string",
    "email": "string",
    "language": "string"
  },
  "dropoffNotes": "string",
  "pickupWindow": {
    "start": "string (ISO 8601 datetime)",
    "end": "string (ISO 8601 datetime)"
  },
  "dropoffWindow": {
    "start": "string (ISO 8601 datetime)",
    "end": "string (ISO 8601 datetime)"
  },
  "pickupDurationInMinutes": "number",
  "deliveryDurationInMinutes": "number",
  "distance": "number",
  "distanceUnits": "string",
  "serviceLevelId": "string",
  "notes": "string",
  "webhookUrl": "string",
  "metadata": {
    "metadata1": "string",
    "metadata2": "string"
  },
  "numberOfPieces": "number",
  "weight": "number",
  "weightUnits": "string",
  "volume": "number",
  "volumeUnits": "string",
  "readyAt": "string (ISO 8601 datetime)",
  "createdAt": "string (ISO 8601 datetime)",
  "lastHoldDate": "string (ISO 8601 datetime) | null",
  "statusAssignedDate": "string (ISO 8601 datetime) | null",
  "statusArrivedAtPickupDate": "string (ISO 8601 datetime) | null",
  "statusPickedUpDate": "string (ISO 8601 datetime) | null",
  "statusArrivedAtDeliveryDate": "string (ISO 8601 datetime) | null",
  "statusDeliveredDate": "string (ISO 8601 datetime) | null",
  "statusCancelledDate": "string (ISO 8601 datetime) | null",
  "receivedBy": "string | null",
  "receivedOnPickupFrom": "string | null",
  "vehicleTypeId": "string",
  "orderPayout": {
    "predefinedPayoutValue": "number | null",
    "driverCommissionCalculationType": "number",
    "delivery": {
      "calculationType": "number",
      "commissionPercentage": "number | null",
      "predefinedPayoutValue": "number | null",
      "fixedPayoutScheduleId": "string | null"
    },
    "fuelSurcharge": {
      "calculationType": "number",
      "commissionPercentage": "number | null",
      "predefinedPayoutValue": "number | null",
      "fixedPayoutScheduleId": "string | null"
    },
    "extraFees": {
      "calculationType": "number",
      "commissionPercentage": "number | null",
      "predefinedPayoutValue": "number | null",
      "fixedPayoutScheduleId": "string | null"
    }
  },
  "generateProofOfDeliveryOnDelivery": "boolean | null",
  "internalNotes": "string | null",
  "isOnHold": "boolean",
  "holdExceptionCodeId": "string | null",
  "holdNotes": "string | null",
  "orderProfileId": "string",
  "referenceNumber1": "string",
  "referenceNumber2": "string",
  "referenceNumber3": "string",
  "charges": [
    {
      "id": "string",
      "type": "string",
      "price": "number",
      "fromZone": "string | null",
      "toZone": "string | null"
    }
  ],
  "history": [
    {
      "eventName": "string",
      "timestamp": "string (ISO 8601 datetime)",
      "user": {
        "id": "string",
        "accountId": "string",
        "email": "string"
      },
      "status": "number"
    }
  ]
}
🟠404Order not found
🔴500An error occurred when trying to get the order
🟠401Unauthorized
Modified at 2025-02-27 07:27:05
Previous
Update an order
Next
Cancel an order
Built with