Skip to main content

CustomCarrierMapping

This type represents a carrier mapping for an external integration

type CustomCarrierMapping {
  brandId: ID @deprecated
  companyId: ID!
  createdAt: ISO8601DateTime!
  externalCarrierName: String
  externalCarrierServiceCode: String
  externalCarrierServiceName: String
  id: ID!
  integrationId: ID!
  integrationName: String!
  internalCarrierServiceId: ID!
  internalCarrierServiceName: String!
  outboundDefault: Boolean!
  updatedAt: ISO8601DateTime!
}

Fields

`CustomCarrierMapping.brandId` ● `ID` deprecated scalar common

DEPRECATED

This field will be removed in the future. Brand is becoming a product-only attribute.

`CustomCarrierMapping.companyId` ● `ID!` non-null scalar common

`CustomCarrierMapping.createdAt` ● `ISO8601DateTime!` non-null scalar common

`CustomCarrierMapping.externalCarrierName` ● `String` scalar common

Optional external carrier name emitted outbound; null falls back to the global mapping.

`CustomCarrierMapping.externalCarrierServiceCode` ● `String` scalar common

Optional external service code emitted outbound; null falls back to the global mapping.

`CustomCarrierMapping.externalCarrierServiceName` ● `String` scalar common

Optional external service name; null when the mapping keys only on code or carrier.

`CustomCarrierMapping.id` ● `ID!` non-null scalar common

`CustomCarrierMapping.integrationId` ● `ID!` non-null scalar common

`CustomCarrierMapping.integrationName` ● `String!` non-null scalar common

`CustomCarrierMapping.internalCarrierServiceId` ● `ID!` non-null scalar common

`CustomCarrierMapping.internalCarrierServiceName` ● `String!` non-null scalar common

`CustomCarrierMapping.outboundDefault` ● `Boolean!` non-null scalar common

Whether this mapping is the default external service emitted outbound for its internal carrier service.

`CustomCarrierMapping.updatedAt` ● `ISO8601DateTime!` non-null scalar common

Returned By

customCarrierMappings query

Fields
Returned By