> For the complete documentation index, see [llms.txt](https://help.openloyalty.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.openloyalty.io/api-reference/import.md).
# Import
These endpoints will allow you to import data.
## Get imports list
> \\ \ \
> This method returns all imports. \
> \
> If sorting is not chosen, the rows will be returned in an unspecified order. \
> To sort a result, use an \`\_orderBy\` parameter in query.
````json
{"openapi":"3.0.0","info":{"title":"Open Loyalty","version":"0.0.1"},"tags":[{"name":"Import","description":"These endpoints will allow you to import data."}],"servers":[{"url":"http://openloyalty.localhost"}],"security":[{"Bearer":[]},{"token":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Open Loyalty has the JWT authorization.\nTo learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens \n\n### Obtain an access token\n\nSend a request with the parameters username and password\n\n#### Definition\n\n`POST /api/admin/login_check` [Go to definition](#operation/adminLoginCheck)\\\n`POST /api/{storeCode}/member/login_check` [Go to definition](#operation/memberLoginCheck)\n\n#### Example\n\n```bash\ncurl {HOST}/api/admin/login_check\n -H 'Content-Type: application/json;charset=UTF-8'\n -H 'Accept: application/json, text/plain, */*'\n --data-binary '{\"username\":\"admin\",\"password\":\"password\"}'\n```\n\n#### Example Response\n\n```json\n{\n \"token\":\"eyJhbGciOiJSUzI1NiIsInR5cCI6...\",\n \"refresh_token\":\"0558f8bb29948c4e54c443f...\"\n}\n```\n\n### Using JSON Web Token\n\nAdd authorization header to each request\\\n`Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...`\\\nYou can now access any API method you want under the /api prefix.\n\n#### Example\n```bash\ncurl {HOST}/api/{storeCode}/analytics/members\n -H 'Accept: application/json'\n -H 'Content-type: application/x-www-form-urlencoded'\n -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'\n```\n\n### Refresh JSON Web Token\nYou can refresh token using refresh_token that was given during login.\\\nThere are two endpoints\\\nTo refresh admin token `POST /api/token/refresh` [Go to definition](#operation/tokenRefresh)\\\nTo refresh member token `POST /api/{storeCode}/token/refresh` [Go to definition](#operation/tokenRefreshMember)\n","name":"Authorization","in":"header","bearerFormat":"JWT","scheme":"bearer"},"token":{"type":"apiKey","name":"X-AUTH-TOKEN","in":"header"}},"parameters":{"storeCode":{"name":"storeCode","in":"path","description":"Store code","required":true,"schema":{"type":"string"}},"page":{"name":"_page","in":"query","description":"Number of page with results, starts from 1","required":false,"schema":{"type":"integer","default":1,"minimum":1}},"itemsOnPage":{"name":"_itemsOnPage","in":"query","description":"Items on one page","required":false,"schema":{"type":"integer","default":10,"maximum":50,"minimum":1}},"orderBy":{"name":"_orderBy","in":"query","description":"Sorting order. If sorting is not chosen, the rows will be returned in an unspecified order. Sort order: * `asc` - Ascending, from A to Z * `desc` - Descending, from Z to A","required":false,"style":"deepObject","explode":true,"schema":{"type":"object","additionalProperties":{"type":"string","enum":["asc","desc"]}}}},"schemas":{"Import":{"required":["importId","type","uploadedDate","fileName","status","itemsToImport"],"properties":{"importId":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["member","groupValue","segmentMembers","unitTransferAdding","unitTransferSpending","transaction","rewardCoupon"]},"uploadedDate":{"type":"string","format":"date-time"},"fileName":{"type":"string"},"status":{"type":"string","enum":["pending","queued","failed","error"]},"itemsToImport":{"type":"integer"},"user":{"type":"string","format":"uuid"},"errorMessage":{"type":"string"},"additionalData":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"integer"}},{"type":"array","items":{"type":"boolean"}}]}}},"type":"object","additionalProperties":false},"SearchableTotalResponse":{"required":["all","filtered","estimated"],"properties":{"all":{"type":"integer","deprecated":true},"filtered":{"type":"integer","deprecated":true},"estimated":{"description":"Field estimated is used to show that the results are estimated. It might happen when there are more than 5000 results due to performance optimization.","type":"boolean","deprecated":true}},"type":"object","deprecated":true},"ExpiredToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"InvalidToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"Unauthorized":{"required":["message"],"properties":{"message":{"type":"string"}},"type":"object"}},"responses":{"AccessDenied":{"description":"Forbidden.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}}}},"paths":{"/api/{storeCode}/import":{"get":{"tags":["Import"],"summary":"Get imports list","description":"
\nThis method returns all imports. \n\nIf sorting is not chosen, the rows will be returned in an unspecified order. \nTo sort a result, use an `_orderBy` parameter in query.\n","operationId":"_importGetList","parameters":[{"$ref":"#/components/parameters/storeCode"},{"name":"importId","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["member","groupValue","segmentMembers","unitTransferAdding","unitTransferSpending","transaction","rewardCoupon"]}},{"name":"uploadedDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/itemsOnPage"},{"$ref":"#/components/parameters/orderBy"}],"responses":{"200":{"description":"List of imports","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Import"}},"total":{"$ref":"#/components/schemas/SearchableTotalResponse"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExpiredToken"},{"$ref":"#/components/schemas/InvalidToken"},{"$ref":"#/components/schemas/Unauthorized"}]}}}},"403":{"$ref":"#/components/responses/AccessDenied"}}}}}}
````
## Get import details
> \\ \
````json
{"openapi":"3.0.0","info":{"title":"Open Loyalty","version":"0.0.1"},"tags":[{"name":"Import","description":"These endpoints will allow you to import data."}],"servers":[{"url":"http://openloyalty.localhost"}],"security":[{"Bearer":[]},{"token":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Open Loyalty has the JWT authorization.\nTo learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens \n\n### Obtain an access token\n\nSend a request with the parameters username and password\n\n#### Definition\n\n`POST /api/admin/login_check` [Go to definition](#operation/adminLoginCheck)\\\n`POST /api/{storeCode}/member/login_check` [Go to definition](#operation/memberLoginCheck)\n\n#### Example\n\n```bash\ncurl {HOST}/api/admin/login_check\n -H 'Content-Type: application/json;charset=UTF-8'\n -H 'Accept: application/json, text/plain, */*'\n --data-binary '{\"username\":\"admin\",\"password\":\"password\"}'\n```\n\n#### Example Response\n\n```json\n{\n \"token\":\"eyJhbGciOiJSUzI1NiIsInR5cCI6...\",\n \"refresh_token\":\"0558f8bb29948c4e54c443f...\"\n}\n```\n\n### Using JSON Web Token\n\nAdd authorization header to each request\\\n`Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...`\\\nYou can now access any API method you want under the /api prefix.\n\n#### Example\n```bash\ncurl {HOST}/api/{storeCode}/analytics/members\n -H 'Accept: application/json'\n -H 'Content-type: application/x-www-form-urlencoded'\n -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'\n```\n\n### Refresh JSON Web Token\nYou can refresh token using refresh_token that was given during login.\\\nThere are two endpoints\\\nTo refresh admin token `POST /api/token/refresh` [Go to definition](#operation/tokenRefresh)\\\nTo refresh member token `POST /api/{storeCode}/token/refresh` [Go to definition](#operation/tokenRefreshMember)\n","name":"Authorization","in":"header","bearerFormat":"JWT","scheme":"bearer"},"token":{"type":"apiKey","name":"X-AUTH-TOKEN","in":"header"}},"parameters":{"storeCode":{"name":"storeCode","in":"path","description":"Store code","required":true,"schema":{"type":"string"}},"page":{"name":"_page","in":"query","description":"Number of page with results, starts from 1","required":false,"schema":{"type":"integer","default":1,"minimum":1}},"itemsOnPage":{"name":"_itemsOnPage","in":"query","description":"Items on one page","required":false,"schema":{"type":"integer","default":10,"maximum":50,"minimum":1}},"orderBy":{"name":"_orderBy","in":"query","description":"Sorting order. If sorting is not chosen, the rows will be returned in an unspecified order. Sort order: * `asc` - Ascending, from A to Z * `desc` - Descending, from Z to A","required":false,"style":"deepObject","explode":true,"schema":{"type":"object","additionalProperties":{"type":"string","enum":["asc","desc"]}}}},"schemas":{"ImportItem":{"required":["importId","status","createdAt","updatedAt"],"properties":{"importId":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["queued","inprogress","succeed","error","failed"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"message":{"type":"string"},"entity":{"anyOf":[{"$ref":"#/components/schemas/EntityMember"},{"$ref":"#/components/schemas/EntityMember"},{"title":"Collection","properties":{"id":{"type":"string","format":"uuid"},"data":{"required":["value","groupOfValuesId"],"properties":{"value":{"type":"string"},"description":{"type":"string"},"groupOfValuesId":{"type":"string","format":"uuid"}},"type":"object","additionalProperties":false}},"type":"object"},{"title":"Unit transfer adding","properties":{"id":{"type":"string","format":"uuid"},"data":{"required":["walletCode","unitSingularName","unitPluralName","value","registeredOn","createdOn","isPending","memberId","memberFullName"],"properties":{"walletName":{"type":"string"},"walletCode":{"type":"string"},"unitSingularName":{"type":"string"},"unitPluralName":{"type":"string"},"value":{"type":"number","format":"float"},"comment":{"type":"string"},"registeredOn":{"type":"string","format":"date-time"},"createdOn":{"type":"string","format":"date-time"},"isPending":{"type":"boolean"},"expireAt":{"type":"string","format":"date-time"},"memberId":{"type":"string","format":"uuid"},"memberFullName":{"type":"string"},"memberEmail":{"type":"string","format":"email"},"memberLoyaltyCardNumber":{"type":"string"},"memberPhone":{"type":"string"},"externalTransferId":{"type":"string"},"labels":{"type":"object"}},"type":"object","additionalProperties":false}},"type":"object"},{"title":"Unit transfer spending","properties":{"id":{"type":"string","format":"uuid"},"data":{"required":["walletCode","unitSingularName","unitPluralName","value","registeredOn","createdOn","memberId","memberFullName"],"properties":{"walletName":{"type":"string"},"walletCode":{"type":"string"},"unitSingularName":{"type":"string"},"unitPluralName":{"type":"string"},"value":{"type":"number","format":"float"},"comment":{"type":"string"},"registeredOn":{"type":"string","format":"date-time"},"createdOn":{"type":"string","format":"date-time"},"memberId":{"type":"string","format":"uuid"},"memberFullName":{"type":"string"},"memberEmail":{"type":"string","format":"email"},"memberLoyaltyCardNumber":{"type":"string"},"memberPhone":{"type":"string"},"externalTransferId":{"type":"string"},"labels":{"type":"object"}},"type":"object","additionalProperties":false}},"type":"object"},{"title":"Transaction","properties":{"id":{"type":"string","format":"uuid"},"data":{"required":["documentType","purchasedAt","grossValue"],"properties":{"documentType":{"type":"string"},"purchasedAt":{"type":"string","format":"date-time"},"grossValue":{"type":"number","format":"float"},"memberFullName":{"type":"string"},"memberEmail":{"type":"string"},"memberLoyaltyCardNumber":{"type":"string"},"memberPhone":{"type":"string"}},"type":"object","additionalProperties":false}},"type":"object"},{"title":"Reward coupon","properties":{"id":{"type":"string"},"data":{"required":["code"],"properties":{"code":{"type":"string"},"rewardId":{"type":"string","format":"uuid"}},"type":"object","additionalProperties":false}},"type":"object"},{"title":"Campaign code","properties":{"id":{"type":"string"},"data":{"required":["code"],"properties":{"code":{"type":"string"},"campaignId":{"type":"string","format":"uuid"}},"type":"object","additionalProperties":false}},"type":"object"}]}},"type":"object","additionalProperties":false},"EntityMember":{"properties":{"id":{"type":"string"},"data":{"properties":{"email":{"type":"string"},"loyaltyCardNumber":{"type":"string"},"phone":{"type":"string"}},"type":"object","additionalProperties":false}},"type":"object"},"SearchableTotalResponse":{"required":["all","filtered","estimated"],"properties":{"all":{"type":"integer","deprecated":true},"filtered":{"type":"integer","deprecated":true},"estimated":{"description":"Field estimated is used to show that the results are estimated. It might happen when there are more than 5000 results due to performance optimization.","type":"boolean","deprecated":true}},"type":"object","deprecated":true},"ExpiredToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"InvalidToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"Unauthorized":{"required":["message"],"properties":{"message":{"type":"string"}},"type":"object"}},"responses":{"AccessDenied":{"description":"Forbidden.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}}}},"paths":{"/api/{storeCode}/import/{import}":{"get":{"tags":["Import"],"summary":"Get import details","description":"
\n","operationId":"_importItemGetList","parameters":[{"$ref":"#/components/parameters/storeCode"},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["member","groupValue","segmentMembers","unitTransferAdding","unitTransferSpending","transaction","rewardCoupon","campaignCode"]}},{"name":"createdAt","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"updatedAt","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"entityId","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/itemsOnPage"},{"$ref":"#/components/parameters/orderBy"},{"name":"import","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"List of imports","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ImportItem"}},"total":{"$ref":"#/components/schemas/SearchableTotalResponse"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExpiredToken"},{"$ref":"#/components/schemas/InvalidToken"},{"$ref":"#/components/schemas/Unauthorized"}]}}}},"403":{"$ref":"#/components/responses/AccessDenied"}}}}}}
````
## Import file
> \\ \
````json
{"openapi":"3.0.0","info":{"title":"Open Loyalty","version":"0.0.1"},"tags":[{"name":"Import","description":"These endpoints will allow you to import data."}],"servers":[{"url":"http://openloyalty.localhost"}],"security":[{"Bearer":[]},{"token":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Open Loyalty has the JWT authorization.\nTo learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens \n\n### Obtain an access token\n\nSend a request with the parameters username and password\n\n#### Definition\n\n`POST /api/admin/login_check` [Go to definition](#operation/adminLoginCheck)\\\n`POST /api/{storeCode}/member/login_check` [Go to definition](#operation/memberLoginCheck)\n\n#### Example\n\n```bash\ncurl {HOST}/api/admin/login_check\n -H 'Content-Type: application/json;charset=UTF-8'\n -H 'Accept: application/json, text/plain, */*'\n --data-binary '{\"username\":\"admin\",\"password\":\"password\"}'\n```\n\n#### Example Response\n\n```json\n{\n \"token\":\"eyJhbGciOiJSUzI1NiIsInR5cCI6...\",\n \"refresh_token\":\"0558f8bb29948c4e54c443f...\"\n}\n```\n\n### Using JSON Web Token\n\nAdd authorization header to each request\\\n`Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...`\\\nYou can now access any API method you want under the /api prefix.\n\n#### Example\n```bash\ncurl {HOST}/api/{storeCode}/analytics/members\n -H 'Accept: application/json'\n -H 'Content-type: application/x-www-form-urlencoded'\n -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'\n```\n\n### Refresh JSON Web Token\nYou can refresh token using refresh_token that was given during login.\\\nThere are two endpoints\\\nTo refresh admin token `POST /api/token/refresh` [Go to definition](#operation/tokenRefresh)\\\nTo refresh member token `POST /api/{storeCode}/token/refresh` [Go to definition](#operation/tokenRefreshMember)\n","name":"Authorization","in":"header","bearerFormat":"JWT","scheme":"bearer"},"token":{"type":"apiKey","name":"X-AUTH-TOKEN","in":"header"}},"parameters":{"storeCode":{"name":"storeCode","in":"path","description":"Store code","required":true,"schema":{"type":"string"}}},"responses":{"BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"required":["code","message","errors"],"properties":{"code":{"type":"integer"},"message":{"type":"string"},"errors":{"type":"array","items":{"required":["message","parameters","plural","code","path"],"properties":{"message":{"type":"string"},"parameters":{},"plural":{"type":"integer","nullable":true},"code":{"type":"string"},"path":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"AccessDenied":{"description":"Forbidden.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}},"NotFound":{"description":"Not found.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}}},"schemas":{"ExpiredToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"InvalidToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"Unauthorized":{"required":["message"],"properties":{"message":{"type":"string"}},"type":"object"}}},"paths":{"/api/{storeCode}/import/{type}":{"post":{"tags":["Import"],"summary":"Import file","description":"
\n","operationId":"postImport","parameters":[{"$ref":"#/components/parameters/storeCode"},{"name":"type","in":"path","required":true,"schema":{"type":"string","enum":["member","groupValue","segmentMembers","unitTransferAdding","unitTransferSpending","transaction","campaignCode"]}}],"requestBody":{"description":"","content":{"multipart/form-data":{"schema":{"oneOf":[{"title":"Import Members","properties":{"import":{"required":["file"],"properties":{"file":{"description":"See sample import files available in the import guide\n","type":"object"}},"type":"object"}},"type":"object"},{"title":"Import Group values","properties":{"import":{"required":["additionalData","file"],"properties":{"additionalData":{"required":["groupOfValuesId"],"properties":{"groupOfValuesId":{"type":"string"}},"type":"object"},"file":{"description":"See sample import files available in the import guide\n","type":"object"}},"type":"object"}},"type":"object"},{"title":"Import Campaign codes","properties":{"import":{"required":["additionalData","file"],"properties":{"additionalData":{"required":["campaignId"],"properties":{"campaignId":{"type":"string"}},"type":"object"},"file":{"description":"See sample import files available in the import guide\n","type":"object"}},"type":"object"}},"type":"object"},{"title":"Import Segment Members","properties":{"import":{"required":["additionalData","file"],"properties":{"additionalData":{"required":["segmentId","identificationMethod"],"properties":{"segmentId":{"type":"string","format":"uuid"},"identificationMethod":{"description":"The identification method allows you to map an identifier to the appropriate member.\nTherefore, you should choose an identification method that corresponds to the type of member identifiers included in the file.\nSee sample import files available in the import guide\n","type":"string","enum":["uuid","email","phone","loyaltyCardNumber"]}},"type":"object"},"file":{"description":"A file with a list of member identifiers.\nAll identifiers in the imported file must be of the same type.\nAvailable identifier types are: uuid, email, phone, loyaltyCardNumber.\nSee sample import files available in the import guide\n","type":"string","format":"binary"}},"type":"object"}},"type":"object"},{"title":"Import adding units transfers","properties":{"import":{"required":["file"],"properties":{"file":{"description":"See sample import files available in the import guide\n","type":"string","format":"binary"}},"type":"object"}},"type":"object"},{"title":"Import spending units transfers","properties":{"import":{"required":["file"],"properties":{"file":{"description":"See sample import files available in the import guide\n","type":"string","format":"binary"}},"type":"object"}},"type":"object"},{"title":"Import transactions","properties":{"import":{"required":["file"],"properties":{"file":{"description":"See sample import files available in the import guide\n","type":"string","format":"binary"}},"type":"object"}},"type":"object"}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"required":["importId"],"properties":{"importId":{"type":"string","format":"uuid"}},"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExpiredToken"},{"$ref":"#/components/schemas/InvalidToken"},{"$ref":"#/components/schemas/Unauthorized"}]}}}},"403":{"$ref":"#/components/responses/AccessDenied"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
````
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://help.openloyalty.io/api-reference/import.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.