MageSmith
QueryInventoryInStorePickup · Magento 2.4.9

pickupLocations

pickupLocations is a Magento 2 GraphQL query in the InventoryInStorePickup module. The pickup locations query searches for locations that match the search request requirements. It returns PickupLocations and is callable anonymously.

Last verified: against Magento 2.4.9.

Returns

PickupLocations

Resolver class

Magento\InventoryInStorePickupGraphQl\Model\Resolver\PickupLocations

Cache

identity: Magento\InventoryInStorePickupGraphQl\Model\Resolver\PickupLocations\Identity

Arguments

area AreaInput

Perform search by location using radius and search term.

filters PickupLocationFilterInput

Apply filters by attributes.

sort PickupLocationSortInput

Specifies which attribute to sort on, and whether to return the results in ascending or descending order.

pageSize Int default: 20

The maximum number of pickup locations to return at once. The attribute is optional.

currentPage Int default: 1

Specifies which page of results to return. The default value is 1.

productsInfo [ProductInfoInput]

Information about products which should be delivered.

Example request

Auto-generated from the SDL — paste-ready against your store's /graphql endpoint. Replace the host, store code, and any required values before running.

Headers

Content-Type
application/json
Store
default store view code; use 'default' for the single-store baseline

Query

query {
  pickupLocations {
    items {
      pickup_location_code
      name
      email
      fax
      contact_name
      description
      latitude
      longitude
      country_id
      region_id
      region
      city
      street
      postcode
      phone
    }
    page_info {
      page_size
      current_page
      total_pages
    }
    total_count
  }
}

Variables

{}

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.

Open app →