Locations

List locations

Lists the organization's catalog locations.

get/v1/locations

Request

Base URL
https://orders-api.paymongo.com
URL
https://orders-api.paymongo.com/v1/locations
Auth
HTTP basic

Query parameters

statusstring

Filter by location status

limitinteger

Maximum number of locations to return (1-100)

afterstring

Pagination cursor from a previous response

Response

has_moreboolean

Example response

{
  "data": [
    {
      "created_at": "2026-06-24 07:55:00+00:00",
      "id": "loc_abc123",
      "livemode": true,
      "location_slug": "bgc-branch",
      "name": "BGC Branch",
      "order_number_mode": "daily",
      "purchase_validation_enabled": true,
      "review_url": "https://g.page/r/bgc-branch/review",
      "status": "live",
      "updated_at": "2026-06-24 07:55:00+00:00",
      "warehouse_ids": [
        "ww_abc123"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.