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

Create a return order

Testing Env
https://statimlogistics-test.dsapp.io/integration
Testing Env
https://statimlogistics-test.dsapp.io/integration
POST
https://statimlogistics-test.dsapp.io/integration
/api/v1/orders/return
Create a return order in the system. Even though an order is created successfully, the response can return an array
named "validationErrors" containing errors that will need to be addressed. 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 *****************
Query Params

Header Params

Body Params application/json

Example
{
  "serviceLevelId": "<string>",
  "ignoreItems": "<boolean>",
  "itemsToAdd": [
    {
      "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>"
        }
      ]
    }
  ]
}

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 POST 'https://statimlogistics-test.dsapp.io/integration/api/v1/orders/return?sourceOrderId=<string>' \
--header 'Accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
  "serviceLevelId": "<string>",
  "ignoreItems": "<boolean>",
  "itemsToAdd": [
    {
      "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>"
        }
      ]
    }
  ]
}'

Responses

🟢200Return order was successfully returned
text/plain
Body

Example
{
    "orderId": "string"
}
🟠400Request has missing/invalid values
🔴500An error occurred when trying to create the return order
🟠401Unauthorized
Modified at 2025-02-27 04:57:40
Previous
orders
Next
Create a new order from a template
Built with