Skip to main content

carriers

Get the list of carriers for a brand. This query returns a list of carriers that are either global or belong to a specific brand. The brand can be specified by the brand_id argument. If brand_id is not provided, the brand will be determined by the X-Brand-Id header.

Arguments​

NameTypeDescription
brand_idIDThe 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:

  • NotFoundError: If the provided brand_id is not a valid brand ID.

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 brand. 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 scalar​

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​

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

Type​

Carrier object​

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