dashboard_get_location_list

Get Locations List

​

Returns a list of locations and their details. The page and per request parameters determine the page(s) returned and the number of locations returned per page.

Query Parameters
  • page
    Type: integer

    Page number. If this parameter is not provided with the request, the default is to return all. If page is specified, only that page will be returned using the value of per as the number of locations returned on that page.

  • per
    Type: integer

    Number of locations per page. If per is not specified, the default is 25.

Headers
  • Authorization
    Type: string
    required

    Bearer token for admin authorization, who is making a call on behalf of the customer. Send the API key in the following format: "Authorization: Bearer BUSINESS_ADMIN_KEY_GOES_HERE".

Responses
  • 200
    Type: object

    Returns details about each configured location of a business

    • additional_url
      Type: array object[]
    • address
      Type: string

      Full address of a particular business location

    • alternate_store_number
      Type: string

      Alphanumeric alternate store identifier for a specific location, as provided by the business. Punchh does not validate that they are unique across each location. This information is added to the Punchh platform under Store Locations > All Store Locations > [choose location] > Location > Alternate Store Number/Identifier.

    • brand
      Type: string

      Brand name of a subcategory of a business. A parent business may own multiple brands under one umbrella company. For example, Yum! Brands, Inc. owns KFC, Pizza Hut, and Taco Bell.

    • checkin_evidenced_by
      Type: string

      The method of check-in used by a user (e.g., barcode, qr_code, receipt_image, etc.). A blank string indicates the default value of the business.

    • city
      Type: string

      City of a particular business location

    • country
      Type: string

      Country of a particular business location

    • enable_pos_monitoring
      Type: boolean

      Whether POS monitoring has been enabled for the location or not. This is used by the POS integration team members.

    • enable_weekly_redemption_report
      Type: boolean

      Enables sharing the weekly redemption report to the location email (applicable only for the franchisee model)

    • external_store_id
      Type: string

      External POS identifier configured in the Punchh platform under location attributes via Store Locations > All Store Locations > [choose location] > POS > External POS Store Identifier

    • franchisee_id
      Type: integer

      Unique ID of the franchisee who owns the location. This ID is generated by Punchh.

    • generate_barcodes
      Type: boolean

      Whether barcodes are generated on the receipt or not

    • guest_identity_code_type
      Type: string

      The POS scanner type used to identify the user at the POS (e.g., barcode, qr_code, etc.). A blank string indicates the default value of the business.

    • latitude
      Type: numberFormat: float

      Latitude coordinate of a particular business location

    • loc_email
      Type: string

      Email address of a particular business location

    • location_groups
      Type: array object[]

      Contains the ID and name of all location groups to which a location belongs. A location in business can belong to multiple location groups.

    • location_id
      Type: integer

      Unique ID of a particular business location. This is generated by Punchh.

    • longitude
      Type: numberFormat: float

      Longitude coordinate of a particular business location

    • multiple_redemption_on_location
      Type: boolean

      Indicates whether processing of multiple redemptions is enabled for the location. A value of true means multiple redemptions are allowed.

    • name
      Type: string

      Name of a particular business location

    • online_order_url
      Type: string

      Online ordering URL of a particular business location

    • phone_number
      Type: string

      Phone number of a particular business location

    • post_code
      Type: string

      Zip code of a particular business location

    • state
      Type: string

      State where a particular business is located

    • status
      Type: string

      Whether the location is enabled for check-ins or not. approved means enabled for check-ins, and disapproved means disabled for check-ins.

    • store_number
      Type: string

      Unique store number of a particular location, as provided by the business

    • store_tags
      Type: string

      Tags that provide additional details about a particular business location

    • store_times
      Type: array object[]

      Business hours of a particular location

    • time_zone
      Type: string

      Time zone in which the business is located

    • updated_at
      Type: string

      Date/time when the location was last updated in system, in ISO 8601 format

  • 400
    Type: object
    • errors
      Type: object
  • 401
    Type: object
    • error
      Type: string
get/api2/dashboard/locations
No Body