Type.

LabelSettings

No description

Fields

createdAt

•

DateTime!

Required

Timestamp of when the LabelSettings were created

createdBy

•

ID!

Required

The user who created the LabelSettings

currencyDisplayMode

•

CurrencyDisplayMode!

Required

Determines which currency is used on commercial invoices and customs documents. Defaults to ORDER.

customDeclarationStatements

•

[CustomDeclarationStatement!]!

Required

A customDeclaration object to be used when creating labels

declaredValue

•

Decimal!

Required

The default alternate return address to be used when creating labels

descriptionOverride

•

DescriptionOverride

DescriptionOverride gives the option to override descriptions displayed on labels, customs documents, or both

•

ID!

Required

Unique identifier for this LabelSettings object

labelFileType

•

LabelFileType

Indicates the default file type used when creating labels

labelSize

•

LabelSize

Indicates the default size to use when creating labels

organization

•

ID!

Required

The ID of the Organization these LabelSettings belong to

serviceLevel

•

ServiceLevel

Default ServiceLevel to use when creating labels.

shippingPayment

•

ShippingPaymentType

Indicates who will be responsible for paying the shipping charges

shipsDangerousGoods

•

Boolean

Indicates whether this organization ships dangerous goods. When true, item attributes with key DANGEROUS_GOODS are scanned during label creation and matching cartons are flagged with the appropriate carrier-specific service code. Nullable in this schema-only PR; the follow-up Java PR persists this field on LabelSettings with a NOT NULL DEFAULT false column and will tighten the type.

signatureRequired

•

Boolean!

Required

Indicates whether a signature is required for the label

updatedAt

•

DateTime!

Required

When the LabelSettings were most recently updated

updatedBy

•

ID!

Required

The user who most recently updated the LabelSettings

Fields

Was this page helpful?