POST

Query Loyalty Imports


Retrieves a list of loyalty imports, given the provided paging, filtering, and sorting.

To learn about working with query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Loyalty
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports/query

Body Params
queryQueryRequired

Filter object. See API Query Language for more information.

For a detailed list of supported filters, see Supported Filters.

Response Object
loyaltyImportsArray <LoyaltyImport>

List of loyalty imports matching the query.


pagingMetadataPagingMetadata

Paging metadata.

Query Loyalty imports
Request
cURL
curl -X POST \ 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports/query' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \ -d '{ "query": {} }'
Response
JSON
{ "loyaltyImports": [ { "id": "5cc0b472-e488-4de3-92ba-bd718a44933a", "asyncImportJobId": "a9ff8502-cb2d-43dc-a7b3-981c8163f302", "revision": "6", "createdDate": "2024-09-17T10:58:00.100Z", "updatedDate": "2024-09-17T11:05:12.714Z", "status": "IMPORTED", "fileMetadata": { "size": 20915, "name": "data-8NkK3PqxWwQlOBzFF3izU.csv", "url": "/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv", "header": { "values": ["name", "surname", "email", "points"] }, "headerMappingInfo": { "headerMappings": [ { "columnName": "EMAIL", "columnIndex": 2 }, { "columnName": "POINTS", "columnIndex": 3 } ] }, "sampleDataRows": [ { "values": ["Ray", "Alvarado", "aray6720@example.com", "15"] }, { "values": ["Charde", "Clemons", "c.clemons5125@example.com", "15"] }, { "values": ["Jade", "Matthews", "mjade1457@example.com", "15"] }, { "values": ["Xander", "Lucas", "lucas-xander665@example.com", "15"] }, { "values": [ "Thaddeus", "Molina", "molina-thaddeus@example.com", "15" ] } ] }, "parseResult": { "parsedRowCount": 500 }, "importResult": { "errorFileExists": false, "successCount": 500, "failureCount": 0 } } ], "pagingMetadata": { "count": 1, "cursors": {}, "hasNext": false } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?