Skip to Content

PATCH Items

Use this endpoint to update existing items.

User level: Advanced

Endpoint

PATCH /v1/{scopeId}/items/{id}
PropertyValue
MethodPATCH
Scope IDBranch UUID
AuthenticationAuthorization: Bearer <access_token>
Required scoperoutix:items:write
Content-Typeapplication/json
Request bodyJSON object

Update rules

  • The API validates server-side whether the record belongs to the allowed organization and branch.
  • This is a branch-or-null resource, but the PATCH call still uses a branch UUID in {scopeId}.
  • Only explicitly allowed fields can be updated.
  • Unknown or disallowed fields return 400 invalid_update.

Allowed update fields

Field
name
description
item_type
status
default_ldm

Example request

curl -X PATCH "https://api.routix.com/v1/550e8400-e29b-41d4-a716-446655440000/items/d021bce1-a12b-462f-9d77-9fe0c2b55959" \ -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \ -H "Content-Type: application/json" \ -d '{ "status": "active", "default_ldm": 0.4 }'

Example response

{ "data": { "id": "d021bce1-a12b-462f-9d77-9fe0c2b55959", "name": "Pallet transport", "description": "Standard pallet shipment item", "item_type": "service", "status": "active", "default_ldm": 0.4 }, "version": "v1" }

Error response

{ "error": "invalid_update", "error_description": "One or more fields are not allowed for updates on items" }

Possible error codes

  • 400 invalid_request
  • 400 invalid_update
  • 401 unauthorized
  • 401 invalid_token
  • 403 invalid_token_type
  • 403 insufficient_scope
  • 404 not_found
  • 405 method_not_allowed
  • Items GET
  • API calls & examples
  • Setup guide
Last updated on