PApaymongo
Locations

Update a location

Updates a location's name, review URL, or status. The slug is immutable.

patch/v1/locations/{location_slug}

Request

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

Path parameters

location_slugstring required

Location slug

Request body

namestring
order_number_mode'daily' | 'sequential'

Changing the mode affects only orders created afterwards; the number already stamped on an existing order never changes.

pass_on_feesboolean

PassOnFees charges the payer the processing fees on every checkout session of this location.

purchase_validation_enabledboolean

PurchaseValidationEnabled lets staff look up and claim paid orders from this location.

review_urlstring
statusstring
warehouse_idsstring[]

WarehouseIDs replaces the whole list of inventories-api warehouses the location sells from. An empty list stops stock tracking.

Example request

{
  "name": "BGC Flagship",
  "order_number_mode": "sequential",
  "pass_on_fees": true,
  "purchase_validation_enabled": true,
  "review_url": "https://g.page/r/bgc-branch/review",
  "status": "live",
  "warehouse_ids": [
    "ww_abc123"
  ]
}

Response

OK

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.