StatimRx Logistics API Ref
  1. stop-sequence
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
            PUT
        • 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. stop-sequence

Change the stops sequence of the route

Testing Env
https://statimlogistics-test.dsapp.io/integration
Testing Env
https://statimlogistics-test.dsapp.io/integration
PUT
https://statimlogistics-test.dsapp.io/integration
/api/v1/routes/{routeId}/stop-sequence
Change the stops sequence of the route. Pickup of every order should be specified before its delivery. 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
routeId
string 
required
(Required)
Example:
<string>
Header Params
Content-Type
string 
required
Example:
application/json
Accept
string 
required
Example:
text/plain
Body Params application/json
stopSequence
array [object {2}] 
required
orderId
string 
required
stopKind
integer 
required
Example
{
  "stopSequence": [
    {
      "orderId": "<string>",
      "stopKind": 0
    },
    {
      "orderId": "<string>",
      "stopKind": 2
    }
  ]
}

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 PUT 'https://statimlogistics-test.dsapp.io/integration/api/v1/routes/<string>/stop-sequence' \
--header 'Accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
  "stopSequence": [
    {
      "orderId": "<string>",
      "stopKind": 0
    },
    {
      "orderId": "<string>",
      "stopKind": 2
    }
  ]
}'

Responses

🟢200Route's stops sequence updated
text/plain
Body
object {0}
🟠400Request has missing/invalid values
🟠404Route not found
🔴500An error occurred when trying to sequence the stops of the route
🟠401Unauthorized
Modified at 2025-02-27 09:12:53
Previous
Get routes
Next
Convert to on-demand
Built with