/loadcarriers/{identifier}/actions

Modify an existing load carrier. Supported actions:

  • 'set-localized-name': Update the display name (localized)
  • 'set-localized-description': Update the description (localized)
  • 'set-preset': Update dimensions (length, width, height) and stackable property
  • 'set-is-bookable': Update the bookable status
  • 'set-status': Update the status (active/inactive)
  • 'set-restrictions': Set or update shipper access restrictions Restrictions use a query structure: {combinator: 'and'|'or', rules: [{field: string, operator: string, value: string}]} Available fields: id, name, status, createdAt, entityInfo.email, entityInfo.country, entityInfo.city, entityInfo.zipCode, source.type Operators vary by field type: '=' (equals), 'contains', 'beginsWith', 'endsWith', '<' (before), '>' (after) Example: {combinator: 'and', rules: [{field: 'entityInfo.country', operator: '=', value: 'DEU'}, {field: 'status', operator: '=', value: 'active'}]} When restrictions are set, only shippers matching the query can select this load carrier in the booking flow.
  • 'remove-restrictions': Clear all access restrictions (makes load carrier available to all shippers)

Note: The identifier field cannot be modified.

The endpoint uses optimistic locking. If a concurrent modification is detected (409 CONFLICT), the request will be automatically retried up to 5 times with exponential backoff.

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!