v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
segment

aid_receipts_customer_segment_post

Segment customer by receipt data

scopes:

  • admin:receipts
  • read:receipts
post/accounts/{aid}/receipts/customer_segment

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

Request body

purchase_fromstring date-time
purchase_tostring date-time
store_idsstring[]

Response

Customer matching segmentation

Example response

{
  "customers": [
    {
      "purchases": 5
    }
  ]
}