{"id":"f8534543-148e-4694-a946-7874218a1f8b","createdDate":"2024-09-19T12:37:15.019Z","updatedDate":"2024-09-19T12:37:15.019Z","resourceId":"badb14f9-b66a-42b5-83bb-9b3d8fec0301","api":{"schema":{"object":{"displayName":"Loyalty Import Object","description":"An Import object is a batch import of loyalty points for existing customers.\nYou can use Loyalty Imports to import loyalty points from 3rd-party providers or update existing customer point balances.\nThis object tracks the entire import process from file upload to data processing.","slug":"loyalty-import-object","$ref":"#/components/schemas/wix.loyalty.imports.v1.LoyaltyImport","legacyExamples":[{"title":"LoyaltyImport","content":"{\n \"loyaltyImport\": {\n \"id\": \"5cc0b472-e488-4de3-92ba-bd718a44933a\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-17T10:58:00.100Z\",\n \"updatedDate\": \"2024-09-17T10:58:00.100Z\",\n \"status\": \"INITIATED\",\n \"fileMetadata\": {\n \"size\": 20915,\n \"name\": \"data-8NkK3PqxWwQlOBzFF3izU.csv\",\n \"url\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"sampleDataRows\": []\n },\n \"parseResult\": {\n \"parsedRowCount\": 0\n },\n \"importResult\": {\n \"errorFileExists\": false\n }\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"methods":[{"summary":"Get Loyalty Import","description":"Retrieves a loyalty import.","operationId":"wix.loyalty.imports.v1.LoyaltyImports.GetLoyaltyImport","parameters":[{"name":"loyaltyImportId","in":"query","description":"Loyalty import ID.","required":true,"schema":{"description":"Loyalty import ID.","title":"loyaltyImportId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.loyalty.imports.v1.GetLoyaltyImportResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/_api/loyalty-imports","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/loyalty-imports","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.loyalty.imports.v1.LoyaltyImports","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_IMPORTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-imports","serviceArtifactId":"com.wixpress.loyalty.loyalty-imports","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.imports.v1.GetLoyaltyImportRequest","responseMessage":"wix.loyalty.imports.v1.GetLoyaltyImportResponse"},"legacyExamples":[{"name":"GetLoyaltyImport","type":"METHOD","order":2,"content":{"title":"Get Loyalty import (IMPORTED)","request":"curl -X GET \\\n 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports?loyaltyImportId=5cc0b472-e488-4de3-92ba-bd718a44933a' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{\n \"loyaltyImport\": {\n \"id\": \"5cc0b472-e488-4de3-92ba-bd718a44933a\",\n \"asyncImportJobId\": \"a9ff8502-cb2d-43dc-a7b3-981c8163f302\",\n \"revision\": \"6\",\n \"createdDate\": \"2024-09-17T10:58:00.100Z\",\n \"updatedDate\": \"2024-09-17T11:05:12.714Z\",\n \"status\": \"IMPORTED\",\n \"fileMetadata\": {\n \"size\": 20915,\n \"name\": \"data-8NkK3PqxWwQlOBzFF3izU.csv\",\n \"url\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"header\": {\n \"values\": [\n \"name\",\n \"surname\",\n \"email\",\n \"points\"\n ]\n },\n \"headerMappingInfo\": {\n \"headerMappings\": [\n {\n \"columnName\": \"EMAIL\",\n \"columnIndex\": 2\n },\n {\n \"columnName\": \"POINTS\",\n \"columnIndex\": 3\n }\n ]\n },\n \"sampleDataRows\": [\n {\n \"values\": [\n \"Ray\",\n \"Alvarado\",\n \"aray6720@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Charde\",\n \"Clemons\",\n \"c.clemons5125@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Jade\",\n \"Matthews\",\n \"mjade1457@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Xander\",\n \"Lucas\",\n \"lucas-xander665@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Thaddeus\",\n \"Molina\",\n \"molina-thaddeus@example.com\",\n \"15\"\n ]\n }\n ]\n },\n \"parseResult\": {\n \"parsedRowCount\": 500\n },\n \"importResult\": {\n \"errorFileExists\": false,\n \"successCount\": 500,\n \"failureCount\": 0\n }\n }\n}"}},{"name":"GetLoyaltyImport","type":"METHOD","order":1,"content":{"title":"Get Loyalty import (PARSED)","request":"curl -X GET \\\n 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports?loyaltyImportId=5cc0b472-e488-4de3-92ba-bd718a44933a' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{\n \"loyaltyImport\": {\n \"id\": \"5cc0b472-e488-4de3-92ba-bd718a44933a\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-09-17T10:58:00.100Z\",\n \"updatedDate\": \"2024-09-17T10:58:01.494Z\",\n \"status\": \"PARSED\",\n \"fileMetadata\": {\n \"size\": 20915,\n \"name\": \"data-8NkK3PqxWwQlOBzFF3izU.csv\",\n \"url\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"header\": {\n \"values\": [\n \"name\",\n \"surname\",\n \"email\",\n \"points\"\n ]\n },\n \"sampleDataRows\": [\n {\n \"values\": [\n \"Ray\",\n \"Alvarado\",\n \"aray6720@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Charde\",\n \"Clemons\",\n \"c.clemons5125@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Jade\",\n \"Matthews\",\n \"mjade1457@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Xander\",\n \"Lucas\",\n \"lucas-xander665@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Thaddeus\",\n \"Molina\",\n \"molina-thaddeus@example.com\",\n \"15\"\n ]\n }\n ]\n },\n \"parseResult\": {\n \"parsedRowCount\": 500\n },\n \"importResult\": {\n \"errorFileExists\": false\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/loyalty-imports","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.loyalty.imports.v1.LoyaltyImports","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_IMPORTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-imports","serviceArtifactId":"com.wixpress.loyalty.loyalty-imports","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.imports.v1.GetLoyaltyImportRequest","responseMessage":"wix.loyalty.imports.v1.GetLoyaltyImportResponse"},"legacyExamples":[{"name":"GetLoyaltyImport","type":"METHOD","order":2,"content":{"title":"Get Loyalty import (IMPORTED)","request":"curl -X GET \\\n 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports?loyaltyImportId=5cc0b472-e488-4de3-92ba-bd718a44933a' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{\n \"loyaltyImport\": {\n \"id\": \"5cc0b472-e488-4de3-92ba-bd718a44933a\",\n \"asyncImportJobId\": \"a9ff8502-cb2d-43dc-a7b3-981c8163f302\",\n \"revision\": \"6\",\n \"createdDate\": \"2024-09-17T10:58:00.100Z\",\n \"updatedDate\": \"2024-09-17T11:05:12.714Z\",\n \"status\": \"IMPORTED\",\n \"fileMetadata\": {\n \"size\": 20915,\n \"name\": \"data-8NkK3PqxWwQlOBzFF3izU.csv\",\n \"url\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"header\": {\n \"values\": [\n \"name\",\n \"surname\",\n \"email\",\n \"points\"\n ]\n },\n \"headerMappingInfo\": {\n \"headerMappings\": [\n {\n \"columnName\": \"EMAIL\",\n \"columnIndex\": 2\n },\n {\n \"columnName\": \"POINTS\",\n \"columnIndex\": 3\n }\n ]\n },\n \"sampleDataRows\": [\n {\n \"values\": [\n \"Ray\",\n \"Alvarado\",\n \"aray6720@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Charde\",\n \"Clemons\",\n \"c.clemons5125@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Jade\",\n \"Matthews\",\n \"mjade1457@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Xander\",\n \"Lucas\",\n \"lucas-xander665@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Thaddeus\",\n \"Molina\",\n \"molina-thaddeus@example.com\",\n \"15\"\n ]\n }\n ]\n },\n \"parseResult\": {\n \"parsedRowCount\": 500\n },\n \"importResult\": {\n \"errorFileExists\": false,\n \"successCount\": 500,\n \"failureCount\": 0\n }\n }\n}"}},{"name":"GetLoyaltyImport","type":"METHOD","order":1,"content":{"title":"Get Loyalty import (PARSED)","request":"curl -X GET \\\n 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports?loyaltyImportId=5cc0b472-e488-4de3-92ba-bd718a44933a' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{\n \"loyaltyImport\": {\n \"id\": \"5cc0b472-e488-4de3-92ba-bd718a44933a\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-09-17T10:58:00.100Z\",\n \"updatedDate\": \"2024-09-17T10:58:01.494Z\",\n \"status\": \"PARSED\",\n \"fileMetadata\": {\n \"size\": 20915,\n \"name\": \"data-8NkK3PqxWwQlOBzFF3izU.csv\",\n \"url\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"header\": {\n \"values\": [\n \"name\",\n \"surname\",\n \"email\",\n \"points\"\n ]\n },\n \"sampleDataRows\": [\n {\n \"values\": [\n \"Ray\",\n \"Alvarado\",\n \"aray6720@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Charde\",\n \"Clemons\",\n \"c.clemons5125@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Jade\",\n \"Matthews\",\n \"mjade1457@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Xander\",\n \"Lucas\",\n \"lucas-xander665@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Thaddeus\",\n \"Molina\",\n \"molina-thaddeus@example.com\",\n \"15\"\n ]\n }\n ]\n },\n \"parseResult\": {\n \"parsedRowCount\": 500\n },\n \"importResult\": {\n \"errorFileExists\": false\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Loyalty Import","slugifiedName":"get-loyalty-import"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Create Loyalty Import","description":"Creates an import object based on an uploaded file.\n\nCall this method after uploading your file to the URL obtained from [Create Loyalty Import File Url](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/imports/create-loyalty-import-file-url).","operationId":"wix.loyalty.imports.v1.LoyaltyImports.CreateLoyaltyImport","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.loyalty.imports.v1.CreateLoyaltyImportResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/_api/loyalty-imports","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/loyalty-imports","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateLoyaltyImportRequest","description":"","properties":{"fileUrl":{"description":"URL of the file to import.","title":"fileUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileName":{"description":"Name of the file to import.","title":"fileName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileSize":{"description":"Size of the file to import, in bytes.","title":"fileSize","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["fileUrl"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Loyalty Import Created","description":"Triggered when a loyalty import is created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.imports.v1.loyalty_import","serviceName":"wix.loyalty.imports.v1.LoyaltyImports","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.imports.v1.loyalty_import_created","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"wix.loyalty.imports.v1.LoyaltyImports","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_IMPORTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-imports","serviceArtifactId":"com.wixpress.loyalty.loyalty-imports","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.imports.v1.CreateLoyaltyImportRequest","responseMessage":"wix.loyalty.imports.v1.CreateLoyaltyImportResponse"},"legacyExamples":[{"name":"CreateLoyaltyImport","type":"METHOD","content":{"title":"Create Loyalty import","request":"curl -X POST \\\n 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"fileUrl\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"fileName\": \"data-8NkK3PqxWwQlOBzFF3izU.csv\",\n \"fileSize\": 20915\n }'","response":"{\n \"loyaltyImport\": {\n \"id\": \"5cc0b472-e488-4de3-92ba-bd718a44933a\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-17T10:58:00.100Z\",\n \"updatedDate\": \"2024-09-17T10:58:00.100Z\",\n \"status\": \"INITIATED\",\n \"fileMetadata\": {\n \"size\": 20915,\n \"name\": \"data-8NkK3PqxWwQlOBzFF3izU.csv\",\n \"url\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"sampleDataRows\": []\n },\n \"parseResult\": {\n \"parsedRowCount\": 0\n },\n \"importResult\": {\n \"errorFileExists\": false\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/loyalty-imports","rpcOnly":false,"triggeredEvents":[{"title":"Loyalty Import Created","description":"Triggered when a loyalty import is created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.imports.v1.loyalty_import","serviceName":"wix.loyalty.imports.v1.LoyaltyImports","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.imports.v1.loyalty_import_created","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"wix.loyalty.imports.v1.LoyaltyImports","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_IMPORTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-imports","serviceArtifactId":"com.wixpress.loyalty.loyalty-imports","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.imports.v1.CreateLoyaltyImportRequest","responseMessage":"wix.loyalty.imports.v1.CreateLoyaltyImportResponse"},"legacyExamples":[{"name":"CreateLoyaltyImport","type":"METHOD","content":{"title":"Create Loyalty import","request":"curl -X POST \\\n 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"fileUrl\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"fileName\": \"data-8NkK3PqxWwQlOBzFF3izU.csv\",\n \"fileSize\": 20915\n }'","response":"{\n \"loyaltyImport\": {\n \"id\": \"5cc0b472-e488-4de3-92ba-bd718a44933a\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-17T10:58:00.100Z\",\n \"updatedDate\": \"2024-09-17T10:58:00.100Z\",\n \"status\": \"INITIATED\",\n \"fileMetadata\": {\n \"size\": 20915,\n \"name\": \"data-8NkK3PqxWwQlOBzFF3izU.csv\",\n \"url\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"sampleDataRows\": []\n },\n \"parseResult\": {\n \"parsedRowCount\": 0\n },\n \"importResult\": {\n \"errorFileExists\": false\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Create Loyalty Import","slugifiedName":"create-loyalty-import"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Get Error File Download Url","description":"Retrieves the download URL for the error file of a failed loyalty import.\n\nIf an import fails, the `importResult.errorFileExists` field in the `LoyaltyImport` object is set to `true`.\n\nUse this method to get the URL of the error file, which contains details about which items couldn't be imported and why.","operationId":"wix.loyalty.imports.v1.LoyaltyImports.GetErrorFileDownloadUrl","parameters":[{"name":"loyaltyImportId","in":"query","description":"Loyalty import ID.","required":true,"schema":{"description":"Loyalty import ID.","title":"loyaltyImportId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.loyalty.imports.v1.GetErrorFileDownloadUrlResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/_api/loyalty-imports","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/loyalty-imports","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.loyalty.imports.v1.LoyaltyImports","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_IMPORTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-imports","serviceArtifactId":"com.wixpress.loyalty.loyalty-imports","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.imports.v1.GetErrorFileDownloadUrlRequest","responseMessage":"wix.loyalty.imports.v1.GetErrorFileDownloadUrlResponse"},"legacyExamples":[{"name":"GetErrorFileDownloadUrl","type":"METHOD","content":{"title":"Get error file download URL","request":"curl -X GET \\\n 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports/error-file-download-url?loyaltyImportId=bfc3f48e-4982-4977-a7a3-52bab9078a2d' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{\n \"url\": \"https://wixmp-36bf13e0f0298791da8f320a.wixmp.com/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/f8278cb9-c014-422c-b5a9-ab0a9d7a5e14_errors.csv?token=example_x7zsjcXaTSa3ws1NcXTjk92m639yOkdUBa8DbuDZGoY&filename=import_errors_summary.csv\"\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/loyalty-imports/error-file-download-url","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.loyalty.imports.v1.LoyaltyImports","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_IMPORTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-imports","serviceArtifactId":"com.wixpress.loyalty.loyalty-imports","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.imports.v1.GetErrorFileDownloadUrlRequest","responseMessage":"wix.loyalty.imports.v1.GetErrorFileDownloadUrlResponse"},"legacyExamples":[{"name":"GetErrorFileDownloadUrl","type":"METHOD","content":{"title":"Get error file download URL","request":"curl -X GET \\\n 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports/error-file-download-url?loyaltyImportId=bfc3f48e-4982-4977-a7a3-52bab9078a2d' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{\n \"url\": \"https://wixmp-36bf13e0f0298791da8f320a.wixmp.com/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/f8278cb9-c014-422c-b5a9-ab0a9d7a5e14_errors.csv?token=example_x7zsjcXaTSa3ws1NcXTjk92m639yOkdUBa8DbuDZGoY&filename=import_errors_summary.csv\"\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Error File Download Url","slugifiedName":"get-error-file-download-url"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Execute Loyalty Import","description":"Starts the actual import process for a loyalty import.\n\nCall this method after the loyalty import object reaches the `PARSED` status.","operationId":"wix.loyalty.imports.v1.LoyaltyImports.ExecuteLoyaltyImport","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.loyalty.imports.v1.ExecuteLoyaltyImportResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/_api/loyalty-imports","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/loyalty-imports","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ExecuteLoyaltyImportRequest","description":"","properties":{"loyaltyImportId":{"description":"Loyalty import ID.","title":"loyaltyImportId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headerMappingInfo":{"description":"Header mapping information for the import file.","$ref":"#/components/schemas/wix.loyalty.imports.v1.HeaderMappingInfo","summary":"headerMappingInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["loyaltyImportId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.loyalty.imports.v1.LoyaltyImports","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_IMPORTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-imports","serviceArtifactId":"com.wixpress.loyalty.loyalty-imports","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.imports.v1.ExecuteLoyaltyImportRequest","responseMessage":"wix.loyalty.imports.v1.ExecuteLoyaltyImportResponse"},"legacyExamples":[{"name":"ExecuteLoyaltyImport","type":"METHOD","content":{"title":"Execute Loyalty import","request":"curl -X POST \\\n 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports/execute' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"loyaltyImportId\": \"5cc0b472-e488-4de3-92ba-bd718a44933a\",\n \"headerMappingInfo\": {\n \"headerMappings\": [\n {\n \"columnName\": \"EMAIL\",\n \"columnIndex\": 2\n },\n {\n \"columnName\": \"POINTS\",\n \"columnIndex\": 3\n }\n ]\n }\n }'","response":"{\n \"loyaltyImport\": {\n \"id\": \"5cc0b472-e488-4de3-92ba-bd718a44933a\",\n \"asyncImportJobId\": \"a9ff8502-cb2d-43dc-a7b3-981c8163f302\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-09-17T10:58:00.100Z\",\n \"updatedDate\": \"2024-09-17T11:05:02.022Z\",\n \"status\": \"IMPORTING\",\n \"fileMetadata\": {\n \"size\": 20915,\n \"name\": \"data-8NkK3PqxWwQlOBzFF3izU.csv\",\n \"url\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"header\": {\n \"values\": [\n \"name\",\n \"surname\",\n \"email\",\n \"points\"\n ]\n },\n \"headerMappingInfo\": {\n \"headerMappings\": [\n {\n \"columnName\": \"EMAIL\",\n \"columnIndex\": 2\n },\n {\n \"columnName\": \"POINTS\",\n \"columnIndex\": 3\n }\n ]\n },\n \"sampleDataRows\": [\n {\n \"values\": [\n \"Ray\",\n \"Alvarado\",\n \"aray6720@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Charde\",\n \"Clemons\",\n \"c.clemons5125@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Jade\",\n \"Matthews\",\n \"mjade1457@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Xander\",\n \"Lucas\",\n \"lucas-xander665@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Thaddeus\",\n \"Molina\",\n \"molina-thaddeus@example.com\",\n \"15\"\n ]\n }\n ]\n },\n \"parseResult\": {\n \"parsedRowCount\": 500\n },\n \"importResult\": {\n \"errorFileExists\": false\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/loyalty-imports/execute","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.loyalty.imports.v1.LoyaltyImports","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_IMPORTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-imports","serviceArtifactId":"com.wixpress.loyalty.loyalty-imports","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.imports.v1.ExecuteLoyaltyImportRequest","responseMessage":"wix.loyalty.imports.v1.ExecuteLoyaltyImportResponse"},"legacyExamples":[{"name":"ExecuteLoyaltyImport","type":"METHOD","content":{"title":"Execute Loyalty import","request":"curl -X POST \\\n 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports/execute' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"loyaltyImportId\": \"5cc0b472-e488-4de3-92ba-bd718a44933a\",\n \"headerMappingInfo\": {\n \"headerMappings\": [\n {\n \"columnName\": \"EMAIL\",\n \"columnIndex\": 2\n },\n {\n \"columnName\": \"POINTS\",\n \"columnIndex\": 3\n }\n ]\n }\n }'","response":"{\n \"loyaltyImport\": {\n \"id\": \"5cc0b472-e488-4de3-92ba-bd718a44933a\",\n \"asyncImportJobId\": \"a9ff8502-cb2d-43dc-a7b3-981c8163f302\",\n \"revision\": \"4\",\n \"createdDate\": \"2024-09-17T10:58:00.100Z\",\n \"updatedDate\": \"2024-09-17T11:05:02.022Z\",\n \"status\": \"IMPORTING\",\n \"fileMetadata\": {\n \"size\": 20915,\n \"name\": \"data-8NkK3PqxWwQlOBzFF3izU.csv\",\n \"url\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"header\": {\n \"values\": [\n \"name\",\n \"surname\",\n \"email\",\n \"points\"\n ]\n },\n \"headerMappingInfo\": {\n \"headerMappings\": [\n {\n \"columnName\": \"EMAIL\",\n \"columnIndex\": 2\n },\n {\n \"columnName\": \"POINTS\",\n \"columnIndex\": 3\n }\n ]\n },\n \"sampleDataRows\": [\n {\n \"values\": [\n \"Ray\",\n \"Alvarado\",\n \"aray6720@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Charde\",\n \"Clemons\",\n \"c.clemons5125@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Jade\",\n \"Matthews\",\n \"mjade1457@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Xander\",\n \"Lucas\",\n \"lucas-xander665@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Thaddeus\",\n \"Molina\",\n \"molina-thaddeus@example.com\",\n \"15\"\n ]\n }\n ]\n },\n \"parseResult\": {\n \"parsedRowCount\": 500\n },\n \"importResult\": {\n \"errorFileExists\": false\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Execute Loyalty Import","slugifiedName":"execute-loyalty-import"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Create Loyalty Import File Url","description":"Creates a URL for uploading a loyalty import file.\n\nThis method is the first step in the loyalty import process. It returns a file path and an upload URL, which you'll use in subsequent steps of the import process.","operationId":"wix.loyalty.imports.v1.LoyaltyImports.CreateLoyaltyImportFileUrl","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.loyalty.imports.v1.CreateLoyaltyImportFileUrlResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/_api/loyalty-imports","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/loyalty-imports","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateLoyaltyImportFileUrlRequest","description":"","properties":{},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.loyalty.imports.v1.LoyaltyImports","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_IMPORTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-imports","serviceArtifactId":"com.wixpress.loyalty.loyalty-imports","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.imports.v1.CreateLoyaltyImportFileUrlRequest","responseMessage":"wix.loyalty.imports.v1.CreateLoyaltyImportFileUrlResponse"},"legacyExamples":[{"name":"CreateLoyaltyImportFileUrl","type":"METHOD","content":{"title":"Create Loyalty import file url","request":"curl -X POST \\\n 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports/wixmp-upload-url' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{}'","response":"{\n \"filePath\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"uploadUrl\": \"https://upload.wixmp.com/upload/example_eccI15IeIinubB3btjWY\"\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/loyalty-imports/wixmp-upload-url","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.loyalty.imports.v1.LoyaltyImports","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_IMPORTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-imports","serviceArtifactId":"com.wixpress.loyalty.loyalty-imports","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.imports.v1.CreateLoyaltyImportFileUrlRequest","responseMessage":"wix.loyalty.imports.v1.CreateLoyaltyImportFileUrlResponse"},"legacyExamples":[{"name":"CreateLoyaltyImportFileUrl","type":"METHOD","content":{"title":"Create Loyalty import file url","request":"curl -X POST \\\n 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports/wixmp-upload-url' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{}'","response":"{\n \"filePath\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"uploadUrl\": \"https://upload.wixmp.com/upload/example_eccI15IeIinubB3btjWY\"\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Create Loyalty Import File Url","slugifiedName":"create-loyalty-import-file-url"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Query Loyalty Imports","description":"Retrieves a list of loyalty imports, given the provided paging, filtering, and sorting.\n\nTo learn about working with query endpoints, see [API Query Language](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/api-query-language),\n[Sorting and Paging](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/pagination),\nand [Field Projection](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/field-projection).","operationId":"wix.loyalty.imports.v1.LoyaltyImports.QueryLoyaltyImports","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.loyalty.imports.v1.QueryLoyaltyImportsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/_api/loyalty-imports","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/loyalty-imports","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryLoyaltyImportsRequest","description":"","properties":{"query":{"description":"Filter object.\nSee [API Query Language](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/api-query-language)\nfor more information.\n\nFor a detailed list of supported filters, see\n[Supported Filters](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/loyalty-imports/supported-filters).","$ref":"#/components/schemas/wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["query"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.loyalty.imports.v1.LoyaltyImports","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_IMPORTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-imports","serviceArtifactId":"com.wixpress.loyalty.loyalty-imports","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.imports.v1.QueryLoyaltyImportsRequest","responseMessage":"wix.loyalty.imports.v1.QueryLoyaltyImportsResponse"},"legacyExamples":[{"name":"QueryLoyaltyImports","type":"METHOD","content":{"title":"Query Loyalty imports","request":"curl -X POST \\\n 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"query\": {}\n }'","response":"{\n \"loyaltyImports\": [\n {\n \"id\": \"5cc0b472-e488-4de3-92ba-bd718a44933a\",\n \"asyncImportJobId\": \"a9ff8502-cb2d-43dc-a7b3-981c8163f302\",\n \"revision\": \"6\",\n \"createdDate\": \"2024-09-17T10:58:00.100Z\",\n \"updatedDate\": \"2024-09-17T11:05:12.714Z\",\n \"status\": \"IMPORTED\",\n \"fileMetadata\": {\n \"size\": 20915,\n \"name\": \"data-8NkK3PqxWwQlOBzFF3izU.csv\",\n \"url\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"header\": {\n \"values\": [\n \"name\",\n \"surname\",\n \"email\",\n \"points\"\n ]\n },\n \"headerMappingInfo\": {\n \"headerMappings\": [\n {\n \"columnName\": \"EMAIL\",\n \"columnIndex\": 2\n },\n {\n \"columnName\": \"POINTS\",\n \"columnIndex\": 3\n }\n ]\n },\n \"sampleDataRows\": [\n {\n \"values\": [\n \"Ray\",\n \"Alvarado\",\n \"aray6720@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Charde\",\n \"Clemons\",\n \"c.clemons5125@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Jade\",\n \"Matthews\",\n \"mjade1457@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Xander\",\n \"Lucas\",\n \"lucas-xander665@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Thaddeus\",\n \"Molina\",\n \"molina-thaddeus@example.com\",\n \"15\"\n ]\n }\n ]\n },\n \"parseResult\": {\n \"parsedRowCount\": 500\n },\n \"importResult\": {\n \"errorFileExists\": false,\n \"successCount\": 500,\n \"failureCount\": 0\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {},\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/loyalty-imports/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.loyalty.imports.v1.LoyaltyImports","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_IMPORTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-imports","serviceArtifactId":"com.wixpress.loyalty.loyalty-imports","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.imports.v1.QueryLoyaltyImportsRequest","responseMessage":"wix.loyalty.imports.v1.QueryLoyaltyImportsResponse"},"legacyExamples":[{"name":"QueryLoyaltyImports","type":"METHOD","content":{"title":"Query Loyalty imports","request":"curl -X POST \\\n 'https://www.wixapis.com/_api/loyalty-imports/v1/loyalty-imports/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"query\": {}\n }'","response":"{\n \"loyaltyImports\": [\n {\n \"id\": \"5cc0b472-e488-4de3-92ba-bd718a44933a\",\n \"asyncImportJobId\": \"a9ff8502-cb2d-43dc-a7b3-981c8163f302\",\n \"revision\": \"6\",\n \"createdDate\": \"2024-09-17T10:58:00.100Z\",\n \"updatedDate\": \"2024-09-17T11:05:12.714Z\",\n \"status\": \"IMPORTED\",\n \"fileMetadata\": {\n \"size\": 20915,\n \"name\": \"data-8NkK3PqxWwQlOBzFF3izU.csv\",\n \"url\": \"/sites/dbba027b-3ad1-49dc-abdc-e1167a75290b/6099ebc5-0cce-4a2b-9903-2429c214d757.csv\",\n \"header\": {\n \"values\": [\n \"name\",\n \"surname\",\n \"email\",\n \"points\"\n ]\n },\n \"headerMappingInfo\": {\n \"headerMappings\": [\n {\n \"columnName\": \"EMAIL\",\n \"columnIndex\": 2\n },\n {\n \"columnName\": \"POINTS\",\n \"columnIndex\": 3\n }\n ]\n },\n \"sampleDataRows\": [\n {\n \"values\": [\n \"Ray\",\n \"Alvarado\",\n \"aray6720@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Charde\",\n \"Clemons\",\n \"c.clemons5125@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Jade\",\n \"Matthews\",\n \"mjade1457@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Xander\",\n \"Lucas\",\n \"lucas-xander665@example.com\",\n \"15\"\n ]\n },\n {\n \"values\": [\n \"Thaddeus\",\n \"Molina\",\n \"molina-thaddeus@example.com\",\n \"15\"\n ]\n }\n ]\n },\n \"parseResult\": {\n \"parsedRowCount\": 500\n },\n \"importResult\": {\n \"errorFileExists\": false,\n \"successCount\": 500,\n \"failureCount\": 0\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {},\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Query Loyalty Imports","slugifiedName":"query-loyalty-imports"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true}],"webhooks":[{"summary":"Loyalty Import Created","title":"Loyalty Import Created","description":"Triggered when a loyalty import is created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.imports.v1.loyalty_import","serviceName":"wix.loyalty.imports.v1.LoyaltyImports","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.imports.v1.loyalty_import_created","legacyExamples":[{"name":"LoyaltyImportCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"52269077-05f2-4b59-ba4f-36ef8c4c1e11\",\n \"entityFqdn\": \"wix.loyalty.imports.v1.loyalty_import\",\n \"slug\": \"created\",\n \"entityId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"createdEvent\": {\n \"entityAsJson\": \"{\\\"loyaltyImport\\\":{\\\"id\\\":\\\"8046df3c-7575-4098-a5ab-c91ad8f33c47\\\",\\\"revision\\\":1,\\\"createdDate\\\":\\\"2019-10-30T17:22:10.299Z\\\",\\\"updatedDate\\\":\\\"2019-10-30T17:22:10.299Z\\\",\\\"loremUppercase\\\":\\\"LOREM UPPERCASE\\\",\\\"ipsum\\\":\\\"lorem ipsum\\\",\\\"businessAddress\\\":\\\"Pankivska 14a\\\"}}\"\n },\n \"eventTime\": \"2020-10-18T13:40:58.304800Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/wix.loyalty.imports.v1.LoyaltyImport","contentLink":{"displayName":"Loyalty Import Created","slugifiedName":"loyalty-import-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\n\nThe Loyalty Imports API allows you to import loyalty data for existing customers from external sources into your Wix site's loyalty program. You can track import progress, handle any errors that may occur during the process, and manage your loyalty data efficiently.\n\n\nWith the Loyalty Imports API, you can:\n\n+ [Create a loyalty import](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/velo/api-reference/wix-loyalty-v2/imports/create-loyalty-import) to initiate the import process.\n+ [Create a loyalty import file URL](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/imports/create-loyalty-import-file-url) to securely upload loyalty data files.\n+ [Execute the loyalty import](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/imports/execute-loyalty-import) to begin processing the uploaded file.\n+ [Get a loyalty import](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/imports/get-loyalty-import) to retrieve details about a specific import.\n+ [Get an error file download URL](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/imports/get-error-file-download-url) to access error information for failed imports.\n+ [Query loyalty imports](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/imports/query-loyalty-imports) to retrieve and filter existing loyalty imports.\n\nFor more information about managing your site's loyalty program, see the [Wix Loyalty Program API](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/introduction).\n\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n- You must have the Wix Loyalty Program app installed on your site to use this API.\n- The maximum file size for loyalty imports is `10MB`.\n\n\n## Import process overview\n\nThe loyalty import process follows these phases:\n\n1. **Prepare Data File**: Create a CSV file with the required loyalty data fields.\n2. **Create Upload URL**: Generate a secure URL for file upload.\n3. **Upload File**: Upload your prepared loyalty data file to the provided URL.\n4. **Create Import**: Initialize the import process, which includes file parsing.\n5. **Execute Import**: Start the actual import of parsed data.\n6. **Monitor Progress**: Track the import status and handle any errors.\n\n\n## Preparing the loyalty data file\n\nWhen creating your loyalty data file for import, consider the following guidelines:\n\n\n### Required fields\n\nYour import file must contain at least two required fields:\n- A field with the customer's email address.\n- A field with the customer's points balance.\n\n### File format\n\nPrepare your data in a CSV (Comma-Separated Values) format. Here's an example of what your import file might look like:\n\n```csv\nName,Email,Points balance,Redeemed points,Last activity\nEmma Smith,emma.smith@example.com,400,0,2024-08-23T13:19:12.355Z\nAhmed Hassan,ahmed.hassan@example.com,200,0,2024-08-23T13:18:59.984Z\nMia Anderson,mia.anderson@example.com,200,0,2024-08-22T10:05:19.967Z\n```\n\n### Additional considerations\n\n- The email addresses in the file must match those of existing contacts in your loyalty program.\n- The import will be successful as long as the required fields are present and formatted correctly.\n\n## Customer identification and error handling\n\nThe import process uses the email address as the unique identifier for each customer. If an email address in the import file doesn't match an existing customer, that row is skipped and logged as an error.\n\nDuring the import:\n- The process continues even if errors are encountered for individual customers.\n- Successful imports and errors are tracked separately.\n- After completion, you can retrieve error details for any failed imports.\n\nThe `importResult` property of the Loyalty Import object contains the results of the import:\n\n - `successCount`: Number of successfully imported customer records\n - `failureCount`: Number of customer records that couldn't be imported\n - `errorFileExists`: Indicates whether an error file is available for download\n\nThe `parseResult` property provides information about the initial file parsing:\n- `parsedRowCount`: Total number of rows processed from the import file\n\nFor example, if you import a file with 3 customers and 1 fails to import, the response might look like this:\n\n```json\n{\n \"parseResult\": {\n \"parsedRowCount\": 3\n },\n \"importResult\": {\n \"errorFileExists\": true,\n \"successCount\": 2,\n \"failureCount\": 1\n }\n}\n```\n\nThis indicates:\n- 3 rows were parsed from the file\n- Points for 2 customers were successfully imported\n- Points for 1 customer failed to import\n\nIf errors occur, call `Get Error File Download Url` to retrieve detailed error information. The error file will contain specific details about why certain rows failed to import, such as unmatched email addresses or invalid point values.\n\n## Terminology\n\n+ __Loyalty Import__: A Loyalty Import represents a batch import of loyalty points for existing customers. You can use Loyalty Imports to import loyalty points from 3rd-party providers or update existing customer point balances.\n+ __Import Status__: The current state of the import process. Possible values include:\n + `UNKNOWN`: The status is not known or specified.\n + `INITIATED`: The import has been initiated.\n + `PARSING`: The system is currently parsing the import file.\n + `PARSED`: The import file has been successfully parsed.\n + `IMPORTING`: The system is currently importing the parsed data.\n + `IMPORTED`: The import process is complete.\n + `FAILED`: The import process has failed.\n+ __Header Mapping Info__: Information used to map headers in the import file to corresponding fields in the loyalty program.\n+ __Error File__: A file containing details about errors encountered during the import process.\n+ __Parse__: The process of analyzing the import file to ensure it's in the correct format and contains valid data before proceeding with the actual import.\n"},{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Loyalty Imports: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the Loyalty Import object:\n\n| Field | Query Filter Operators | Sortable |\n|----------------------------------------|--------------------------------------------------------------------------------------|----------|\n| `createdDate` | `$eq`, `$ne`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `status` | `$eq`, `$ne`, `$hasSome`, `$in`, `$nin`, `$exists` | Sortable |\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Loyalty Imports endpoint](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/imports/query-loyalty-imports)"}],"components":{"schemas":{"wix.loyalty.imports.v1.LoyaltyImport":{"type":"object","properties":{"id":{"description":"The ID of the import.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"asyncImportJobId":{"description":"ID of the asynchronous import job associated with this import.","format":"GUID","readOnly":true,"title":"asyncImportJobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the Loyalty Import is updated.\nTo prevent conflicting changes, the current revision must be passed when updating the Loyalty Import.\n\nIgnored when creating a Loyalty Import.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the Loyalty Import was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the Loyalty Import was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Current status of the import process.\n\n- `UNKNOWN`: Status is unknown or not specified.\n- `INITIATED`: The import has been initiated but processing has not yet begun.\n- `PARSING`: The system is currently parsing the import file.\n- `PARSED`: The import file has been successfully parsed and is ready for importing.\n- `IMPORTING`: The system is currently importing the parsed data.\n- `IMPORTED`: The import process is complete. This status indicates the process finished, but doesn't guarantee all data imported successfully.\n- `FAILED`: The import process has failed.","readOnly":true,"title":"status","type":"string","$ref":"#/components/schemas/wix.loyalty.imports.v1.ImportStatusEnum.ImportStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileMetadata":{"description":"Metadata of the uploaded file containing loyalty points data.","$ref":"#/components/schemas/wix.loyalty.imports.v1.FileMetadata","summary":"fileMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"parseResult":{"description":"Results of parsing the uploaded file, including the number of rows parsed and any parse errors.","$ref":"#/components/schemas/wix.loyalty.imports.v1.ParseResult","summary":"parseResult","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"importResult":{"description":"Results of the import process, including success and failure counts.","$ref":"#/components/schemas/wix.loyalty.imports.v1.ImportResult","summary":"importResult","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LoyaltyImport","description":"An Import object is a batch import of loyalty points for existing customers.\nYou can use Loyalty Imports to import loyalty points from 3rd-party providers or update existing customer point balances.\nThis object tracks the entire import process from file upload to data processing."},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"wix.loyalty.imports.v1.ImportStatusEnum.ImportStatus":{"type":"string","description":"","title":"ImportStatus","enum":["UNKNOWN","INITIATED","PARSING","PARSED","IMPORTING","IMPORTED","FAILED"]},"wix.loyalty.imports.v1.FileMetadata":{"type":"object","properties":{"size":{"description":"Size of the uploaded file in bytes. Max: `10 MB`.","maximum":104857600,"readOnly":true,"title":"size","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Name of the uploaded file.","format":"GUID","readOnly":true,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"URL of the uploaded file.","minLength":3,"maxLength":10000,"title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"header":{"description":"Column headings from the first row of the uploaded CSV file.","$ref":"#/components/schemas/wix.loyalty.imports.v1.FileHeader","summary":"header","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headerMappingInfo":{"description":"Mapping between loyalty data fields and the corresponding columns in the uploaded file.\n\nMust include mappings for both `EMAIL` and `POINTS` to be valid.","$ref":"#/components/schemas/wix.loyalty.imports.v1.HeaderMappingInfo","summary":"headerMappingInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sampleDataRows":{"description":"Up to 5 sample rows from the import file, providing a preview of the data to be imported.","maxItems":5,"title":"sampleDataRows","type":"array","items":{"$ref":"#/components/schemas/wix.loyalty.imports.v1.SampleDataRow"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FileMetadata","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"wix.loyalty.imports.v1.FileHeader":{"type":"object","properties":{"values":{"description":"Column headings from the first row of the uploaded file.","maxItems":100,"maxLength":1000,"title":"values","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FileHeader","description":""},"wix.loyalty.imports.v1.HeaderMappingInfo":{"type":"object","properties":{"headerMappings":{"description":"Mappings between required loyalty data fields and file columns.\nMust contain exactly 2 mappings: one for `EMAIL` and one for `POINTS`.","minItems":2,"maxItems":2,"title":"headerMappings","type":"array","items":{"$ref":"#/components/schemas/wix.loyalty.imports.v1.HeaderMapping"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"HeaderMappingInfo","description":""},"wix.loyalty.imports.v1.HeaderMapping":{"type":"object","properties":{"columnName":{"description":"The required loyalty data field that this mapping corresponds to. Must be either `EMAIL` or `POINTS`.","title":"columnName","type":"string","$ref":"#/components/schemas/wix.loyalty.imports.v1.ColumnName","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"columnIndex":{"description":"The zero-based index of the column in the uploaded file that contains the data for this loyalty field.\nFor example, if the email addresses are in the second column of the CSV file, this value would be 1.","title":"columnIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"HeaderMapping","description":""},"wix.loyalty.imports.v1.ColumnName":{"type":"string","description":"","title":"ColumnName","enum":["EMAIL","POINTS"]},"wix.loyalty.imports.v1.SampleDataRow":{"type":"object","properties":{"values":{"description":"Values in one sample data row. Each value corresponds to a column in the CSV file.\nThe number of values matches the number of columns in the file.","maxItems":20,"maxLength":1000,"title":"values","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SampleDataRow","description":""},"wix.loyalty.imports.v1.ParseResult":{"type":"object","properties":{"parsedRowCount":{"description":"Number of rows parsed from the uploaded import file.","readOnly":true,"title":"parsedRowCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"parseErrorReason":{"description":"Reason code explaining why parsing failed, if applicable.","readOnly":true,"maxLength":1000,"title":"parseErrorReason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ParseResult","description":""},"wix.loyalty.imports.v1.ImportResult":{"type":"object","properties":{"errorFileExists":{"description":"Whether an error file detailing import failures is available for download. The file includes row-by-row import status, error reasons, and original data.","title":"errorFileExists","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"successCount":{"description":"Number of rows successfully imported.","readOnly":true,"title":"successCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"failureCount":{"description":"Number of rows that failed to import due to errors.","readOnly":true,"title":"failureCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ImportResult","description":""},"wix.loyalty.imports.v1.CreateLoyaltyImportRequest":{"type":"object","properties":{"fileUrl":{"description":"URL of the file to import.","title":"fileUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileName":{"description":"Name of the file to import.","title":"fileName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileSize":{"description":"Size of the file to import, in bytes.","title":"fileSize","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateLoyaltyImportRequest","description":""},"wix.loyalty.imports.v1.CreateLoyaltyImportResponse":{"type":"object","properties":{"loyaltyImport":{"description":"Created loyalty import.","$ref":"#/components/schemas/wix.loyalty.imports.v1.LoyaltyImport","summary":"loyaltyImport","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateLoyaltyImportResponse","description":""},"wix.loyalty.imports.v1.GetLoyaltyImportRequest":{"type":"object","properties":{"loyaltyImportId":{"description":"Loyalty import ID.","title":"loyaltyImportId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetLoyaltyImportRequest","description":""},"wix.loyalty.imports.v1.GetLoyaltyImportResponse":{"type":"object","properties":{"loyaltyImport":{"description":"Retrieved loyalty import.","$ref":"#/components/schemas/wix.loyalty.imports.v1.LoyaltyImport","summary":"loyaltyImport","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetLoyaltyImportResponse","description":""},"wix.loyalty.imports.v1.GetErrorFileDownloadUrlRequest":{"type":"object","properties":{"loyaltyImportId":{"description":"Loyalty import ID.","title":"loyaltyImportId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetErrorFileDownloadUrlRequest","description":""},"wix.loyalty.imports.v1.GetErrorFileDownloadUrlResponse":{"type":"object","properties":{"url":{"description":"URL for downloading the error file.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetErrorFileDownloadUrlResponse","description":""},"wix.loyalty.imports.v1.ExecuteLoyaltyImportRequest":{"type":"object","properties":{"loyaltyImportId":{"description":"Loyalty import ID.","title":"loyaltyImportId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headerMappingInfo":{"description":"Header mapping information for the import file.","$ref":"#/components/schemas/wix.loyalty.imports.v1.HeaderMappingInfo","summary":"headerMappingInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExecuteLoyaltyImportRequest","description":""},"wix.loyalty.imports.v1.ExecuteLoyaltyImportResponse":{"type":"object","properties":{"loyaltyImport":{"description":"Executed loyalty import.","$ref":"#/components/schemas/wix.loyalty.imports.v1.LoyaltyImport","summary":"loyaltyImport","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExecuteLoyaltyImportResponse","description":""},"wix.loyalty.imports.v1.CreateLoyaltyImportFileUrlRequest":{"type":"object","properties":{},"title":"CreateLoyaltyImportFileUrlRequest","description":""},"wix.loyalty.imports.v1.CreateLoyaltyImportFileUrlResponse":{"type":"object","properties":{"filePath":{"description":"Path where the file will be stored.","title":"filePath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uploadUrl":{"description":"URL for uploading the loyalty import file.","title":"uploadUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateLoyaltyImportFileUrlResponse","description":""},"wix.loyalty.imports.v1.QueryLoyaltyImportsRequest":{"type":"object","properties":{"query":{"description":"Filter object.\nSee [API Query Language](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/api-query-language)\nfor more information.\n\nFor a detailed list of supported filters, see\n[Supported Filters](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/loyalty-imports/supported-filters).","$ref":"#/components/schemas/wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryLoyaltyImportsRequest","description":""},"wix.common.CursorQuery":{"type":"object","properties":{"filter":{"description":"Filter object.\n\nLearn more about the [filter section](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object.\n\nLearn more about the [sort section](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).","maxItems":5,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.common.CursorQuery.pagingMethod"}]},"wix.common.CursorQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor paging options.\n\nLearn more about [cursor paging](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":16000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"wix.loyalty.imports.v1.QueryLoyaltyImportsResponse":{"type":"object","properties":{"loyaltyImports":{"description":"List of loyalty imports matching the query.","title":"loyaltyImports","type":"array","items":{"$ref":"#/components/schemas/wix.loyalty.imports.v1.LoyaltyImport"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata.","$ref":"#/components/schemas/wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryLoyaltyImportsResponse","description":""},"wix.common.CursorPagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in current page.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursor strings that point to the next page, previous page, or both.","$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasNext":{"description":"Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page.","title":"hasNext","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPagingMetadata","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.loyalty.imports.v1.DeleteLoyaltyImportRequest":{"type":"object","properties":{"loyaltyImportId":{"description":"Loyalty import ID.","format":"GUID","title":"loyaltyImportId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the loyalty import is updated.\nTo prevent conflicting changes, the current revision must be passed when updating the loyalty import.","title":"revision","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteLoyaltyImportRequest","description":""},"wix.loyalty.imports.v1.DeleteLoyaltyImportResponse":{"type":"object","properties":{},"title":"DeleteLoyaltyImportResponse","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"wix.loyalty.imports.v1.ImportFinished":{"type":"object","properties":{"loyaltyImport":{"description":"Completed loyalty import.","$ref":"#/components/schemas/wix.loyalty.imports.v1.LoyaltyImport","summary":"loyaltyImport","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ImportFinished","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Loyalty Import","description":"An Import object is a batch import of loyalty points for existing customers.\nYou can use Loyalty Imports to import loyalty points from 3rd-party providers or update existing customer point balances.\nThis object tracks the entire import process from file upload to data processing.","fqdn":"wix.loyalty.imports.v1.loyalty_import"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\n\nThe Loyalty Imports API allows you to import loyalty data for existing customers from external sources into your Wix site's loyalty program. You can track import progress, handle any errors that may occur during the process, and manage your loyalty data efficiently.\n\n\nWith the Loyalty Imports API, you can:\n\n+ [Create a loyalty import](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/velo/api-reference/wix-loyalty-v2/imports/create-loyalty-import) to initiate the import process.\n+ [Create a loyalty import file URL](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/imports/create-loyalty-import-file-url) to securely upload loyalty data files.\n+ [Execute the loyalty import](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/imports/execute-loyalty-import) to begin processing the uploaded file.\n+ [Get a loyalty import](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/imports/get-loyalty-import) to retrieve details about a specific import.\n+ [Get an error file download URL](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/imports/get-error-file-download-url) to access error information for failed imports.\n+ [Query loyalty imports](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/imports/query-loyalty-imports) to retrieve and filter existing loyalty imports.\n\nFor more information about managing your site's loyalty program, see the [Wix Loyalty Program API](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/introduction).\n\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n- You must have the Wix Loyalty Program app installed on your site to use this API.\n- The maximum file size for loyalty imports is `10MB`.\n\n\n## Import process overview\n\nThe loyalty import process follows these phases:\n\n1. **Prepare Data File**: Create a CSV file with the required loyalty data fields.\n2. **Create Upload URL**: Generate a secure URL for file upload.\n3. **Upload File**: Upload your prepared loyalty data file to the provided URL.\n4. **Create Import**: Initialize the import process, which includes file parsing.\n5. **Execute Import**: Start the actual import of parsed data.\n6. **Monitor Progress**: Track the import status and handle any errors.\n\n\n## Preparing the loyalty data file\n\nWhen creating your loyalty data file for import, consider the following guidelines:\n\n\n### Required fields\n\nYour import file must contain at least two required fields:\n- A field with the customer's email address.\n- A field with the customer's points balance.\n\n### File format\n\nPrepare your data in a CSV (Comma-Separated Values) format. Here's an example of what your import file might look like:\n\n```csv\nName,Email,Points balance,Redeemed points,Last activity\nEmma Smith,emma.smith@example.com,400,0,2024-08-23T13:19:12.355Z\nAhmed Hassan,ahmed.hassan@example.com,200,0,2024-08-23T13:18:59.984Z\nMia Anderson,mia.anderson@example.com,200,0,2024-08-22T10:05:19.967Z\n```\n\n### Additional considerations\n\n- The email addresses in the file must match those of existing contacts in your loyalty program.\n- The import will be successful as long as the required fields are present and formatted correctly.\n\n## Customer identification and error handling\n\nThe import process uses the email address as the unique identifier for each customer. If an email address in the import file doesn't match an existing customer, that row is skipped and logged as an error.\n\nDuring the import:\n- The process continues even if errors are encountered for individual customers.\n- Successful imports and errors are tracked separately.\n- After completion, you can retrieve error details for any failed imports.\n\nThe `importResult` property of the Loyalty Import object contains the results of the import:\n\n - `successCount`: Number of successfully imported customer records\n - `failureCount`: Number of customer records that couldn't be imported\n - `errorFileExists`: Indicates whether an error file is available for download\n\nThe `parseResult` property provides information about the initial file parsing:\n- `parsedRowCount`: Total number of rows processed from the import file\n\nFor example, if you import a file with 3 customers and 1 fails to import, the response might look like this:\n\n```json\n{\n \"parseResult\": {\n \"parsedRowCount\": 3\n },\n \"importResult\": {\n \"errorFileExists\": true,\n \"successCount\": 2,\n \"failureCount\": 1\n }\n}\n```\n\nThis indicates:\n- 3 rows were parsed from the file\n- Points for 2 customers were successfully imported\n- Points for 1 customer failed to import\n\nIf errors occur, call `Get Error File Download Url` to retrieve detailed error information. The error file will contain specific details about why certain rows failed to import, such as unmatched email addresses or invalid point values.\n\n## Terminology\n\n+ __Loyalty Import__: A Loyalty Import represents a batch import of loyalty points for existing customers. You can use Loyalty Imports to import loyalty points from 3rd-party providers or update existing customer point balances.\n+ __Import Status__: The current state of the import process. Possible values include:\n + `UNKNOWN`: The status is not known or specified.\n + `INITIATED`: The import has been initiated.\n + `PARSING`: The system is currently parsing the import file.\n + `PARSED`: The import file has been successfully parsed.\n + `IMPORTING`: The system is currently importing the parsed data.\n + `IMPORTED`: The import process is complete.\n + `FAILED`: The import process has failed.\n+ __Header Mapping Info__: Information used to map headers in the import file to corresponding fields in the loyalty program.\n+ __Error File__: A file containing details about errors encountered during the import process.\n+ __Parse__: The process of analyzing the import file to ensure it's in the correct format and contains valid data before proceeding with the actual import.\n"},{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Loyalty Imports: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the Loyalty Import object:\n\n| Field | Query Filter Operators | Sortable |\n|----------------------------------------|--------------------------------------------------------------------------------------|----------|\n| `createdDate` | `$eq`, `$ne`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `status` | `$eq`, `$ne`, `$hasSome`, `$in`, `$nin`, `$exists` | Sortable |\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Loyalty Imports endpoint](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/imports/query-loyalty-imports)"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}