StatimRx Logistics API Ref
  1. quote
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
          POST
      • {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
        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. quote

Get a quote for an order

Testing Env
Testing Env
POST
https://statimlogistics-test.dsapp.io/integration/api/v1/orders/quote
Get a quote for an order. The quote response can return an array
named "validationErrors" containing errors that will need to be addressed should you choose to create the order.
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
Accept
string 
required
Example:
text/plain
Body Params application/json
dropoffAddress
object 
required
addressLine1
string 
required
city
string 
required
postalCode
string 
required
stateProvince
string 
required
addressLine2
string 
required
company
string 
required
pickupAddress
object 
required
addressLine1
string 
required
city
string 
required
postalCode
string 
required
stateProvince
string 
required
addressLine2
string 
required
company
string 
required
pickupLocation
object 
required
latitude
string 
required
longitude
string 
required
pickupContactInfo
object 
required
id
string 
required
name
string 
required
phoneNumber
string 
required
email
string 
required
language
string 
required
pickupWindow
object 
required
end
string 
required
start
string 
required
pickupLocalWindow
object 
required
end
string 
required
start
string 
required
pickupNotes
string 
required
dropoffLocation
object 
required
latitude
string 
required
longitude
string 
required
dropoffContactInfo
object 
required
id
string 
required
name
string 
required
phoneNumber
string 
required
email
string 
required
language
string 
required
dropoffWindow
object 
required
end
string 
required
start
string 
required
dropoffLocalWindow
object 
required
end
string 
required
start
string 
required
dropoffNotes
string 
required
notes
string 
required
serviceLevelId
string 
required
webhookUrl
string 
required
metadata
object 
required
velit_9
string 
required
dolore661
string 
required
elit0a
string 
required
eac9f
string 
required
numberOfPieces
string 
required
weight
string 
required
readyAt
string 
required
pickupLocalReadyAt
string 
required
vehicleTypeId
string 
required
attributeIds
array[string]
required
extraFees
array [object {2}] 
required
extraFeeId
string 
required
quantity
string 
required
items
array [object {8}] 
required
barcodeTemplate
string 
required
parcelTypeId
string 
required
description
string 
required
weight
string 
required
height
string 
required
length
string 
required
width
string 
required
userFields
array [object {2}] 
required
pickupDurationInMinutes
string 
required
deliveryDurationInMinutes
string 
required
collectOnDelivery
string 
required
collectOnPickup
string 
required
allowPartialCollectOnDelivery
string 
required
allowPartialCollectOnPickup
string 
required
requireIdentityValidation
string 
required
requireIdentityValidationOnPickup
string 
required
generateProofOfDeliveryOnDelivery
string 
required
referenceNumber1
string 
required
referenceNumber2
string 
required
referenceNumber3
string 
required
orderProfileId
string 
required
workflows
array [object {3}] 
required
id
string 
required
workflowType
integer 
required
workflowSteps
array [object {3}] 
required
userFields
array [object {2}] 
required
userFieldId
string 
required
value
string 
required
Example
{
  "dropoffAddress": {
    "addressLine1": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "stateProvince": "<string>",
    "addressLine2": "<string>",
    "company": "<string>"
  },
  "pickupAddress": {
    "addressLine1": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "stateProvince": "<string>",
    "addressLine2": "<string>",
    "company": "<string>"
  },
  "pickupLocation": {
    "latitude": "<double>",
    "longitude": "<double>"
  },
  "pickupContactInfo": {
    "id": "<integer>",
    "name": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "language": "<string>"
  },
  "pickupWindow": {
    "end": "<dateTime>",
    "start": "<dateTime>"
  },
  "pickupLocalWindow": {
    "end": "<dateTime>",
    "start": "<dateTime>"
  },
  "pickupNotes": "<string>",
  "dropoffLocation": {
    "latitude": "<double>",
    "longitude": "<double>"
  },
  "dropoffContactInfo": {
    "id": "<integer>",
    "name": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "language": "<string>"
  },
  "dropoffWindow": {
    "end": "<dateTime>",
    "start": "<dateTime>"
  },
  "dropoffLocalWindow": {
    "end": "<dateTime>",
    "start": "<dateTime>"
  },
  "dropoffNotes": "<string>",
  "notes": "<string>",
  "serviceLevelId": "<string>",
  "webhookUrl": "<string>",
  "metadata": {
    "velit_9": "<string>",
    "dolore661": "<string>",
    "elit0a": "<string>",
    "eac9f": "<string>"
  },
  "numberOfPieces": "<integer>",
  "weight": "<double>",
  "readyAt": "<dateTime>",
  "pickupLocalReadyAt": "<dateTime>",
  "vehicleTypeId": "<string>",
  "attributeIds": [
    "<string>",
    "<string>"
  ],
  "extraFees": [
    {
      "extraFeeId": "<string>",
      "quantity": "<double>"
    },
    {
      "extraFeeId": "<string>",
      "quantity": "<double>"
    }
  ],
  "items": [
    {
      "barcodeTemplate": "<string>",
      "parcelTypeId": "<string>",
      "description": "<string>",
      "weight": "<double>",
      "height": "<double>",
      "length": "<double>",
      "width": "<double>",
      "userFields": [
        {
          "userFieldId": "<string>",
          "value": "<string>"
        },
        {
          "userFieldId": "<string>",
          "value": "<string>"
        }
      ]
    },
    {
      "barcodeTemplate": "<string>",
      "parcelTypeId": "<string>",
      "description": "<string>",
      "weight": "<double>",
      "height": "<double>",
      "length": "<double>",
      "width": "<double>",
      "userFields": [
        {
          "userFieldId": "<string>",
          "value": "<string>"
        },
        {
          "userFieldId": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "pickupDurationInMinutes": "<integer>",
  "deliveryDurationInMinutes": "<integer>",
  "collectOnDelivery": "<double>",
  "collectOnPickup": "<double>",
  "allowPartialCollectOnDelivery": "<boolean>",
  "allowPartialCollectOnPickup": "<boolean>",
  "requireIdentityValidation": "<boolean>",
  "requireIdentityValidationOnPickup": "<boolean>",
  "generateProofOfDeliveryOnDelivery": "<boolean>",
  "referenceNumber1": "<string>",
  "referenceNumber2": "<string>",
  "referenceNumber3": "<string>",
  "orderProfileId": "<string>",
  "workflows": [
    {
      "id": "<string>",
      "workflowType": 2,
      "workflowSteps": [
        {
          "stepId": "<string>",
          "selectionStepId": "<string>",
          "isActive": "<boolean>"
        },
        {
          "stepId": "<string>",
          "selectionStepId": "<string>",
          "isActive": "<boolean>"
        }
      ]
    },
    {
      "id": "<string>",
      "workflowType": 2,
      "workflowSteps": [
        {
          "stepId": "<string>",
          "selectionStepId": "<string>",
          "isActive": "<boolean>"
        },
        {
          "stepId": "<string>",
          "selectionStepId": "<string>",
          "isActive": "<boolean>"
        }
      ]
    }
  ],
  "userFields": [
    {
      "userFieldId": "<string>",
      "value": "<string>"
    },
    {
      "userFieldId": "<string>",
      "value": "<string>"
    }
  ]
}

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/quote' \
--header 'Accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
  "dropoffAddress": {
    "addressLine1": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "stateProvince": "<string>",
    "addressLine2": "<string>",
    "company": "<string>"
  },
  "pickupAddress": {
    "addressLine1": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "stateProvince": "<string>",
    "addressLine2": "<string>",
    "company": "<string>"
  },
  "pickupLocation": {
    "latitude": "<double>",
    "longitude": "<double>"
  },
  "pickupContactInfo": {
    "id": "<integer>",
    "name": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "language": "<string>"
  },
  "pickupWindow": {
    "end": "<dateTime>",
    "start": "<dateTime>"
  },
  "pickupLocalWindow": {
    "end": "<dateTime>",
    "start": "<dateTime>"
  },
  "pickupNotes": "<string>",
  "dropoffLocation": {
    "latitude": "<double>",
    "longitude": "<double>"
  },
  "dropoffContactInfo": {
    "id": "<integer>",
    "name": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "language": "<string>"
  },
  "dropoffWindow": {
    "end": "<dateTime>",
    "start": "<dateTime>"
  },
  "dropoffLocalWindow": {
    "end": "<dateTime>",
    "start": "<dateTime>"
  },
  "dropoffNotes": "<string>",
  "notes": "<string>",
  "serviceLevelId": "<string>",
  "webhookUrl": "<string>",
  "metadata": {
    "velit_9": "<string>",
    "dolore661": "<string>",
    "elit0a": "<string>",
    "eac9f": "<string>"
  },
  "numberOfPieces": "<integer>",
  "weight": "<double>",
  "readyAt": "<dateTime>",
  "pickupLocalReadyAt": "<dateTime>",
  "vehicleTypeId": "<string>",
  "attributeIds": [
    "<string>",
    "<string>"
  ],
  "extraFees": [
    {
      "extraFeeId": "<string>",
      "quantity": "<double>"
    },
    {
      "extraFeeId": "<string>",
      "quantity": "<double>"
    }
  ],
  "items": [
    {
      "barcodeTemplate": "<string>",
      "parcelTypeId": "<string>",
      "description": "<string>",
      "weight": "<double>",
      "height": "<double>",
      "length": "<double>",
      "width": "<double>",
      "userFields": [
        {
          "userFieldId": "<string>",
          "value": "<string>"
        },
        {
          "userFieldId": "<string>",
          "value": "<string>"
        }
      ]
    },
    {
      "barcodeTemplate": "<string>",
      "parcelTypeId": "<string>",
      "description": "<string>",
      "weight": "<double>",
      "height": "<double>",
      "length": "<double>",
      "width": "<double>",
      "userFields": [
        {
          "userFieldId": "<string>",
          "value": "<string>"
        },
        {
          "userFieldId": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "pickupDurationInMinutes": "<integer>",
  "deliveryDurationInMinutes": "<integer>",
  "collectOnDelivery": "<double>",
  "collectOnPickup": "<double>",
  "allowPartialCollectOnDelivery": "<boolean>",
  "allowPartialCollectOnPickup": "<boolean>",
  "requireIdentityValidation": "<boolean>",
  "requireIdentityValidationOnPickup": "<boolean>",
  "generateProofOfDeliveryOnDelivery": "<boolean>",
  "referenceNumber1": "<string>",
  "referenceNumber2": "<string>",
  "referenceNumber3": "<string>",
  "orderProfileId": "<string>",
  "workflows": [
    {
      "id": "<string>",
      "workflowType": 2,
      "workflowSteps": [
        {
          "stepId": "<string>",
          "selectionStepId": "<string>",
          "isActive": "<boolean>"
        },
        {
          "stepId": "<string>",
          "selectionStepId": "<string>",
          "isActive": "<boolean>"
        }
      ]
    },
    {
      "id": "<string>",
      "workflowType": 2,
      "workflowSteps": [
        {
          "stepId": "<string>",
          "selectionStepId": "<string>",
          "isActive": "<boolean>"
        },
        {
          "stepId": "<string>",
          "selectionStepId": "<string>",
          "isActive": "<boolean>"
        }
      ]
    }
  ],
  "userFields": [
    {
      "userFieldId": "<string>",
      "value": "<string>"
    },
    {
      "userFieldId": "<string>",
      "value": "<string>"
    }
  ]
}'

Responses

🟢200Quote was successfully returned
text/plain
Body
object {0}
🟠400Request has missing/invalid values
🟠401Unauthorized
🔴500An error occurred when trying to create the quote
Modified at 2025-02-27 05:05:49
Previous
Create a new order from a template
Next
{orderId}
Built with