locations | BigCommerce Developer Center

query ExampleQuery($entityIds: [Int], $codes: [String], $typeIds: [String], $serviceTypeIds: [String], $distanceFilter: DistanceFilter, $countryCodes: [countryCode], $states: [String], $cities: [String], $before: String, $after: String, $first: Int, $last: Int) {
  locations(entityIds: $entityIds, codes: $codes, typeIds: $typeIds, serviceTypeIds: $serviceTypeIds, distanceFilter: $distanceFilter, countryCodes: $countryCodes, states: $states, cities: $cities, before: $before, after: $after, first: $first, last: $last) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node
      cursor
    }
  }
}

{
  "entityIds": [],
  "codes": [],
  "typeIds": [],
  "serviceTypeIds": [],
  "distanceFilter": {
    "radius": 0,
    "longitude": 0,
    "latitude": 0,
    "lengthUnit": "Kilometres"
  },
  "countryCodes": [],
  "states": [],
  "cities": [],
  "before": "example",
  "after": "example",
  "first": 0,
  "last": 0
}

{
  "data": {
    "locations": {
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example",
        "endCursor": "example"
      },
      "edges": [
        {
          "node": {
            "entityId": null,
            "code": null,
            "label": null,
            "description": null,
            "typeId": null,
            "serviceTypeIds": null,
            "address": null,
            "operatingHours": null,
            "distance": null,
            "blackoutHours": null
          },
          "cursor": "example"
        }
      ]
    }
  }
}

Locations

Arguments

entityIdslist of IntegersOptional

Location ids filter

codeslist of StringsOptional

Location codes filter

typeIdslist of StringsOptional

Location type ids filter

serviceTypeIdslist of StringsOptional

Location service type ids filter

distanceFilterObjectOptional

Filter locations by the distance

countryCodeslist of EnumsOptional

Location country codes filter

stateslist of StringsOptional

Location states filter

citieslist of StringsOptional

Location cities filter

beforeStringOptional

afterStringOptional

firstIntegerOptional

lastIntegerOptional

Returns

an Object

pageInfoObject

Information to aid in pagination.

edgeslist of Objects

A list of edges.