Location

A Location is any place where an order can be fulfilled and/or collected by the customer. Locations can include a store, warehouse, drop ship vendor, lockers or a third party collection point such as ParcelPoint.

Implements

Connections

networks (NetworkConnection)

Networks the location is assigned to

Argument Type Description
createdOn DateRange
updatedOn DateRange
ref [String]

Reference to the network. This is the name of the network you passed in while creating the network. Recommended to be unique.

type [String]

The type of network

status [String]

Status of the network

first Int

Returns the first n elements from the list

last Int

Returns the last n elements from the list

before String

Returns the elements in the list that come before the specified global ID

after String

Returns the elements in the list that come after the specified global ID

storageAreas (StorageAreaConnection)

Storage areas at the location

Argument Type Description
createdOn DateRange
updatedOn DateRange
name [String]

Name

status [String]

Status

type [String]

Type

first Int

Returns the first n elements from the list

last Int

Returns the last n elements from the list

before String

Returns the elements in the list that come before the specified global ID

after String

Returns the elements in the list that come after the specified global ID

manifests (ManifestConnection)

Manifests for this location

Argument Type Description
ref [String!]

External reference for the Manifest. Must be unique.

name [String]

The name of the Manifest

type [String!]

The type of Manifest

status [String]

The status of the Manifest

workflowRef [String!]

The reference used for workflow identification

workflowVersion [Int!]

The version of the workflow

createdOn DateRange
updatedOn DateRange
carrierManifestLink [String]

The link where the carrier's manifest is stored. Not all the carriers generates one, so this field is optional.

first Int

Returns the first n elements from the list

last Int

Returns the last n elements from the list

before String

Returns the elements in the list that come before the specified global ID

after String

Returns the elements in the list that come after the specified global ID

Fields

id (ID!)

ID of the object

createdOn (DateTime)

Time of creation

updatedOn (DateTime)

Time of last update

ref (String)

The location (i.e. store) id provided by the retailer

type (String)

Type

status (String)

The location status. Possible values are 'ACTIVE', 'INACTIVE'.

attributes ([Attribute])

Attributes

name (String)

Name of location

supportPhoneNumber (String)

The location contact number

defaultCarrier (String)

Default carrier

defaultCarrierName (String)

Default carrier of the location

primaryAddress (Address)

Store location of the the location

retailer (Retailer)

Retailer

openingSchedule (OpeningSchedule)

Opening Schedule

workflowRef (String)
Deprecation notice

No longer supported

The reference used for workflow identification

workflowVersion (Int)
Deprecation notice

No longer supported

The version of the workflow