CLcloudkitchens
manager_loyalty_endpoints

Search loyalty users

Rate limit: 8 requests per minute.

get/manager/loyalty/v1/{source}/user/search

Request

Path parameters

sourcestring required

Loyalty provider source

Example:css-loyalty

Query parameters

tokenstring

Opaque token used for paging. Query parameters must be URL encoded.

Example:CgwI09+kjQYQwOvF2AM=/(urlencoded:CgwI09%2BkjQYQwOvF2AM%3D)
limitstring required

Max number of items to retrieve (minimum 1, maximum is 10, anything smaller/larger than min/max resets to min/max)

termstring required

Used to search for users in the loyalty program. The search is case-sensitive and will match any part of the user's fields.

Example:john

Headers

X-Store-Idstring required

The unique identifier of the store in your app. This ID, along with the Application ID, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to onboarding:905bb725-b141-4a9b-832a-1f254f772c94 (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided internalStoreId (a.k.a. Sku-Sku ID).

Example:partner-store-unique-identifier

Response

Search users response.

offsetTokenstring

Opaque token used to fetch the following page. If not set, no more results are available.

Example response

{
  "users": [
    {
      "id": "somestring",
      "userFields": [
        {
          "key": "full_name",
          "value": "john doe"
        }
      ]
    }
  ],
  "offsetToken": "H12MAF2fFaFFFa"
}

Changes

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