Customers

Bulk create customers

Bulk creates multiple customers in a single request. Returns per-item results with success/error status for each item.

post/v1/customers

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/customers
  • Auth: API key in header x-api-key

Request body

Response

Bulk operation 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",
        "email": "customer@example.com",
        "firstName": "John",
        "lastName": "Doe",
        "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2",
        "externalId": "o1p2q3r4s5t6u7v8w9x0y1z2",
        "source": "woo-commerce",
        "phone": "+1234567890",
        "totalSpent": 100050,
        "lastAction": "2025-12-07T19:31:48.436+00:00",
        "tags": [
          "vip",
          "loyal",
          "premium"
        ],
        "metadata": [
          {
            "key": "key1",
            "value": "value1"
          },
          {
            "key": "key2",
            "value": "value2"
          }
        ],
        "notes": [
          {
            "message": "Note 1"
          }
        ]
      }
    }
  ]
}

Changes

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