StatimRx Logistics API Ref
  1. items
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
            GET
          • Add items to order
            POST
          • Update items of an order
            PUT
          • Delete items from an order
            DELETE
        • 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. items

Update items of an order

Testing Env
Testing Env
PUT
https://statimlogistics-test.dsapp.io/integration/api/v1/orders/{orderId}/items
If the parcel type does not allow custom dimensions and dimensions are entered, you will receive an error and no items will be updated.

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
(Required)
Example:
<string>
Header Params
Content-Type
string 
required
Example:
application/json
Accept
string 
required
Example:
text/plain
Body Params application/json
array of:
itemId
string 
required
barcode
string 
required
exceptionCodes
array [object {9}] 
required
addedAt
integer 
required
exceptionCodeTypeId
string 
required
displayName
string 
required
description
string 
required
code
string 
required
isVisibleByDriver
string 
required
isDamaged
string 
required
dispatchOption
integer 
required
types
array[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
userFieldId
string 
required
value
string 
required
Example
[
  {
    "itemId": "<string>",
    "barcode": "<string>",
    "exceptionCodes": [
      {
        "addedAt": 0,
        "exceptionCodeTypeId": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "code": "<string>",
        "isVisibleByDriver": "<boolean>",
        "isDamaged": "<boolean>",
        "dispatchOption": 1,
        "types": [
          "<string>",
          "<string>"
        ]
      },
      {
        "addedAt": 2,
        "exceptionCodeTypeId": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "code": "<string>",
        "isVisibleByDriver": "<boolean>",
        "isDamaged": "<boolean>",
        "dispatchOption": 1,
        "types": [
          "<string>",
          "<string>"
        ]
      }
    ],
    "parcelTypeId": "<string>",
    "description": "<string>",
    "weight": "<double>",
    "height": "<double>",
    "length": "<double>",
    "width": "<double>",
    "userFields": [
      {
        "userFieldId": "<string>",
        "value": "<string>"
      },
      {
        "userFieldId": "<string>",
        "value": "<string>"
      }
    ]
  },
  {
    "itemId": "<string>",
    "barcode": "<string>",
    "exceptionCodes": [
      {
        "addedAt": 2,
        "exceptionCodeTypeId": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "code": "<string>",
        "isVisibleByDriver": "<boolean>",
        "isDamaged": "<boolean>",
        "dispatchOption": 1,
        "types": [
          "<string>",
          "<string>"
        ]
      },
      {
        "addedAt": 1,
        "exceptionCodeTypeId": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "code": "<string>",
        "isVisibleByDriver": "<boolean>",
        "isDamaged": "<boolean>",
        "dispatchOption": 1,
        "types": [
          "<string>",
          "<string>"
        ]
      }
    ],
    "parcelTypeId": "<string>",
    "description": "<string>",
    "weight": "<double>",
    "height": "<double>",
    "length": "<double>",
    "width": "<double>",
    "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 PUT 'https://statimlogistics-test.dsapp.io/integration/api/v1/orders/<string>/items' \
--header 'Accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '[
  {
    "itemId": "<string>",
    "barcode": "<string>",
    "exceptionCodes": [
      {
        "addedAt": 0,
        "exceptionCodeTypeId": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "code": "<string>",
        "isVisibleByDriver": "<boolean>",
        "isDamaged": "<boolean>",
        "dispatchOption": 1,
        "types": [
          "<string>",
          "<string>"
        ]
      },
      {
        "addedAt": 2,
        "exceptionCodeTypeId": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "code": "<string>",
        "isVisibleByDriver": "<boolean>",
        "isDamaged": "<boolean>",
        "dispatchOption": 1,
        "types": [
          "<string>",
          "<string>"
        ]
      }
    ],
    "parcelTypeId": "<string>",
    "description": "<string>",
    "weight": "<double>",
    "height": "<double>",
    "length": "<double>",
    "width": "<double>",
    "userFields": [
      {
        "userFieldId": "<string>",
        "value": "<string>"
      },
      {
        "userFieldId": "<string>",
        "value": "<string>"
      }
    ]
  },
  {
    "itemId": "<string>",
    "barcode": "<string>",
    "exceptionCodes": [
      {
        "addedAt": 2,
        "exceptionCodeTypeId": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "code": "<string>",
        "isVisibleByDriver": "<boolean>",
        "isDamaged": "<boolean>",
        "dispatchOption": 1,
        "types": [
          "<string>",
          "<string>"
        ]
      },
      {
        "addedAt": 1,
        "exceptionCodeTypeId": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "code": "<string>",
        "isVisibleByDriver": "<boolean>",
        "isDamaged": "<boolean>",
        "dispatchOption": 1,
        "types": [
          "<string>",
          "<string>"
        ]
      }
    ],
    "parcelTypeId": "<string>",
    "description": "<string>",
    "weight": "<double>",
    "height": "<double>",
    "length": "<double>",
    "width": "<double>",
    "userFields": [
      {
        "userFieldId": "<string>",
        "value": "<string>"
      },
      {
        "userFieldId": "<string>",
        "value": "<string>"
      }
    ]
  }
]'

Responses

🟢200Items updated.
text/plain
Body
object {0}
🟠400Request has invalid values
🟠404Order not found
🔴500An error occurred when trying to update the items
🟠401Unauthorized
Modified at 2025-02-27 06:47:19
Previous
Add items to order
Next
Delete items from an order
Built with