DEV

Type.

CarrierAccount

A CarrierAccount is an account number that is associated with a carrier for a given customer or group of customers. Rates may vary across carrier accounts, depending on the customer and volume with the carrier. Shipments cannot be created without a carrierAccount.

Fields

additionalFee

Decimal

A monetary amount specified by the merchant as a buffer for any additional fees.

carrier

Carrier!

Required

The Carrier associated with this CarrierAccount.

createdAt

DateTime!

Required

When the CarrierAccount was created.

createdBy

ID!

Required

The user who created the CarrierAccount.

credentialProvider

CredentialProvider!

Required

Where the credentials are stored.
The Carrier's API credentials.

id

ID!

Required

A unique identifier for the CarrierAccount.

Required

Indicates what type of integration this CarrierAccount supports either SOAP or REST.

mode

Mode!

Required

Specifies whether the CarrierAccount is in live or test mode.

organization

ID!

Required

The Organization associated with the CarrierAccount.
Rate type for the carrier account. Either RETAIL or NEGOTIATED.

Required

Indicates whether this CarrierAccount was registered through Zonos APIs or another source

shippingPercentIncrease

Decimal

Describes the additionalFee as a percentage.

updatedAt

DateTime!

Required

When the CarrierAccount was most recently updated.

updatedBy

ID!

Required

The user who most recently updated the CarrierAccount.

Was this page helpful?