Update Service Level

Beta

PATCH/v1/operations/carriers/{carrier_id}/service-levels/{id}

Idempotent with Idempotency-Key header. Learn more

Updates a service level's name, code, customer portal visibility, or default status.

Only the fields you send are changed. System-owned service levels cannot be updated.

Permissions requiredValues:carriers:update

The role behind your API key or agent must grant every one of these permissions.

carrier_idstring

The carrier that owns this service level.

idstring

Service level ID.

include[]optional arrayenumValues:ownerowner.account

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

nameoptional string

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

codeoptional string

Carrier-specific code identifying this service level (e.g. fedex_ground).

Must be unique among the carrier's service levels. For a service level synced from a connected carrier the service_level_token used for rating is fixed by the carrier and a code change does not affect it; for one you created yourself, the token follows the code.

customer_portal_visibilityoptional stringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultoptional boolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting this to true clears the carrier's existing default.

default_transit_daysoptional integernullable

Business days this service typically takes in transit, used to work an order's ship-by date back from a promised delivery date.

A fallback: when a carrier can rate the lane, the transit it quotes is used instead. Set to null to remove it, which leaves transit unknown for lanes the carrier cannot rate. Send null to clear.

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

service_level_tokenstring

Carrier-specific code identifying this service level (e.g. fedex_ground, ups_next_day_air).

For service levels synced from a connected carrier this is the carrier's own token, which is what rate shopping and label purchase are keyed on; for service levels you create yourself it is the code you supplied.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultboolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting a new default clears the previous one. A default service level cannot be deleted until another service level takes its place or the flag is cleared.

default_transit_daysintegernullable

Business days this service typically takes in transit, used to work an order's ship-by date back from a promised delivery date.

A fallback for lanes the carrier has not quoted. Null means transit is unknown for this service rather than instant, so a ship-by date falls back to the promised delivery date itself.

ownerownerExpandablenullable

Provenance of this service level.

System-owned service levels are platform-provided defaults that cannot be updated or deleted; account-owned service levels are custom to your account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

system: a platform-provided default shared across all accounts; not editable.
account: created and owned by a specific account; the account field identifies which.

accountaccountExpandablenullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

The address billed by default on orders for this account.

Always returned as null in this endpoint.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

Always returned as null in this endpoint.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

Always returned as null in this endpoint.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Service Level

Update Service Level

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const serviceLevel = await client.operations.carriers.serviceLevels.update('crop_4ilk9p6gccrx', {
  carrier_id: 'cr_tv5vfjtgu1n3',
  code: 'express',
  customer_portal_visibility: 'visible',
  name: 'Express Shipping',
});

console.log(serviceLevel.id);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const serviceLevel = await client.operations.carriers.serviceLevels.update('crop_4ilk9p6gccrx', {
  carrier_id: 'cr_tv5vfjtgu1n3',
  code: 'express',
  customer_portal_visibility: 'visible',
  name: 'Express Shipping',
});

console.log(serviceLevel.id);

200 example

{
  "id": "crop_4ilk9p6gccrx",
  "object": "service_level",
  "name": "FedEx Ground",
  "service_level_token": "fedex_ground",
  "customer_portal_visibility": "visible",
  "is_default": true,
  "default_transit_days": 3,
  "owner": {
    "object": "owner",
    "type": "account",
    "account": {
      "id": "ac_ykxoradjoeb3",
      "object": "account",
      "name": "Acme Inc.",
      "default_billing_address": null,
      "default_shipping_address": null,
      "branding": null,
      "portal": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "crop_4ilk9p6gccrx",
  "object": "service_level",
  "name": "FedEx Ground",
  "service_level_token": "fedex_ground",
  "customer_portal_visibility": "visible",
  "is_default": true,
  "default_transit_days": 3,
  "owner": {
    "object": "owner",
    "type": "account",
    "account": {
      "id": "ac_ykxoradjoeb3",
      "object": "account",
      "name": "Acme Inc.",
      "default_billing_address": null,
      "default_shipping_address": null,
      "branding": null,
      "portal": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Service Level

Authorization

Path Parameters

Query Parameters

Request Body

Returns

Responses