Skip to main content

carriers

Get the list of carriers for a company. This query returns a list of carriers that are either global or belong to a specific company. The company will be determined by the X-Company-Id header.

Arguments​

NameTypeDescription
brand_id (DEPRECATED)IDThe brand ID to filter the carriers by. If not
provided, will use the brand provided in the X-Brand-Id header.

Errors​

This query may return the following errors:

  • CompanyContextRequired: If company could not be found in context.

Return Value​

This query returns a list of CarrierType objects. Each CarrierType object represents a carrier that is either global or belongs to the specified company. The carriers are ordered by their name and only carriers with a status of 'ACTIVE' are returned.

carriers(
  brandId: ID
  status: StatusEnum
): [Carrier!]!

Arguments​

carriers.brandId ● ID deprecated scalar common​

DEPRECATED

This argument will be removed in the future. Brand is becoming a product-only attribute. Company context is used instead.

The brand ID to filter the carriers by. If not provided, will use the brand provided in the X-Brand-Id header.

carriers.status ● StatusEnum enum common​

The status of the carriers to filter by. If not provided, all carriers are returned.

Type​

Carrier object shipments​

This type represents a carrier. A carrier is a company that provides shipping services.