Skip to main content

Facility

Facility objects represent unique facilities that have Kargo towers installed. They are generated during configuration with a new facility.

type Facility {
  slug: String!
  name: String
  address: Address
  shipments(
    filter: ShipmentFilter
  ): [Shipment!]! @deprecated
  shipment(
    id: Int!
  ): Shipment!
  SKUs: [SKU!]!
  SKU(
    id: String!
  ): SKU
  docks: [Dock!]!
  orders(
    filter: OrdersFilter!
  ): [Order!]!
}

Fields​

Facility.slug ● String! non-null scalar​

Short name for this facility (ex. 'sf')

Facility.name ● String scalar​

Display name (ex. 'San Francisco') for Facility object.

Facility.address ● Address object​

Street address for the associated Facility.

Facility.shipment ● Shipment! non-null object​

Single Shipment object requested by Shipment Kargo-ID.

Facility.shipment.id ● Int! non-null scalar​

Facility.SKUs ● [SKU!]! non-null object​

List of SKUs associated with this facility

Facility.SKU ● SKU object​

Fetch a SKU by its ID

Facility.SKU.id ● String! non-null scalar​

Facility.docks ● [Dock!]! non-null object​

List of Docks associated with this Facility.

Facility.orders ● [Order!]! non-null object​

List of Order objects for this Facility matching a specific filter (date range, direction).

Facility.orders.filter ● OrdersFilter! non-null input​
Show deprecated

Member Of​

Business object ● Order object ● Shipment object