carriers5

channels5

clusters5

customer-addresses3

customers4

delivery-modalities5

delivery-types5

freight-types5

fulfillment-order-shipment-tracking-events1

fulfillment-order-shipments3

fulfillment-order-tracking-events1

fulfillment-orders4

inventory2

inventory-movements1

operators5

order-payments2

orders7

payment-methods3

permissions1

price-lists7

product-categories5

products3

promotions5

state-machines6

statuses5

strategies5

strategy-carriers5

strategy-channels5

strategy-operators5

strategy-price-lists5

webhook-subscriptions6

carriers

Update carrier

Partially updates a carrier by its identifier. The code is immutable.

patch/api/v1/carriers/{id}

Path parameters

idstring uuid required

Example:01920000-0000-7000-8000-000000000000

Carrier identifier (UUID).

Request body

namestring

descriptionstring nullable

activeboolean

metadataobject nullable

Response

Carrier updated.

idstring required

codestring required

namestring required

descriptionstring nullable required

activeboolean required

metadataobject nullable required

created_atstring required

updated_atstring required

Changes

Changed in 2 of the 9 revisions of this API.11718

Jul 7, 2026a3b4750a505f18See the full diff
- ○
  added the new optional request property active
  new-optional-request-property
- ○
  added the new optional request property capabilities
  new-optional-request-property
- ○
  added the new optional request property default_freight_rules
  new-optional-request-property
- ○
  added the new optional request property default_operating_hours
  new-optional-request-property
- ○
  added the new optional request property description
  new-optional-request-property
- ○
  added the new optional request property metadata
  new-optional-request-property
- ○
  added the new optional request property name
  new-optional-request-property
- ○
  added the required property active to the response with the 200 status
  response-required-property-added
- ○
  added the required property capabilities to the response with the 200 status
  response-required-property-added
- ○
  added the required property code to the response with the 200 status
  response-required-property-added
- ○
  added the required property created_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property default_freight_rules to the response with the 200 status
  response-required-property-added
- ○
  added the required property default_operating_hours to the response with the 200 status
  response-required-property-added
- ○
  added the required property description to the response with the 200 status
  response-required-property-added
- ○
  added the required property id to the response with the 200 status
  response-required-property-added
- ○
  added the required property metadata to the response with the 200 status
  response-required-property-added
- ○
  added the required property name to the response with the 200 status
  response-required-property-added
- ○
  added the required property updated_at to the response with the 200 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 7, 202684194c31ab85117See the full diff
- ▲
  removed the required property active from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property capabilities from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property created_at from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property default_freight_rules from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property default_operating_hours from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property description from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property metadata from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property updated_at from the response with the 200 status
  response-required-property-removed
- ●
  removed the request property active
  request-property-removed
- ●
  removed the request property capabilities
  request-property-removed
- ●
  removed the request property default_freight_rules
  request-property-removed
- ●
  removed the request property default_operating_hours
  request-property-removed
- ●
  removed the request property description
  request-property-removed
- ●
  removed the request property metadata
  request-property-removed
- ●
  removed the request property name
  request-property-removed
This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history