Location
An auto-generated type for paginating through multiple Locations.
Anchor to Fields with this connectionFields with this connection
- : deprecated
- Anchor to DeliveryCarrierCalculatedOptionDefinition.includedLocationsDelivery•OBJECT
Carrier Calculated Option Definition.includedLocations A shipping option with rates calculated by a carrier service.
Carrier-calculated options fetch real-time rates from carriers(e.g., UPS, FedEx) at checkout instead of using merchant-defined fixed prices.
- Anchor to DeliveryFlatRateOptionDefinition.includedLocationsDelivery•OBJECT
Flat Rate Option Definition.includedLocations A shipping option with fixed-price rates.
Flat rate options charge the same price regardless of cart value or weight.
- •OBJECT
A location group is a collection of locations. They share zones and delivery methods across delivery profiles.
- •INTERFACE
A shipping option shown to buyers at checkout. Implemented by concrete option types.
- •OBJECT
A shipping profile that defines shipping rates for specific
Productobjects andobjects. Delivery profiles determine which products can ship from whichLocationobjects to which zones, and at what rates.Profiles can associate with
objects to provide custom shipping rules for subscriptions, such as free shipping or restricted delivery zones. The default profile applies to all products that aren't assigned to other profiles.Learn more about building delivery profiles.
- •OBJECT
Conditions that limit a rate group to specific collections or origin locations.
When conditions are set, the rate group applies only to matching shipments.
- Anchor to DeliveryValueBasedOptionDefinition.includedLocationsDelivery•OBJECT
Value Based Option Definition.includedLocations A shipping option with rates based on cart value.
Value-based options charge different rates depending on cart value, using tiers that define price thresholds (e.g., "$5 shipping under $50, $2 shipping over $50").
- Anchor to DeliveryWeightBasedOptionDefinition.includedLocationsDelivery•OBJECT
Weight Based Option Definition.includedLocations A shipping option with rates based on package weight.
Rates contain tiers that define package-weight thresholds. Checkout selects the appropriate tier using the package weight of the shipping allocation, or the combined package weight when allocations are grouped for weight conditions.
- •OBJECT
A condition checking the location that the visitor is shopping from.
- •OBJECTDeprecated
Anchor to Queries with this connectionQueries with this connection
- locations (LocationConnection!)
- locationsAvailableForDeliveryProfilesConnection (LocationConnection!)
- •query
A paginated list of inventory locations where merchants can stock
Productitems and fulfillOrderitems.Returns only active locations by default. Use the
argument to retrieve deactivated locations that can no longer stock inventory or fulfill orders. Use theargument to include locations thatapps manage. Use thequeryargument to filter by location attributes like name, address, and whether local pickup is enabled.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to includeInactiveinclude•Boolean
Inactive Default:false Whether to include the locations that are deactivated.
- Anchor to includeLegacyinclude•Boolean
Legacy Default:false Whether to include the legacy locations of fulfillment services.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
- Anchor to default•string
Filter by a case-insensitive search of multiple fields in a document.
query=Bob Normanquery=title:green hoodie- Anchor to active•string
- Anchor to address1•string
- Anchor to address2•string
- Anchor to city•string
- Anchor to country•string
- Anchor to created_at•time
- Anchor to geolocated•boolean
- Anchor to legacy•boolean
- Anchor to location_id•id
- Anchor to name•string
- Anchor to pickup_in_store•string
enableddisabled- Anchor to province•string
- Anchor to zip•string
Example:
Valid values:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Location
Key Sort Keys Default:NAME Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Arguments
- Anchor to locationsAvailableForDeliveryProfilesConnectionlocations•query
Available For Delivery Profiles Connection Returns a list of all origin locations available for a delivery profile.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
Anchor to Possible returnsPossible returns
- edges ([LocationEdge!]!)
- nodes ([Location!]!)
- pageInfo (PageInfo!)
- Anchor to edgesedges•[Location
Edge!]! non-null The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
- Anchor to nodesnodes•[Location!]!non-null
A list of nodes that are contained in LocationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
- Anchor to pageInfopage•Page
Info Info! non-null An object that’s used to retrieve cursor information about the current page.