Carriers

The carrier object

A shipping carrier configured for fulfilling orders.

Carriers with a Shippo-supported code (fedex, ups, usps) are connected through Shippo for live rating and label purchase; other carriers represent self-managed shipping methods such as will call or local delivery.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Human-readable name for the carrier, unique among your account's carriers.

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, used to connect UPS and USPS accounts.

customer_portal_visibilitystringenumValues:visiblehidden

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

ownerownernullable

Provenance of this carrier.

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

accountaccountnullable

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

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressaddressnullable

Default shipping address.

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_levelslistnullable

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

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

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).

Values are carrier-defined, so any non-empty string is accepted.

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.

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.

Used by

POSTCreate CarrierCarriers PATCHUpdate CarrierCarriers GETList CarriersCarriers GETRetrieve CarrierCarriers DELETEDelete CarrierCarriers POSTCreate CustomerCustomers PATCHUpdate CustomerCustomers GETList CustomersCustomers GETRetrieve CustomerCustomers POSTMerge CustomersCustomers POSTCreate Sales OrderSales Orders GETList Sales OrdersSales Orders

carrier example

{
  "id": "cr_01784fd54c9ba197bb4e42f0e6",
  "object": "carrier",
  "name": "FedEx",
  "code": "fedex",
  "account_number": null,
  "customer_portal_visibility": "visible",
  "owner": {
    "object": "owner",
    "type": "account",
    "account": {
      "id": "ac_01148680966698341a9c0976db",
      "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": null,
  "deleted_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "cr_01784fd54c9ba197bb4e42f0e6",
  "object": "carrier",
  "name": "FedEx",
  "code": "fedex",
  "account_number": null,
  "customer_portal_visibility": "visible",
  "owner": {
    "object": "owner",
    "type": "account",
    "account": {
      "id": "ac_01148680966698341a9c0976db",
      "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": null,
  "deleted_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Carriers

Attributes

Used by