Location

A physical site where goods are held, sold or fulfilled. A location groups one or more warehouses, and every fulfillment order is fulfilled from exactly one location.

type Location implements Node {
  id: ID!
  active: Boolean!
  addressId: ID
  code: String!
  createdAt: DateTime!
  defaultReceivingWarehouseId: ID
  defaultWarehouseId: ID
  name: String!
  updatedAt: DateTime
  defaultReceivingWarehouse: Warehouse
  defaultWarehouse: Warehouse
  sourcedFulfillmentOrders(
    first: Int = 10
    after: String
    filter: FulfillmentOrderFilterInput
  ): FulfillmentOrderConnection
  warehouses(
    first: Int = 10
    after: String
    filter: WarehouseFilterInput
  ): WarehouseConnection
}

Fields

Location.id ● ID! non-null scalar

Global identifier for this entity.

Location.active ● Boolean! non-null scalar

False when the merchant has deactivated the location.

Location.addressId ● ID scalar

ID of the address of the location.

Location.code ● String! non-null scalar

Short, human-readable location code. Unique across the shop.

Location.createdAt ● DateTime! non-null scalar

Timestamp the location was created.

Location.defaultReceivingWarehouseId ● ID scalar

ID of the warehouse of the location that goods receipts are booked into when no warehouse is chosen explicitly.

Location.defaultWarehouseId ● ID scalar

ID of the warehouse of the location that is used when no warehouse is chosen explicitly, e.g. for shipping and for restocking cancelled fulfillments.

Location.name ● String! non-null scalar

Display name of the location.

Location.updatedAt ● DateTime scalar

Timestamp the location was last changed.

Location.defaultReceivingWarehouse ● Warehouse object

Location.defaultWarehouse ● Warehouse object

Location.sourcedFulfillmentOrders ● FulfillmentOrderConnection object

Location.sourcedFulfillmentOrders.first ● Int scalar

Location.sourcedFulfillmentOrders.after ● String scalar

Location.sourcedFulfillmentOrders.filter ● FulfillmentOrderFilterInput input

Location.warehouses ● WarehouseConnection object

Location.warehouses.first ● Int scalar

Location.warehouses.after ● String scalar

Location.warehouses.filter ● WarehouseFilterInput input

Interfaces

Node interface

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By

location query

Member Of

FulfillmentOrder object ● LocationEdge object ● Warehouse object