StatimRx Logistics API Ref
    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
          • 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

    Integration API

    Summary#

    The Integration API provides a simple way to integrate your system to the system. The API allows you to create, get, update and cancel orders.
    For full details of the API, use the first part of your API URL followed by. /integration/swagger/

    Authentication#

    The integration API uses basic authentication. Basic authentication is a simple authentication scheme built into the HTTP protocol. The client sends HTTP requests with the Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.
    For example, to authorize as demo / p@55w0rd the client would send:
    Authorization: Basic ZGVtbzpwQDU1dzByZA==
    This site can be used to generate the header value:

    Date / Time#

    The timezone used in the date-time fields will be converted to the time zone set up for the customer account when displayed in Statim Logistics.

    Webhooks & Subscriptions#

    Webhooks and subscriptions are used to get updates from the Statim Logistics without having to poll the service. By registering a URL, the system will call back that URL to notify the external site of a change in API.
    Modified at 2025-01-22 13:50:24
    Next
    account
    Built with