---
title: "Get Locations"
method: POST
path: "/getLocations"
tags: ["Location Management"]
---

# Get Locations

`POST /getLocations`

Use the Get Locations endpoint to retrieve a list of locations according to the search criteria. You can search by location ID, location name, and location street address. You can use a partial match for location name and location street address.

## Response `default`

- object
  - `status_code` integer, nullable, required — The response status code. May return a string for some statuses.
  - `status` string, nullable, required — The condition of a process or response
  - `processing_time` number, float, nullable, required — The time elapsed in processing the transaction
  - `echo` object, nullable, required — A structure that contains transaction ID information
    - `transaction_id` string, nullable, required — An ID that represents an API transaction
    - `provider_timestamp` string, date-time, nullable, required — Store a related timestamp for reporting and troubleshooting purposes
    - `provider_transaction_id` string, nullable, required — Secondary transaction identifier (generated by a provider)
  - `system_timestamp` string, date-time, nullable, required — A system generated timestamp
  - `rtoken` string, nullable, required — A system-generated ID used for tracking
  - `errors` string[] — A list of errors generated while the request was processed
  - `response_data` object, nullable, required — A structure for the response data. It can be empty but usually will contain information.
    - `locations` object[], required — List of locations
      - `location_id` integer, required — The numerical value assigned to the location
      - `name` string, nullable, required — The name of the location
      - `address1` string, nullable, required — Address 1 of the location
      - `address2` string, nullable, required — Address 2 of the location
      - `city` string, nullable, required — City of the location
      - `state` string, nullable, required — State of the location
      - `postalCode` string, nullable, required — Postal code of the location
      - `parent_location_id` string, nullable, required — The numerical ID of the parent location
      - `provider_specified_id` string, nullable, required — The partner or program identity for a location
      - `centralBillFlag` integer — Indicates a central corporate credit aggregate billing location. Allows one centralized billing location for all invoice records attached to the location.
      - `creditLimit` number, float — The credit limit for this location
      - `store_type` string, nullable, required — The store or location type. Values are `Corporate`, `Chain`, `Reseller`, `Region`, or `Store`.
      - `status` string, nullable, required — Current status of the location. Values are `Closed`, `Active`, `Suspended`, or `New`.
      - `fees` object[] — List of fees attached to the location
        - `active` string, nullable — Y/N field, determines if the fee is active
        - `amount` number, float, nullable — Amount of fee
        - `amount_type` string, nullable — Type of amount: flat or percent
        - `max_fee` number, float, nullable — Maximum amount of fee
        - `fee_type` string, nullable — Type of fee, current support FBD and DEL
        - `min_fee` number, float, nullable — Minimum amount of the fee

---

[API](https://skmtc.net/galileo-ft/apis/program-api.md) · [All operations](https://skmtc.net/galileo-ft/apis/program-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/galileo-ft/program-api/revisions/bcd728f97a18/schema)