List Service Levels

Beta

GET/v1/operations/carriers/{carrier_id}/service-levels

This endpoint is idempotent. Learn more

Returns a paginated list of the service levels a carrier offers.

Use this rather than the service_levels field on the carrier itself when a carrier has more than a handful of services, since that inline list is capped.

Permissions requiredValues:carriers:readcustomers:readsuppliers:read

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

carrier_idstring

The carrier whose service levels are listed.

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

include[]optional arrayenumValues:ownerowner.account

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

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.

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 List Service Levels

List Service Levels

import OpenMRP from '@openmrp/sdk';

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

const listServiceLevel = await client.operations.carriers.serviceLevels.list('cr_tv5vfjtgu1n3');

console.log(listServiceLevel.data);

import OpenMRP from '@openmrp/sdk';

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

const listServiceLevel = await client.operations.carriers.serviceLevels.list('cr_tv5vfjtgu1n3');

console.log(listServiceLevel.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/operations/carriers/cr_tv5vfjtgu1n3/service-levels?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiY3JvcF80aWxrOXA2Z2NjcngiLCJkIjoiZiJ9.LPxddqAvz3Wiga1k5Pu8DIgJTINDU-3aatB1ODFkz78",
    "previous_page_url": null,
    "has_next_page": true,
    "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": {
        "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"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/operations/carriers/cr_tv5vfjtgu1n3/service-levels?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiY3JvcF80aWxrOXA2Z2NjcngiLCJkIjoiZiJ9.LPxddqAvz3Wiga1k5Pu8DIgJTINDU-3aatB1ODFkz78",
    "previous_page_url": null,
    "has_next_page": true,
    "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": {
        "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"
    }
  ]
}

List Service Levels

Authorization

Path Parameters

Query Parameters

Returns

Responses