Update Carrier

Beta

PATCH/v1/operations/carriers/{id}

Idempotent with Idempotency-Key header. Learn more

Updates a carrier's name and customer portal visibility.

Only these two attributes can change: a carrier's code and account number are fixed at creation, and system-owned carriers cannot be updated at all.

Permissions requiredValues:carriers:update

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

idstring

Carrier ID.

include[]optional arrayenumValues:ownerowner.accountservice_levels

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

nameoptional string

Human-readable name for the carrier.

Must not match another carrier already visible to your account, including the system-provided ones.

customer_portal_visibilityoptional stringenumValues:visiblehidden

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

Each of the carrier's service levels carries its own customer portal visibility, which this does not change.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Human-readable name for the carrier, unique among the carriers visible to your account.

codestringnullableenumValues:fedexupsusps

Well-known carrier identifier, set only for recognized carriers and absent for custom ones.

fedex, ups, usps: integrated carriers managed through Shippo (live rating and labels).
will_call: customer picks the order up; no carrier shipment.
delivery: delivered by your own vehicles/drivers.
ltl, ltl1: less-than-truckload freight carriers.
freight_collect: freight billed to and arranged by the receiver.

account_numberstringnullable

Your account number with this carrier.

UPS and USPS carrier accounts are connected to Shippo using this number; FedEx carriers authorize through OAuth instead, so their account number is not used to connect them.

customer_portal_visibilitystringenumValues:visiblehidden

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

ownerownerExpandablenullable

Provenance of this carrier.

System-owned carriers are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned carriers 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.

service_levelslistExpandablenullable

Shipping service levels offered by this carrier (e.g. ground, overnight).

At most 10 service levels are returned inline; use the carrier's service levels endpoint to page through the full set.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of service_level

Resources in this page.

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.

ownerownernullable

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.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

deleted_atstring (date-time)nullable

Soft-delete timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Carrier

Update Carrier

import OpenMRP from '@openmrp/sdk';

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

const carrier = await client.operations.carriers.update('cr_tv5vfjtgu1n3', {
  customer_portal_visibility: 'visible',
  name: 'FedEx Express',
});

console.log(carrier.id);

import OpenMRP from '@openmrp/sdk';

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

const carrier = await client.operations.carriers.update('cr_tv5vfjtgu1n3', {
  customer_portal_visibility: 'visible',
  name: 'FedEx Express',
});

console.log(carrier.id);

200 example

{
  "id": "cr_tv5vfjtgu1n3",
  "object": "carrier",
  "name": "FedEx",
  "code": "fedex",
  "account_number": "603145678",
  "customer_portal_visibility": "visible",
  "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"
    }
  },
  "service_levels": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "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": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "deleted_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "cr_tv5vfjtgu1n3",
  "object": "carrier",
  "name": "FedEx",
  "code": "fedex",
  "account_number": "603145678",
  "customer_portal_visibility": "visible",
  "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"
    }
  },
  "service_levels": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "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": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "deleted_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Carrier

Authorization

Path Parameters

Query Parameters

Request Body

Returns

Responses