Skip to main content

RegisterCarrierInput

Autogenerated input type of RegisterCarrier

input RegisterCarrierInput {
  brandId: ID @deprecated
  category: CarrierCategoryEnum
  clientMutationId: String
  code: String
  companyId: ID
  description: String
  name: String!
  status: StatusEnum
}

Fields​

RegisterCarrierInput.brandId ● ID deprecated scalar common​

DEPRECATED

This argument will be removed in the future. Brand is becoming a product-only attribute. Use companyId instead.

The brand ID to which the carrier will be associated. If not provided, the carrier will be added globally. The party should have the permission 'register_carriers' to perform this operation.

RegisterCarrierInput.category ● CarrierCategoryEnum enum shipments​

RegisterCarrierInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

RegisterCarrierInput.code ● String scalar common​

The internal code of the carrier. This argument is optional, and if not provided, the system will generate a unique code for the carrier.

The code should be unique in the context of the carrier. If an existing code is provided, the system will ignore it and generate a new one.

RegisterCarrierInput.companyId ● ID scalar common​

The company ID to which the carrier will be associated. If not provided, the carrier will be added globally. The party should have access to this company and have the permission register_carriers to perform this operation.

RegisterCarrierInput.description ● String scalar common​

Carrier description. A brief description of the carrier, including the type of services it provides and any other relevant information.

The name should be unique in the context of the carrier.

RegisterCarrierInput.name ● String! non-null scalar common​

Carrier name. Consider using the carrier's official name to prevent confusion and ensure consistency.

The name should be unique in the context of the carrier.

RegisterCarrierInput.status ● StatusEnum enum common​

Member Of​

registerCarrier mutation