Get Carrier

Beta
GET/v1/operations/carriers/{id}

This endpoint is idempotent. Learn more

Returns a carrier by ID.

idstring

Carrier ID.

include[]optional arrayenumValues:ownerowner.accountservice_levels

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

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Display name.

codestringnullableenumValues:fedexupsusps

Carrier code.

account_numberstringnullable

Account number.

customer_portal_visibilitystringenumValues:visiblehidden

Customer portal visibility.

ownerobjectExpandablenullable

Owner.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

The owner type: "system" for platform defaults, "account" for account-owned resources.

accountobjectExpandablenullable

The account that owns this resource. null if the object is system-owned.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.
default_shipping_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.
brandingobjectnullable

Branding configuration.

Always returned as null in this endpoint.
portalobjectnullable

Portal configuration.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

service_levelsobjectExpandablenullable

Service levels.

objectstringenumValues:list

Object type for ServiceLevel list

page_infoobject

Pagination metadata for ServiceLevel list

next_cursorstringnullable

Cursor to fetch the next page, null if no more pages.

prev_cursorstringnullable

Cursor to fetch the previous page, null if 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 object

Array of ServiceLevel resources in this page

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Display name.

service_level_tokenstring

Service level token.

customer_portal_visibilitystringenumValues:visiblehidden

Customer portal visibility.

is_defaultboolean

Default service level for the carrier.

ownerobjectnullable

Owner.

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 Get Carrier