The carrier account object

A comprehensive list of the carrier account resource's attributes and relationships

A carrier account object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/carrier_accounts endpoint.

Fields

FieldTypeDescription

type

string

carrier_accounts

id

string

The carrier account unique identifier

links.self

string

The carrier account endpoint URL

attributes.name

string

The carrier account internal name.

attributes.easypost_type

string

The Easypost service carrier type.

attributes.easypost_id

string

The Easypost internal reference ID.

attributes.credentials

object

The Easypost carrier accounts credentials fields.

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

relationships.market

object

The associated market.

relationships.attachments

array

The associated attachments.

relationships.versions

array

The associated changes.

meta.mode

string

The resource environment (can be one of test or live)

Last updated