Bulk update outlets

Updates multiple outlets in a single request. Each item must include an id and the fields to update. Returns per-item results.

patch/v1/outlets

Request

Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
URL: https://api.finalpos.com/v1/outlets
Auth: API key in header x-api-key

Request body

Response

Bulk update completed. Each item in the results array indicates success or failure.

Example response

{
  "summary": {
    "total": 10,
    "succeeded": 8,
    "failed": 2
  },
  "results": [
    {
      "data": {
        "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
        "createdAt": "2025-12-07T19:31:48.436+00:00",
        "updatedAt": "2025-12-07T19:35:48.436+00:00",
        "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
        "name": "Main Store",
        "address": "26 Federal Plaza, New York, NY 10278, USA",
        "city": "New York",
        "state": "NY",
        "country": "US",
        "postCode": "10278",
        "phone": "+12323232323",
        "address2": "Suite 100",
        "alias": "HQ",
        "timeZone": "America/St_Johns",
        "sequenceNumber": 45,
        "stations": [
          "o1p2q3r4s5t6u7v8w9x0y1z2"
        ],
        "stripeAccountId": "o1p2q3r4s5t6u7v8w9x0y1z2",
        "stripe": {
          "locationId": "tml_XXXXXXXXXX"
        },
        "externalId": "L1234567890",
        "source": "square",
        "taxId": "23"
      }
    }
  ]
}

Changes

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