{"id":"8a1eb555-6751-4b8c-9b85-051b9391ed1a","createdDate":"2024-09-05T09:55:24.853Z","updatedDate":"2024-09-05T09:55:24.853Z","resourceId":"66a530fa-224c-48ee-841f-99a87365c6c3","api":{"schema":{"object":{"displayName":"Data Item Object","description":"","slug":"data-item-object","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/cloud.git"},"methods":[{"summary":"Insert Data Item","description":"Adds an item to a collection.\n\n\nAn item can only be inserted into an existing connection.\nYou can create a new collection using the [Data Collections API](https://dev.wix.com/api/rest/wix-data/wix-data/data-collections).\n\nWhen an item is inserted into a collection, the item's ID is automatically assigned a random value.\nYou can optionally provide a custom ID in `dataItem.id` when inserting the item.\nIf you specify an ID that already exists in the collection, the insertion will fail.\n\nIf `dataItem.data` is empty, a new item is created with no data fields.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.InsertDataItem","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.InsertDataItemResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"InsertDataItemRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection in which to insert the item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItem":{"description":"Item to insert.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","summary":"dataItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId","dataItem"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.INSERT"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.InsertDataItemRequest","responseMessage":"com.wixpress.cloud.data.api.data.InsertDataItemResponse"},"legacyExamples":[{"name":"InsertDataItem","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Insert new item","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItem\": {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n }\n}'","response":"{\n \"dataItem\": {\n \"id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n }\n}"}},{"name":"InsertDataItem","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Insert new item with a predefined id value","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItem\": {\n \"id\": \"abc123\",\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n }\n}'","response":"{\n \"id\": \"abc123\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"abc123\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/items","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.INSERT"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.InsertDataItemRequest","responseMessage":"com.wixpress.cloud.data.api.data.InsertDataItemResponse"},"legacyExamples":[{"name":"InsertDataItem","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Insert new item","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItem\": {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n }\n}'","response":"{\n \"dataItem\": {\n \"id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n }\n}"}},{"name":"InsertDataItem","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Insert new item with a predefined id value","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItem\": {\n \"id\": \"abc123\",\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n }\n}'","response":"{\n \"id\": \"abc123\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"abc123\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Insert Data Item","slugifiedName":"insert-data-item"},"permissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}]},{"summary":"Update Data Item","description":"Updates an item in a collection.\n\n\nThis endpoint replaces the data item's existing data with the payload provided in `dataItem.data` in the request.\n\nTo update an item, you need to specify an item ID and a collection ID.\nIf an item is found in the specified collection with the specified ID, that item is updated.\nIf the collection doesn't contain an item with that ID, the request fails.\n\nWhen an item is updated, its `data._updatedDate` field is changed to the current date and time.\n\n> **Note:**\n> After an item is updated, it only contains the fields included in the `dataItem.data` payload in Update Data Item request.\n> If the existing item has fields with values and those fields aren't included in the updated item, their values are lost.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.UpdateDataItem","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"dataItem.id","description":"Data item ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.UpdateDataItemResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateDataItemRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection containing the existing item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItem":{"description":"Updated data item content. The existing data item's content is replaced entirely.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","summary":"dataItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId","dataItem","dataItem.id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.UpdateDataItemRequest","responseMessage":"com.wixpress.cloud.data.api.data.UpdateDataItemResponse"},"legacyExamples":[{"name":"UpdateDataItem","serviceName":"DataItemService","type":"METHOD","content":{"title":"Update existing item","request":"curl -X PUT \\\n'https://www.wixapis.com/wix-data/v2/items/5331fc15-9441-4fd4-bc7b-7f6870c69228' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItem\": {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n }\n}'","response":"{\n \"dataItem\": {\n \"id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"put","path":"/v2/items/{dataItem.id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.UpdateDataItemRequest","responseMessage":"com.wixpress.cloud.data.api.data.UpdateDataItemResponse"},"legacyExamples":[{"name":"UpdateDataItem","serviceName":"DataItemService","type":"METHOD","content":{"title":"Update existing item","request":"curl -X PUT \\\n'https://www.wixapis.com/wix-data/v2/items/5331fc15-9441-4fd4-bc7b-7f6870c69228' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItem\": {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n }\n}'","response":"{\n \"dataItem\": {\n \"id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Update Data Item","slugifiedName":"update-data-item"},"permissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}]},{"summary":"Save Data Item","description":"Inserts or updates an item in a collection.\n\n\nThe Save Data Item endpoint inserts or updates the specified item, depending on whether it already exists in the collection.\n\n+ If you don't provide an ID, a new item is created.\n\n+ If you provide an ID that does not exist in the collection, a new item is created with that ID.\n\n+ If an item with the ID you provide already exists in the collection, that item is updated. When an item is updated, its `data._updatedDate` field is changed to the current date and time.\n\n> **Note:** When you provide an item with an ID that already exists in the collection, the payload you provide in `dataItem.data` replaces the existing item with that ID.\n> This means that the item's previous fields and values are lost.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.SaveDataItem","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.SaveDataItemResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SaveDataItemRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection in which to insert or update the item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItem":{"description":"Data item to insert or update.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","summary":"dataItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId","dataItem"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.SAVE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.SaveDataItemRequest","responseMessage":"com.wixpress.cloud.data.api.data.SaveDataItemResponse"},"legacyExamples":[{"name":"SaveDataItem","serviceName":"DataItemService","type":"METHOD","content":{"title":"Save item","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/save' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItem\": {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n }\n}'","response":"{\n \"dataItem\": {\n \"id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/items/save","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.SAVE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.SaveDataItemRequest","responseMessage":"com.wixpress.cloud.data.api.data.SaveDataItemResponse"},"legacyExamples":[{"name":"SaveDataItem","serviceName":"DataItemService","type":"METHOD","content":{"title":"Save item","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/save' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItem\": {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n }\n}'","response":"{\n \"dataItem\": {\n \"id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Save Data Item","slugifiedName":"save-data-item"},"permissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}]},{"summary":"Get Data Item","description":"Retrieves an item from a collection.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.GetDataItem","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"dataItemId","description":"ID of the data item to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"dataCollectionId","in":"query","description":"ID of the collection from which to retrieve the data item.","required":true,"schema":{"description":"ID of the collection from which to retrieve the data item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"consistentRead","in":"query","description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","required":false,"schema":{"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"language","in":"query","description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf provided, the result text is returned in the specified language.\n**Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n\nIf not provided, result text is not translated.","required":false,"schema":{"description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf provided, the result text is returned in the specified language.\n**Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n\nIf not provided, result text is not translated.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"fields","in":"query","description":"Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\n**Note:** The `_id` system field is always returned.","required":false,"schema":{"description":"Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\n**Note:** The `_id` system field is always returned.","maxItems":10000,"maxLength":1000,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"appOptions","in":"query","description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","required":false,"schema":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"publishPluginOptions","in":"query","description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","required":false,"schema":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.GetDataItemResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.GET"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.GetDataItemRequest","responseMessage":"com.wixpress.cloud.data.api.data.GetDataItemResponse"},"legacyExamples":[{"name":"GetDataItem","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Get existing item with complex id and consistent read","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/get' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItemId\": \"%id1\",\n \"consistentRead\": true\n}'","response":"{\n \"dataItem\": {\n \"id\": \"%id1\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"%id1\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n }\n}"}},{"name":"GetDataItem","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Get existing item","request":"curl -X GET \\\n'https://www.wixapis.com/wix-data/v2/items/5331fc15-9441-4fd4-bc7b-7f6870c69228?dataCollectionId=cities' \\\n-H 'Authorization: ' \\","response":"{\n \"dataItem\": {\n \"id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"get","path":"/v2/items/{dataItemId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.GET"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.GetDataItemRequest","responseMessage":"com.wixpress.cloud.data.api.data.GetDataItemResponse"},"legacyExamples":[{"name":"GetDataItem","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Get existing item with complex id and consistent read","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/get' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItemId\": \"%id1\",\n \"consistentRead\": true\n}'","response":"{\n \"dataItem\": {\n \"id\": \"%id1\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"%id1\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n }\n}"}},{"name":"GetDataItem","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Get existing item","request":"curl -X GET \\\n'https://www.wixapis.com/wix-data/v2/items/5331fc15-9441-4fd4-bc7b-7f6870c69228?dataCollectionId=cities' \\\n-H 'Authorization: ' \\","response":"{\n \"dataItem\": {\n \"id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Get Data Item","slugifiedName":"get-data-item"},"permissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}]},{"summary":"Remove Data Item","description":"Removes an item from a collection.\n\n\nIf any items in other collections reference the removed item in reference or multi-reference fields, those fields are cleared.\n\n> **Note:**\n> Once an item has been removed from a collection, it can't be restored.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.RemoveDataItem","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"dataItemId","description":"ID of the item to remove.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"dataCollectionId","in":"query","description":"ID of the collection from which to remove the item.","required":true,"schema":{"description":"ID of the collection from which to remove the item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"appOptions","in":"query","description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","required":false,"schema":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"publishPluginOptions","in":"query","description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","required":false,"schema":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.RemoveDataItemResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.REMOVE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.RemoveDataItemRequest","responseMessage":"com.wixpress.cloud.data.api.data.RemoveDataItemResponse"},"legacyExamples":[{"name":"RemoveDataItem","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Remove existing item","request":"curl -X DELETE \\\n'https://www.wixapis.com/wix-data/v2/items/5331fc15-9441-4fd4-bc7b-7f6870c69228?dataCollectionId=cities' \\\n-H 'Authorization: ' \\","response":"{\n \"dataItem\": {\n \"id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n }\n}"}},{"name":"RemoveDataItem","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Remove existing item with complex id","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/remove' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItemId\": \"%id1\"\n}'","response":"{\n \"dataItem\": {\n \"id\": \"%id1\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"%id1\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"delete","path":"/v2/items/{dataItemId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.REMOVE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.RemoveDataItemRequest","responseMessage":"com.wixpress.cloud.data.api.data.RemoveDataItemResponse"},"legacyExamples":[{"name":"RemoveDataItem","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Remove existing item","request":"curl -X DELETE \\\n'https://www.wixapis.com/wix-data/v2/items/5331fc15-9441-4fd4-bc7b-7f6870c69228?dataCollectionId=cities' \\\n-H 'Authorization: ' \\","response":"{\n \"dataItem\": {\n \"id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n }\n}"}},{"name":"RemoveDataItem","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Remove existing item with complex id","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/remove' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItemId\": \"%id1\"\n}'","response":"{\n \"dataItem\": {\n \"id\": \"%id1\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"%id1\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Remove Data Item","slugifiedName":"remove-data-item"},"permissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}]},{"summary":"Truncate Data Items","description":"Removes all items from a collection.\n\n\nIf any items in other collections reference the removed items in reference or multi-reference fields, those fields are cleared.\n\n> **Note:**\n> Once items have been removed from a collection, they can't be restored.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.TruncateDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.TruncateDataItemsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"TruncateDataItemsRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection to truncate.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.TRUNCATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.TruncateDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.TruncateDataItemsResponse"},"legacyExamples":[{"name":"TruncateDataItems","serviceName":"DataItemService","type":"METHOD","content":{"title":"Remove all items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/truncate' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\"\n}'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/items/truncate","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.TRUNCATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.TruncateDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.TruncateDataItemsResponse"},"legacyExamples":[{"name":"TruncateDataItems","serviceName":"DataItemService","type":"METHOD","content":{"title":"Remove all items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/truncate' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\"\n}'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Truncate Data Items","slugifiedName":"truncate-data-items"},"permissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}]},{"summary":"Query Data Items","description":"Retrieves a list of items, on the basis of the filtering, sorting, and paging preferences you provide.\n\n\nFor more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).","operationId":"com.wixpress.cloud.data.api.data.DataItemService.QueryDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.QueryDataItemsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryDataItemsRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection to query.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"query":{"description":"Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"Whether to return the total count in the response for a query with offset paging.\nWhen `true`, the `pagingMetadata` object in the response contains a `total` field.\n\nDefault: `false`","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includeReferencedItems":{"description":"Properties for which to include referenced items in the query's results.\nUp to 50 referenced items can be included for each item that matches the query.","title":"includeReferencedItems","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"replacedBy":"referenced_item_options","targetRemovalDate":"2025-08-01"}}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf provided, the result text is returned in the specified language.\n**Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n\nIf not provided, result text is not translated.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referencedItemOptions":{"description":"Options for retrieving referenced items.","maxItems":100,"title":"referencedItemOptions","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.QueryDataItemsRequest.ReferencedItemOptions"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.QUERY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.QueryDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.QueryDataItemsResponse"},"legacyExamples":[{"name":"QueryDataItems","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Query existing items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/query' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"query\": {\n \"filter\": {\n \"state\": \"California\"\n },\n \"paging\": {\n \"limit\": 2\n }\n }\n}'","response":"{\n \"dataItems\": [\n {\n \"id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n },\n {\n \"id\": \"9b05dd0f-b3b6-481f-a9af-97379f4c81bb\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"9b05dd0f-b3b6-481f-a9af-97379f4c81bb\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"San Francisco\",\n \"population\": 840000.0\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"tooManyToCount\": false,\n \"hasNext\": true\n }\n}"}},{"name":"QueryDataItems","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Query existing items with filter, sort, paging, projection and total count calculation","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/query' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"query\": {\n \"filter\": {\n \"state\": \"California\"\n },\n \"sort\": [\n {\n \"fieldName\": \"population\",\n \"order\": \"ASC\"\n }\n ],\n \"paging\": {\n \"limit\": 2\n },\n \"fields\": [\"population\"]\n },\n \"returnTotalCount\": true\n}'","response":"{\n \"dataItems\": [\n {\n \"id\": \"9b05dd0f-b3b6-481f-a9af-97379f4c81bb\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"population\": 840000.0\n }\n },\n {\n \"id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"population\": 3800000.0\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"total\": 4,\n \"tooManyToCount\": false,\n \"hasNext\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/items/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.QUERY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.QueryDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.QueryDataItemsResponse"},"legacyExamples":[{"name":"QueryDataItems","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Query existing items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/query' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"query\": {\n \"filter\": {\n \"state\": \"California\"\n },\n \"paging\": {\n \"limit\": 2\n }\n }\n}'","response":"{\n \"dataItems\": [\n {\n \"id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"Los Angeles\",\n \"population\": 3800000.0\n }\n },\n {\n \"id\": \"9b05dd0f-b3b6-481f-a9af-97379f4c81bb\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"9b05dd0f-b3b6-481f-a9af-97379f4c81bb\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"city\": \"San Francisco\",\n \"population\": 840000.0\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"tooManyToCount\": false,\n \"hasNext\": true\n }\n}"}},{"name":"QueryDataItems","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Query existing items with filter, sort, paging, projection and total count calculation","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/query' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"query\": {\n \"filter\": {\n \"state\": \"California\"\n },\n \"sort\": [\n {\n \"fieldName\": \"population\",\n \"order\": \"ASC\"\n }\n ],\n \"paging\": {\n \"limit\": 2\n },\n \"fields\": [\"population\"]\n },\n \"returnTotalCount\": true\n}'","response":"{\n \"dataItems\": [\n {\n \"id\": \"9b05dd0f-b3b6-481f-a9af-97379f4c81bb\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"population\": 840000.0\n }\n },\n {\n \"id\": \"5331fc15-9441-4fd4-bc7b-7f6870c69228\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"population\": 3800000.0\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"total\": 4,\n \"tooManyToCount\": false,\n \"hasNext\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Query Data Items","slugifiedName":"query-data-items"},"permissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}]},{"summary":"Aggregate Data Items","description":"Runs an aggregation on a data collection and returns the resulting list of items.\n\n\nAn aggregation enables you to perform certain calculations on your collection data, or on groups of items that you define, to retrieve meaningful summaries.\nYou can also add paging, filtering, and sorting preferences to your aggregation to retrieve exactly what you need.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.AggregateDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.AggregateDataItemsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"AggregateDataItemsRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection on which to run the aggregation.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initialFilter":{"description":"Filter applied to the collection's data prior to running the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object.\n\n**Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).","title":"initialFilter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregation":{"description":"Aggregation applied to the data.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation","summary":"aggregation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"finalFilter":{"description":"Filter applied to the processed data following the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object.\n**Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).","title":"finalFilter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"Whether to return the total count in the response for a query with offset paging.\nWhen `true`, the `pagingMetadata` object in the response contains a `total` field.\n\nDefault: `false`","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf provided, the result text is returned in the specified language.\n**Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n\nIf not provided, result text is not translated.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.pagingMethod"}],"required":["dataCollectionId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.AGGREGATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.AggregateDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.AggregateDataItemsResponse"},"legacyExamples":[{"name":"AggregateDataItems","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Calculate the total population in every state of year 2022 and return only those where population is greater than 1 million.","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/aggregate' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"initialFilter\": {\n \"year\": 2022\n },\n \"aggregation\": {\n \"groupingFields\": [\"state\"],\n \"operations\": [\n {\n \"resultFieldName\": \"totalPopulation\",\n \"sum\": {\n \"itemFieldName\": \"population\"\n }\n }\n ]\n },\n \"finalFilter\": {\n \"totalPopulation\": {\n \"$gt\": 1000000\n }\n },\n \"sort\": [\n {\n \"fieldName\": \"totalPopulation\",\n \"order\": \"ASC\"\n }\n ]\n}'","response":"{\n \"results\": [\n {\n \"_id\": {\n \"state\": \"New York\"\n },\n \"totalPopulation\": 20000000.0,\n \"state\": \"New York\"\n },\n {\n \"_id\": {\n \"state\":\"California\"\n },\n \"totalPopulation\": 39000000.0,\n \"state\":\"California\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"tooManyToCount\": false,\n \"hasNext\": false\n }\n}"}},{"name":"AggregateDataItems","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Calculate the sum of population in every state of year 2022","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/aggregate' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"initialFilter\": {\n \"year\": 2022\n },\n \"aggregation\": {\n \"groupingFields\": [\"state\"],\n \"operations\": [\n {\n \"resultFieldName\": \"totalPopulation\",\n \"sum\": {\n \"itemFieldName\": \"population\"\n }\n }\n ]\n }\n}'","response":"{\n \"results\": [\n {\n \"_id\": {\n \"state\": \"New York\"\n },\n \"totalPopulation\": 20000000.0,\n \"state\": \"New York\"\n },\n {\n \"_id\": {\n \"state\":\"California\"\n },\n \"totalPopulation\": 39000000.0,\n \"state\":\"California\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"tooManyToCount\": false,\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/items/aggregate","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.AGGREGATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.AggregateDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.AggregateDataItemsResponse"},"legacyExamples":[{"name":"AggregateDataItems","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Calculate the total population in every state of year 2022 and return only those where population is greater than 1 million.","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/aggregate' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"initialFilter\": {\n \"year\": 2022\n },\n \"aggregation\": {\n \"groupingFields\": [\"state\"],\n \"operations\": [\n {\n \"resultFieldName\": \"totalPopulation\",\n \"sum\": {\n \"itemFieldName\": \"population\"\n }\n }\n ]\n },\n \"finalFilter\": {\n \"totalPopulation\": {\n \"$gt\": 1000000\n }\n },\n \"sort\": [\n {\n \"fieldName\": \"totalPopulation\",\n \"order\": \"ASC\"\n }\n ]\n}'","response":"{\n \"results\": [\n {\n \"_id\": {\n \"state\": \"New York\"\n },\n \"totalPopulation\": 20000000.0,\n \"state\": \"New York\"\n },\n {\n \"_id\": {\n \"state\":\"California\"\n },\n \"totalPopulation\": 39000000.0,\n \"state\":\"California\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"tooManyToCount\": false,\n \"hasNext\": false\n }\n}"}},{"name":"AggregateDataItems","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Calculate the sum of population in every state of year 2022","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/aggregate' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"initialFilter\": {\n \"year\": 2022\n },\n \"aggregation\": {\n \"groupingFields\": [\"state\"],\n \"operations\": [\n {\n \"resultFieldName\": \"totalPopulation\",\n \"sum\": {\n \"itemFieldName\": \"population\"\n }\n }\n ]\n }\n}'","response":"{\n \"results\": [\n {\n \"_id\": {\n \"state\": \"New York\"\n },\n \"totalPopulation\": 20000000.0,\n \"state\": \"New York\"\n },\n {\n \"_id\": {\n \"state\":\"California\"\n },\n \"totalPopulation\": 39000000.0,\n \"state\":\"California\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"tooManyToCount\": false,\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Aggregate Data Items","slugifiedName":"aggregate-data-items"},"permissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}]},{"summary":"Count Data Items","description":"Counts the number of items in a data collection that match the provided filtering preferences.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.CountDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.CountDataItemsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CountDataItemsRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection for which to count query results.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filter":{"description":"Filter object in the following format:\n\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`.\n\nExamples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.\n\n**Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf provided, the result text is returned in the specified language.\n**Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n\nIf not provided, result text is not translated.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.COUNT"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.CountDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.CountDataItemsResponse"},"legacyExamples":[{"name":"CountDataItems","serviceName":"DataItemService","type":"METHOD","content":{"title":"Count items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/count' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"filter\": {\n \"state\": \"California\"\n }\n}'","response":"{\n \"totalCount\": 4\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/items/count","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.COUNT"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.CountDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.CountDataItemsResponse"},"legacyExamples":[{"name":"CountDataItems","serviceName":"DataItemService","type":"METHOD","content":{"title":"Count items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/count' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"filter\": {\n \"state\": \"California\"\n }\n}'","response":"{\n \"totalCount\": 4\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Count Data Items","slugifiedName":"count-data-items"},"permissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}]},{"summary":"Query Distinct Values","description":"Retrieves a list of distinct values for a given field in all items that match a query, without duplicates.\n\n\nAs with the [Query Data Items](https://dev.wix.com/api/rest/wix-data/wix-data/data-items/query-data-items) endpoint, this endpoint retrieves items based on the filtering, sorting, and paging preferences you provide.\nHowever, the Query Distinct Values endpoint doesn't return all of the full items that match the query.\nRather, it returns all unique values of the field you specify in `fieldName` for items that match the query.\nIf more than one item has the same value for that field, that value appears only once.\n\nFor more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).","operationId":"com.wixpress.cloud.data.api.data.DataItemService.QueryDistinctValues","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.QueryDistinctValuesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryDistinctValuesRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection to query.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldName":{"description":"Item field name for which to return all distinct values.","title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filter":{"description":"Filter object in the following format:\n\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`.\n\nExamples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.\n\n**Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"Whether to return the total count in the response for a query with offset paging.\nWhen `true`, the `pagingMetadata` object in the response contains a `total` field.\n\nDefault: `false`","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf provided, the result text is returned in the specified language.\n**Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n\nIf not provided, result text is not translated.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.QueryDistinctValuesRequest.pagingMethod"}],"required":["dataCollectionId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.QUERY_DISTINCT_VALUES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.QueryDistinctValuesRequest","responseMessage":"com.wixpress.cloud.data.api.data.QueryDistinctValuesResponse"},"legacyExamples":[{"name":"QueryDistinctValues","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Query filtered distinct cities sorted in ascending order, calculate the total count of the result set.","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/query-distinct-values' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"fieldName\": \"city\",\n \"filter\": {\n \"state\": \"California\"\n },\n \"order\": \"ASC\",\n \"returnTotalCount\": true\n}'","response":"{\n \"distinctValues\": [\"Los Angeles\", \"San Francisco\"],\n \"pagingMetadata\": {\n \"count\": 2,\n \"total\": 2,\n \"tooManyToCount\": false,\n \"hasNext\": false\n }\n}"}},{"name":"QueryDistinctValues","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Query distinct cities","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/query-distinct-values' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"fieldName\": \"city\"\n}'","response":"{\n \"distinctValues\": [\"San Francisco\", \"Los Angeles\"],\n \"pagingMetadata\": {\n \"count\": 2,\n \"tooManyToCount\": false,\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/items/query-distinct-values","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.QUERY_DISTINCT_VALUES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.QueryDistinctValuesRequest","responseMessage":"com.wixpress.cloud.data.api.data.QueryDistinctValuesResponse"},"legacyExamples":[{"name":"QueryDistinctValues","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Query filtered distinct cities sorted in ascending order, calculate the total count of the result set.","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/query-distinct-values' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"fieldName\": \"city\",\n \"filter\": {\n \"state\": \"California\"\n },\n \"order\": \"ASC\",\n \"returnTotalCount\": true\n}'","response":"{\n \"distinctValues\": [\"Los Angeles\", \"San Francisco\"],\n \"pagingMetadata\": {\n \"count\": 2,\n \"total\": 2,\n \"tooManyToCount\": false,\n \"hasNext\": false\n }\n}"}},{"name":"QueryDistinctValues","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Query distinct cities","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/query-distinct-values' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"fieldName\": \"city\"\n}'","response":"{\n \"distinctValues\": [\"San Francisco\", \"Los Angeles\"],\n \"pagingMetadata\": {\n \"count\": 2,\n \"tooManyToCount\": false,\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Query Distinct Values","slugifiedName":"query-distinct-values"},"permissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}]},{"summary":"Bulk Insert Data Items","description":"Adds multiple items to a collection.\n\n\nWhen each item is inserted into a collection, its ID is automatically assigned a random value.\nYou can optionally provide your own ID when inserting the item. If you specify an ID that already exists in the collection, the insertion will fail.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.BulkInsertDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.BulkInsertDataItemsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkInsertDataItemsRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection in which to insert the items.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItems":{"description":"Data items to insert.","title":"dataItems","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the inserted data items.\nWhen `true`, the `results` objects contain a `dataItem` field.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId","dataItems"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.BULK_INSERT"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.BulkInsertDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.BulkInsertDataItemsResponse"},"legacyExamples":[{"name":"BulkInsertDataItems","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Bulk insert new items and return inserted items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/insert' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItems\": [\n {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n },\n {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"San Francisco\",\n \"population\": 840000\n }\n }\n ],\n \"returnEntity\": true\n}'","response":"{\n \"results\": [\n {\n \"action\": \"INSERT\",\n \"itemMetadata\": {\n \"id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"dataItem\": {\n \"id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"_createdDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"city\": \"Los Angeles\",\n \"state\": \"California\",\n \"population\": 3800000.0,\n \"year\": 2022.0\n }\n }\n },\n {\n \"action\": \"INSERT\",\n \"itemMetadata\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"dataItem\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"_createdDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"city\": \"San Francisco\",\n \"state\": \"California\",\n \"population\": 840000.0,\n \"year\": 2022.0\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}},{"name":"BulkInsertDataItems","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Bulk insert new items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/insert' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItems\": [\n {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n },\n {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"San Francisco\",\n \"population\": 840000\n }\n }\n ]\n}'","response":"{\n \"results\": [\n {\n \"action\": \"INSERT\",\n \"itemMetadata\": {\n \"id\": \"aa019290-b546-4b3e-b302-8f6474baedf9\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"action\": \"INSERT\",\n \"itemMetadata\": {\n \"id\": \"39cbd938-7b42-4e33-8acf-ff1ce278664c\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/bulk/items/insert","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.BULK_INSERT"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.BulkInsertDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.BulkInsertDataItemsResponse"},"legacyExamples":[{"name":"BulkInsertDataItems","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Bulk insert new items and return inserted items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/insert' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItems\": [\n {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n },\n {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"San Francisco\",\n \"population\": 840000\n }\n }\n ],\n \"returnEntity\": true\n}'","response":"{\n \"results\": [\n {\n \"action\": \"INSERT\",\n \"itemMetadata\": {\n \"id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"dataItem\": {\n \"id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"_createdDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"city\": \"Los Angeles\",\n \"state\": \"California\",\n \"population\": 3800000.0,\n \"year\": 2022.0\n }\n }\n },\n {\n \"action\": \"INSERT\",\n \"itemMetadata\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"dataItem\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"_createdDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"city\": \"San Francisco\",\n \"state\": \"California\",\n \"population\": 840000.0,\n \"year\": 2022.0\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}},{"name":"BulkInsertDataItems","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Bulk insert new items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/insert' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItems\": [\n {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n },\n {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"San Francisco\",\n \"population\": 840000\n }\n }\n ]\n}'","response":"{\n \"results\": [\n {\n \"action\": \"INSERT\",\n \"itemMetadata\": {\n \"id\": \"aa019290-b546-4b3e-b302-8f6474baedf9\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"action\": \"INSERT\",\n \"itemMetadata\": {\n \"id\": \"39cbd938-7b42-4e33-8acf-ff1ce278664c\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Bulk Insert Data Items","slugifiedName":"bulk-insert-data-items"},"permissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}]},{"summary":"Bulk Update Data Items","description":"Updates multiple items in a collection.\n\n\nThis endpoint replaces each specified data item's existing data with the payload provided in the request.\n\nEach item in the request must include an ID. If an item is found in the specified collection with\nthe same ID, that item is updated. If the collection doesn't contain an item with that ID, the update fails.\n\nWhen an item is updated, its `data._updatedDate` field is changed to the current date and time.\n\n> **Note:**\n> After each item is updated, it only contains the fields included in the request. If the existing item has fields with values and those fields\n> aren't included in the updated item, their values are lost.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.BulkUpdateDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.BulkUpdateDataItemsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateDataItemsRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection in which to update items.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItems":{"description":"Data items to update.","title":"dataItems","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the updated data items.\nWhen `true`, the `results` objects contain a `dataItem` field.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId","dataItems"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.BULK_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.BulkUpdateDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.BulkUpdateDataItemsResponse"},"legacyExamples":[{"name":"BulkUpdateDataItems","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Bulk update existing items and return updated items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/update' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItems\": [\n {\n \"id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n },\n {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"San Francisco\",\n \"population\": 840000\n }\n }\n ],\n \"returnEntity\": true\n}'","response":"{\n \"results\": [\n {\n \"action\": \"UPDATE\",\n \"itemMetadata\": {\n \"id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"dataItem\": {\n \"id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"city\": \"Los Angeles\",\n \"state\": \"California\",\n \"population\": 3800000.0,\n \"year\": 2022.0\n }\n }\n },\n {\n \"action\": \"UPDATE\",\n \"itemMetadata\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"dataItem\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"city\": \"San Francisco\",\n \"state\": \"California\",\n \"population\": 840000.0,\n \"year\": 2022.0\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}},{"name":"BulkUpdateDataItems","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Bulk update existing items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/update' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItems\": [\n {\n \"id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n },\n {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"San Francisco\",\n \"population\": 840000\n }\n }\n ]\n}'","response":"{\n \"results\": [\n {\n \"action\": \"UPDATE\",\n \"itemMetadata\": {\n \"id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"action\": \"UPDATE\",\n \"itemMetadata\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/bulk/items/update","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.BULK_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.BulkUpdateDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.BulkUpdateDataItemsResponse"},"legacyExamples":[{"name":"BulkUpdateDataItems","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Bulk update existing items and return updated items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/update' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItems\": [\n {\n \"id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n },\n {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"San Francisco\",\n \"population\": 840000\n }\n }\n ],\n \"returnEntity\": true\n}'","response":"{\n \"results\": [\n {\n \"action\": \"UPDATE\",\n \"itemMetadata\": {\n \"id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"dataItem\": {\n \"id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"city\": \"Los Angeles\",\n \"state\": \"California\",\n \"population\": 3800000.0,\n \"year\": 2022.0\n }\n }\n },\n {\n \"action\": \"UPDATE\",\n \"itemMetadata\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"dataItem\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"city\": \"San Francisco\",\n \"state\": \"California\",\n \"population\": 840000.0,\n \"year\": 2022.0\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}},{"name":"BulkUpdateDataItems","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Bulk update existing items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/update' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItems\": [\n {\n \"id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n },\n {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"San Francisco\",\n \"population\": 840000\n }\n }\n ]\n}'","response":"{\n \"results\": [\n {\n \"action\": \"UPDATE\",\n \"itemMetadata\": {\n \"id\": \"40877d18-c5fe-4ed5-b495-d84bb4c027bd\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"action\": \"UPDATE\",\n \"itemMetadata\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Bulk Update Data Items","slugifiedName":"bulk-update-data-items"},"permissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}]},{"summary":"Bulk Save Data Items","description":"Inserts or updates multiple items in a collection.\n\n\nThe Bulk Save Data Items endpoint inserts or updates each item provided, depending on whether it already exists in the collection. For each item:\n\n+ If you don't provide an ID, a new item is created.\n\n+ If you provide an ID that doesn't exist in the collection, a new item is created with that ID.\n\n+ If an item with the ID you provide already exists in the collection, that item is updated. When an item is updated, its `data._updatedDate` field is changed to the current date and time.\n\n> **Note:** When you provide an item with an ID that already exists in the collection, the item you provide completely replaces the existing item with that ID.\n> This means that all of the item's previous fields and values are lost.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.BulkSaveDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.BulkSaveDataItemsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkSaveDataItemsRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection in which to insert or update the items.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItems":{"description":"Data items to insert or update.","title":"dataItems","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the saved data item.\nWhen `true`, the `results` objects contain a `dataItem` field.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId","dataItems"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.BULK_SAVE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.BulkSaveDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.BulkSaveDataItemsResponse"},"legacyExamples":[{"name":"BulkSaveDataItems","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Bulk save new items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/save' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItems\": [\n {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n },\n {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"San Francisco\",\n \"population\": 840000\n }\n }\n ]\n}'","response":"{\n \"results\": [\n {\n \"action\": \"INSERT\",\n \"itemMetadata\": {\n \"id\": \"aa019290-b546-4b3e-b302-8f6474baedf9\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"action\": \"INSERT\",\n \"itemMetadata\": {\n \"id\": \"39cbd938-7b42-4e33-8acf-ff1ce278664c\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}},{"name":"BulkSaveDataItems","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Bulk save new items by inserting first one and updating another","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/save' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItems\": [\n {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n },\n {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"San Francisco\",\n \"population\": 840000\n }\n }\n ],\n \"returnEntity\": true\n}'","response":"{\n \"results\": [\n {\n \"action\": \"INSERT\",\n \"itemMetadata\": {\n \"id\": \"6d717171-6f4d-4794-b6ea-7aea0071a76b\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"dataItem\": {\n \"id\": \"6d717171-6f4d-4794-b6ea-7aea0071a76b\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"6d717171-6f4d-4794-b6ea-7aea0071a76b\",\n \"_createdDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"city\": \"Los Angeles\",\n \"state\": \"California\",\n \"population\": 3800000.0,\n \"year\": 2022.0\n }\n }\n },\n {\n \"action\": \"UPDATE\",\n \"itemMetadata\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"dataItem\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"city\": \"San Francisco\",\n \"state\": \"California\",\n \"population\": 840000.0,\n \"year\": 2022.0\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\":2,\n \"totalFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/bulk/items/save","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.BULK_SAVE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.BulkSaveDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.BulkSaveDataItemsResponse"},"legacyExamples":[{"name":"BulkSaveDataItems","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Bulk save new items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/save' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItems\": [\n {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n },\n {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"San Francisco\",\n \"population\": 840000\n }\n }\n ]\n}'","response":"{\n \"results\": [\n {\n \"action\": \"INSERT\",\n \"itemMetadata\": {\n \"id\": \"aa019290-b546-4b3e-b302-8f6474baedf9\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"action\": \"INSERT\",\n \"itemMetadata\": {\n \"id\": \"39cbd938-7b42-4e33-8acf-ff1ce278664c\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}},{"name":"BulkSaveDataItems","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Bulk save new items by inserting first one and updating another","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/save' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItems\": [\n {\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"Los Angeles\",\n \"population\": 3800000\n }\n },\n {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"data\": {\n \"state\": \"California\",\n \"year\": 2022,\n \"city\": \"San Francisco\",\n \"population\": 840000\n }\n }\n ],\n \"returnEntity\": true\n}'","response":"{\n \"results\": [\n {\n \"action\": \"INSERT\",\n \"itemMetadata\": {\n \"id\": \"6d717171-6f4d-4794-b6ea-7aea0071a76b\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"dataItem\": {\n \"id\": \"6d717171-6f4d-4794-b6ea-7aea0071a76b\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"6d717171-6f4d-4794-b6ea-7aea0071a76b\",\n \"_createdDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"city\": \"Los Angeles\",\n \"state\": \"California\",\n \"population\": 3800000.0,\n \"year\": 2022.0\n }\n }\n },\n {\n \"action\": \"UPDATE\",\n \"itemMetadata\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"dataItem\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T13:24:45.845Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"city\": \"San Francisco\",\n \"state\": \"California\",\n \"population\": 840000.0,\n \"year\": 2022.0\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\":2,\n \"totalFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Bulk Save Data Items","slugifiedName":"bulk-save-data-items"},"permissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}]},{"summary":"Bulk Remove Data Items","description":"Removes multiple items from a collection.\n\n\nIf any items in other collections reference the removed items in reference or multi-reference fields, those fields are cleared.\n\n> **Note:** Once an item has been removed from a collection, it can't be restored.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.BulkRemoveDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.BulkRemoveDataItemsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkRemoveDataItemsRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection from which to remove the item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItemIds":{"description":"IDs of data items to remove.","title":"dataItemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId","dataItemIds"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.BULK_REMOVE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.BulkRemoveDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.BulkRemoveDataItemsResponse"},"legacyExamples":[{"name":"BulkRemoveDataItems","serviceName":"DataItemService","type":"METHOD","content":{"title":"Bulk remove existing items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/remove' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItemIds\": [\n \"6d717171-6f4d-4794-b6ea-7aea0071a76b\",\n \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\"\n ]\n}'","response":"{\n \"results\": [\n {\n \"action\":\"DELETE\",\n \"itemMetadata\": {\n \"id\": \"6d717171-6f4d-4794-b6ea-7aea0071a76b\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"action\": \"DELETE\",\n \"itemMetadata\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/bulk/items/remove","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.BULK_REMOVE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.BulkRemoveDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.BulkRemoveDataItemsResponse"},"legacyExamples":[{"name":"BulkRemoveDataItems","serviceName":"DataItemService","type":"METHOD","content":{"title":"Bulk remove existing items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/remove' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"cities\",\n \"dataItemIds\": [\n \"6d717171-6f4d-4794-b6ea-7aea0071a76b\",\n \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\"\n ]\n}'","response":"{\n \"results\": [\n {\n \"action\":\"DELETE\",\n \"itemMetadata\": {\n \"id\": \"6d717171-6f4d-4794-b6ea-7aea0071a76b\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"action\": \"DELETE\",\n \"itemMetadata\": {\n \"id\": \"6c38b4f7-7b8d-4702-9283-66a5889f8e17\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Bulk Remove Data Items","slugifiedName":"bulk-remove-data-items"},"permissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}]},{"summary":"Query Referenced Data Items","description":"Retrieves the full items referenced in the specified field of an item.\n\n\nReference and multi-reference fields refer to items in different collections.\nUse this endpoint to retrieve the full details of the referenced items themselves.\n\nFor example, suppose you have a **Movies** collection with an **Actors** field that contains references to items in a **People** collection.\nQuerying the **Movies** collection using the Query Referenced Data Items endpoint returns the relevant **People** items referenced in the **Actors** field of the specified **Movie** item.\nThis gives you information from the **People** collection about each of the actors in the specified movie.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.QueryReferencedDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.QueryReferencedDataItemsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryReferencedDataItemsRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection containing the referring item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemId":{"description":"ID of the referring item.","title":"referringItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemFieldName":{"description":"Field containing references in the referring item.","title":"referringItemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Order of the returned referenced items. Sorted by the date each item was referenced.","title":"order","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"Whether to return the total count in the response.\nWhen `true`, the `pagingMetadata` object in the response contains a `total` field.\n\nDefault: `false`","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf provided, the result text is returned in the specified language.\n**Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n\nIf not provided, result text is not translated.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to return for each referenced item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\n**Note:** The `_id` system field is always returned.","maxItems":10000,"maxLength":1000,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.QueryReferencedDataItemsRequest.pagingMethod"}],"required":["dataCollectionId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.QUERY_REFERENCED"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.QueryReferencedDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.QueryReferencedDataItemsResponse"},"legacyExamples":[{"name":"QueryReferencedDataItems","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Query referenced items, order by reference creation date and return only the first one","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/query-referenced' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"order\": \"ASC\",\n \"paging\": {\n \"limit\": 1\n }\n}'","response":"{\n \"results\": [\n {\n \"dataItem\": {\n \"id\": \"99cb26d5-dd42-4384-af30-3bb6e4026bd0\",\n \"dataCollectionId\": \"songs\",\n \"data\": {\n \"_id\": \"99cb26d5-dd42-4384-af30-3bb6e4026bd0\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"title\": \"I Should Have Known Better\"\n }\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1\n }\n}"}},{"name":"QueryReferencedDataItems","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Query referenced items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/query-referenced' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\"\n}'","response":"{\n \"results\": [\n {\n \"dataItem\": {\n \"id\": \"99cb26d5-dd42-4384-af30-3bb6e4026bd0\",\n \"dataCollectionId\": \"songs\",\n \"data\": {\n \"_id\": \"99cb26d5-dd42-4384-af30-3bb6e4026bd0\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"title\":\"I Should Have Known Better\"\n }\n }\n },\n {\n \"dataItem\": {\n \"id\": \"b10170b2-2e0d-4093-b472-cf8f2982a247\",\n \"dataCollectionId\": \"songs\",\n \"data\": {\n \"_id\": \"b10170b2-2e0d-4093-b472-cf8f2982a247\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"title\": \"If I Fell\"\n }\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/items/query-referenced","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.QUERY_REFERENCED"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.QueryReferencedDataItemsRequest","responseMessage":"com.wixpress.cloud.data.api.data.QueryReferencedDataItemsResponse"},"legacyExamples":[{"name":"QueryReferencedDataItems","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Query referenced items, order by reference creation date and return only the first one","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/query-referenced' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"order\": \"ASC\",\n \"paging\": {\n \"limit\": 1\n }\n}'","response":"{\n \"results\": [\n {\n \"dataItem\": {\n \"id\": \"99cb26d5-dd42-4384-af30-3bb6e4026bd0\",\n \"dataCollectionId\": \"songs\",\n \"data\": {\n \"_id\": \"99cb26d5-dd42-4384-af30-3bb6e4026bd0\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"title\": \"I Should Have Known Better\"\n }\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1\n }\n}"}},{"name":"QueryReferencedDataItems","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Query referenced items","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/query-referenced' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\"\n}'","response":"{\n \"results\": [\n {\n \"dataItem\": {\n \"id\": \"99cb26d5-dd42-4384-af30-3bb6e4026bd0\",\n \"dataCollectionId\": \"songs\",\n \"data\": {\n \"_id\": \"99cb26d5-dd42-4384-af30-3bb6e4026bd0\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"title\":\"I Should Have Known Better\"\n }\n }\n },\n {\n \"dataItem\": {\n \"id\": \"b10170b2-2e0d-4093-b472-cf8f2982a247\",\n \"dataCollectionId\": \"songs\",\n \"data\": {\n \"_id\": \"b10170b2-2e0d-4093-b472-cf8f2982a247\",\n \"_createdDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_updatedDate\": { \"$date\": \"2023-03-28T12:20:43.745Z\" },\n \"_owner\": \"690264f5-29a0-4aa8-a9b5-0842fc5ab360\",\n \"title\": \"If I Fell\"\n }\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Query Referenced Data Items","slugifiedName":"query-referenced-data-items"},"permissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}]},{"summary":"Is Referenced Data Item","description":"Checks whether a field in a referring item contains a reference to a specified item.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.IsReferencedDataItem","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.IsReferencedDataItemResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"IsReferencedDataItemRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection containing the referring data item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemFieldName":{"description":"Field to check for a reference to the item that may be referenced.","title":"referringItemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemId":{"description":"ID of the referring item.","title":"referringItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referencedItemId":{"description":"ID of the item that may be referenced.","title":"referencedItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId","referringItemFieldName","referringItemId","referencedItemId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.IS_REFERENCED"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.IsReferencedDataItemRequest","responseMessage":"com.wixpress.cloud.data.api.data.IsReferencedDataItemResponse"},"legacyExamples":[{"name":"IsReferencedDataItem","serviceName":"DataItemService","type":"METHOD","content":{"title":"Is item referenced","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/is-referenced' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"99cb26d5-dd42-4384-af30-3bb6e4026bd0\"\n}'","response":"{\n \"isReferenced\": true\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/items/is-referenced","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.IS_REFERENCED"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.IsReferencedDataItemRequest","responseMessage":"com.wixpress.cloud.data.api.data.IsReferencedDataItemResponse"},"legacyExamples":[{"name":"IsReferencedDataItem","serviceName":"DataItemService","type":"METHOD","content":{"title":"Is item referenced","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/is-referenced' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"99cb26d5-dd42-4384-af30-3bb6e4026bd0\"\n}'","response":"{\n \"isReferenced\": true\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Is Referenced Data Item","slugifiedName":"is-referenced-data-item"},"permissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}]},{"summary":"Insert Data Item Reference","description":"Inserts a reference in the specified field in an item in a collection.\n\n\nA reference in the `dataItemReference` field specifies a referring item's ID, the field in which to insert the reference, and the ID of the referenced item.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.InsertDataItemReference","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.InsertDataItemReferenceResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"InsertDataItemReferenceRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection in which to insert the reference.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItemReference":{"description":"Reference to insert","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItemReference","summary":"dataItemReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId","dataItemReference.referringItemFieldName","dataItemReference.referringItemId","dataItemReference.referencedItemId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.INSERT_REFERENCE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.InsertDataItemReferenceRequest","responseMessage":"com.wixpress.cloud.data.api.data.InsertDataItemReferenceResponse"},"legacyExamples":[{"name":"InsertDataItemReference","serviceName":"DataItemService","type":"METHOD","content":{"title":"Insert item reference","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/insert-reference' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"dataItemReference\": {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n }\n}'","response":"{\n \"dataItemReference\": {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/items/insert-reference","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.INSERT_REFERENCE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.InsertDataItemReferenceRequest","responseMessage":"com.wixpress.cloud.data.api.data.InsertDataItemReferenceResponse"},"legacyExamples":[{"name":"InsertDataItemReference","serviceName":"DataItemService","type":"METHOD","content":{"title":"Insert item reference","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/insert-reference' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"dataItemReference\": {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n }\n}'","response":"{\n \"dataItemReference\": {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Insert Data Item Reference","slugifiedName":"insert-data-item-reference"},"permissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}]},{"summary":"Remove Data Item Reference","description":"Removes the specified reference from the specified field.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.RemoveDataItemReference","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.RemoveDataItemReferenceResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"RemoveDataItemReferenceRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection containing the referring item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItemReference":{"description":"Reference to remove.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItemReference","summary":"dataItemReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId","dataItemReference","dataItemReference.referringItemFieldName","dataItemReference.referringItemId","dataItemReference.referencedItemId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.REMOVE_REFERENCE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.RemoveDataItemReferenceRequest","responseMessage":"com.wixpress.cloud.data.api.data.RemoveDataItemReferenceResponse"},"legacyExamples":[{"name":"RemoveDataItemReference","serviceName":"DataItemService","type":"METHOD","content":{"title":"Remove item reference","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/remove-reference' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"dataItemReference\": {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n }\n}'","response":"{\n \"dataItemReference\": {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/items/remove-reference","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.REMOVE_REFERENCE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.RemoveDataItemReferenceRequest","responseMessage":"com.wixpress.cloud.data.api.data.RemoveDataItemReferenceResponse"},"legacyExamples":[{"name":"RemoveDataItemReference","serviceName":"DataItemService","type":"METHOD","content":{"title":"Remove item reference","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/remove-reference' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"dataItemReference\": {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n }\n}'","response":"{\n \"dataItemReference\": {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Remove Data Item Reference","slugifiedName":"remove-data-item-reference"},"permissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}]},{"summary":"Bulk Insert Data Item References","description":"Inserts one or more references in the specified fields of items in a collection.\n\n\nThis endpoint adds one or more references to a collection.\nEach new reference in the `dataItemReferences` field specifies a referring item's ID, the field in which to insert the reference, and the ID of the referenced item.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.BulkInsertDataItemReferences","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.BulkInsertDataItemReferencesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkInsertDataItemReferencesRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection containing the referring items.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItemReferences":{"description":"References to insert.","title":"dataItemReferences","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the inserted data item references.\nWhen `true`, the `results` objects contain a `dataItemReference` field.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId","dataItemReferences","dataItemReferences.referringItemFieldName","dataItemReferences.referringItemId","dataItemReferences.referencedItemId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.BULK_INSERT_REFERENCES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.BulkInsertDataItemReferencesRequest","responseMessage":"com.wixpress.cloud.data.api.data.BulkInsertDataItemReferencesResponse"},"legacyExamples":[{"name":"BulkInsertDataItemReferences","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Bulk insert references and return inserted result","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/insert-references' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"dataItemReferences\": [\n {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n },\n {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"e7fe3827-5102-470a-a10a-b6221dd0b4a9\"\n }\n ],\n \"returnEntity\": true\n}'","response":"{\n \"results\": [\n {\n \"action\": \"INSERT\",\n \"referenceMetadata\": {\n \"originalIndex\": 0,\n \"success\": true\n },\n \"dataItemReference\": {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n }\n },\n {\n \"action\": \"INSERT\",\n \"referenceMetadata\": {\n \"originalIndex\": 1,\n \"success\": true\n },\n \"dataItemReference\": {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"e7fe3827-5102-470a-a10a-b6221dd0b4a9\"\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\":0\n }\n}"}},{"name":"BulkInsertDataItemReferences","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Bulk insert references","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/insert-references' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"dataItemReferences\": [\n {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n },\n {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"e7fe3827-5102-470a-a10a-b6221dd0b4a9\"\n }\n ]\n}'","response":"{\n \"results\": [\n {\n \"action\": \"INSERT\",\n \"referenceMetadata\": {\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"action\": \"INSERT\",\n \"referenceMetadata\": {\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/bulk/items/insert-references","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.BULK_INSERT_REFERENCES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.BulkInsertDataItemReferencesRequest","responseMessage":"com.wixpress.cloud.data.api.data.BulkInsertDataItemReferencesResponse"},"legacyExamples":[{"name":"BulkInsertDataItemReferences","serviceName":"DataItemService","type":"METHOD","order":2,"content":{"title":"Bulk insert references and return inserted result","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/insert-references' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"dataItemReferences\": [\n {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n },\n {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"e7fe3827-5102-470a-a10a-b6221dd0b4a9\"\n }\n ],\n \"returnEntity\": true\n}'","response":"{\n \"results\": [\n {\n \"action\": \"INSERT\",\n \"referenceMetadata\": {\n \"originalIndex\": 0,\n \"success\": true\n },\n \"dataItemReference\": {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n }\n },\n {\n \"action\": \"INSERT\",\n \"referenceMetadata\": {\n \"originalIndex\": 1,\n \"success\": true\n },\n \"dataItemReference\": {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"e7fe3827-5102-470a-a10a-b6221dd0b4a9\"\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\":0\n }\n}"}},{"name":"BulkInsertDataItemReferences","serviceName":"DataItemService","type":"METHOD","order":1,"content":{"title":"Bulk insert references","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/insert-references' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"dataItemReferences\": [\n {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n },\n {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"e7fe3827-5102-470a-a10a-b6221dd0b4a9\"\n }\n ]\n}'","response":"{\n \"results\": [\n {\n \"action\": \"INSERT\",\n \"referenceMetadata\": {\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"action\": \"INSERT\",\n \"referenceMetadata\": {\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Bulk Insert Data Item References","slugifiedName":"bulk-insert-data-item-references"},"permissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}]},{"summary":"Bulk Remove Data Item References","description":"Removes one or more references.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.BulkRemoveDataItemReferences","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.BulkRemoveDataItemReferencesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkRemoveDataItemReferencesRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection containing the referring items.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItemReferences":{"description":"References to remove.","title":"dataItemReferences","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId","dataItemReferences","dataItemReferences.referringItemFieldName","dataItemReferences.referringItemId","dataItemReferences.referencedItemId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.BULK_REMOVE_REFERENCES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.BulkRemoveDataItemReferencesRequest","responseMessage":"com.wixpress.cloud.data.api.data.BulkRemoveDataItemReferencesResponse"},"legacyExamples":[{"name":"BulkRemoveDataItemReferences","serviceName":"DataItemService","type":"METHOD","content":{"title":"Bulk remove references","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/remove-references' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"dataItemReferences\": [\n {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n },\n {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"e7fe3827-5102-470a-a10a-b6221dd0b4a9\"\n }\n ]\n}'","response":"{\n \"results\": [\n {\n \"action\": \"DELETE\",\n \"referenceMetadata\": {\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"action\": \"DELETE\",\n \"referenceMetadata\": {\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/bulk/items/remove-references","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.BULK_REMOVE_REFERENCES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.BulkRemoveDataItemReferencesRequest","responseMessage":"com.wixpress.cloud.data.api.data.BulkRemoveDataItemReferencesResponse"},"legacyExamples":[{"name":"BulkRemoveDataItemReferences","serviceName":"DataItemService","type":"METHOD","content":{"title":"Bulk remove references","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/bulk/items/remove-references' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"dataItemReferences\": [\n {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n },\n {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"e7fe3827-5102-470a-a10a-b6221dd0b4a9\"\n }\n ]\n}'","response":"{\n \"results\": [\n {\n \"action\": \"DELETE\",\n \"referenceMetadata\": {\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"action\": \"DELETE\",\n \"referenceMetadata\": {\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Bulk Remove Data Item References","slugifiedName":"bulk-remove-data-item-references"},"permissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}]},{"summary":"Replace Data Item References","description":"Replaces references in a specified field of a specified data item.\n\n\nThis endpoint replaces the existing reference or references contained in the field specified in `referringItemFieldName` within the data item specified in `referringItemId`.\nThe endpoint removes existing references and in their place it adds references to the items specified in `newReferencedItemIds`.\n\n> **Note:** If you pass an empty array in `newReferencedItemIds`, all existing references are removed.","operationId":"com.wixpress.cloud.data.api.data.DataItemService.ReplaceDataItemReferences","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.ReplaceDataItemReferencesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2","destinationPath":"/v2","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ReplaceDataItemReferencesRequest","description":"","properties":{"dataCollectionId":{"description":"ID of the collection containing the referring item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemFieldName":{"description":"Field containing references in the referring item.","title":"referringItemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemId":{"description":"ID of the referring item.","title":"referringItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newReferencedItemIds":{"description":"List of new referenced item IDs to replace the existing ones.","title":"newReferencedItemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dataCollectionId","referringItemFieldName","referringItemId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.REPLACE_REFERENCES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.ReplaceDataItemReferencesRequest","responseMessage":"com.wixpress.cloud.data.api.data.ReplaceDataItemReferencesResponse"},"legacyExamples":[{"name":"ReplaceDataItemReferences","serviceName":"DataItemService","type":"METHOD","content":{"title":"Replace existing references with new references","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/replace-references' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"newReferencedItemIds\": [\"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"]\n}'","response":"{\n \"dataItemReferences\": [\n {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/items/replace-references","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.data.DataItemService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_DATA.REPLACE_REFERENCES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.data.ReplaceDataItemReferencesRequest","responseMessage":"com.wixpress.cloud.data.api.data.ReplaceDataItemReferencesResponse"},"legacyExamples":[{"name":"ReplaceDataItemReferences","serviceName":"DataItemService","type":"METHOD","content":{"title":"Replace existing references with new references","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/items/replace-references' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"dataCollectionId\": \"albums\",\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"newReferencedItemIds\": [\"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"]\n}'","response":"{\n \"dataItemReferences\": [\n {\n \"referringItemFieldName\": \"songs\",\n \"referringItemId\": \"37de298e-026d-4b2e-b87f-fbec11d53105\",\n \"referencedItemId\": \"aafeaaf4-6192-4cc2-a79b-97ce0f1b3646\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Replace Data Item References","slugifiedName":"replace-data-item-references"},"permissionScopes":[{"name":"Write Data Items","scopeId":"SCOPE.DC-DATA.WRITE"}]}],"webhooks":[{"summary":"Data Item Created","title":"Data Item Created","description":"Triggered when a data item is inserted.","permissions":["WIX_DATA.GET"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.data.v2.data_item","serviceName":"com.wixpress.cloud.data.api.data.DataItemService","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"eventType":"wix.data.v2.data_item_created","legacyExamples":[{"name":"DataItemCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"7d4d5a64-6faa-4ff0-bbce-1b7fd64777f4\",\n \"entityFqdn\": \"wix.data.v2.data_item\",\n \"slug\": \"created\",\n \"entityId\": \"de17fb92-4448-4d90-bc0b-8b99dcadfa86\",\n \"createdEvent\": {\n \"entity\": {\n \"id\": \"de17fb92-4448-4d90-bc0b-8b99dcadfa86\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"de17fb92-4448-4d90-bc0b-8b99dcadfa86\",\n \"_owner\": \"ea435a36-6ab0-401f-82c2-22395fa6b573\",\n \"_createdDate\": {\n \"$date\": \"2024-05-20T12:13:49.189Z\"\n },\n \"_updatedDate\": {\n \"$date\": \"2024-05-20T12:13:49.189Z\"\n },\n \"city\": \"Los Angeles\",\n \"state\": \"California\",\n \"year\": 2022.0,\n \"population\": 3800000.0\n }\n }\n },\n \"eventTime\": \"2024-05-20T12:13:51.868311441Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/cloud.git","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","contentLink":{"displayName":"Data Item Created","slugifiedName":"data-item-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}]},{"summary":"Data Item Updated","title":"Data Item Updated","description":"Triggered when a data item is updated.","permissions":["WIX_DATA.GET"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.data.v2.data_item","serviceName":"com.wixpress.cloud.data.api.data.DataItemService","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"eventType":"wix.data.v2.data_item_updated","legacyExamples":[{"name":"DataItemUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"0b8c8bfc-1357-423a-aad8-3595feb83d5d\",\n \"entityFqdn\": \"wix.data.v2.data_item\",\n \"slug\": \"updated\",\n \"entityId\": \"de17fb92-4448-4d90-bc0b-8b99dcadfa86\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"id\": \"de17fb92-4448-4d90-bc0b-8b99dcadfa86\",\n \"dataCollectionId\": \"cities\",\n \"data\": {\n \"_id\": \"de17fb92-4448-4d90-bc0b-8b99dcadfa86\",\n \"_owner\": \"ea435a36-6ab0-401f-82c2-22395fa6b573\",\n \"_createdDate\": {\n \"$date\": \"2024-05-20T12:13:49.189Z\"\n },\n \"_updatedDate\": {\n \"$date\": \"2024-05-20T12:14:06.529Z\"\n },\n \"city\": \"Los Angeles\",\n \"state\": \"California\",\n \"year\": 2023.0,\n \"population\": 3900000.0\n }\n }\n },\n \"eventTime\": \"2024-05-20T12:14:08.615901811Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/cloud.git","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","contentLink":{"displayName":"Data Item Updated","slugifiedName":"data-item-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}]},{"summary":"Data Item Deleted","title":"Data Item Deleted","description":"Triggered when a data item is deleted.","permissions":["WIX_DATA.GET"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.data.v2.data_item","serviceName":"com.wixpress.cloud.data.api.data.DataItemService","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}],"eventType":"wix.data.v2.data_item_deleted","legacyExamples":[{"name":"DataItemDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"61635914-103b-4b23-9782-afd9794c8b6c\",\n \"entityFqdn\": \"wix.data.v2.data_item\",\n \"slug\": \"deleted\",\n \"entityId\": \"de17fb92-4448-4d90-bc0b-8b99dcadfa86\",\n \"deletedEvent\": {\n \"deletedEntity\": {\n \"id\": \"de17fb92-4448-4d90-bc0b-8b99dcadfa86\",\n \"dataCollectionId\": \"cities\"\n }\n },\n \"eventTime\": \"2024-05-20T12:14:15.146099243Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/cloud.git","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","contentLink":{"displayName":"Data Item Deleted","slugifiedName":"data-item-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Read Data Items","scopeId":"SCOPE.DC-DATA.READ"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Data Items API\n\nThe Data Items API allows you to access and manage items in a Wix site's data collections.\n\nWith the Data Items API, you can:\n\n+ Create and manage data items in a site's collections.\n+ Retrieve data items from a collection individually or with filtering and sorting queries.\n+ Create and manage reference fields.\n+ Perform aggregations and calculations on data in collections.\n+ Truncate a data collection, removing all its contents.\n\nThe Data Items API only works with existing collections. To create and manage data collections, use the [Data Collections API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c54f4e4c-34cf-4541-9844-04cd84f5662e*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/data-collections).\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n+ The maximum size of an item you can save to a collection is 500 kb.\n+ We don't recommend updating a data item more than once per second.\n+ When using data retrieval endpoints such as [Query Data Items](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::66a530fa-224c-48ee-841f-99a87365c6c3slug::query-data-items*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/data-items/query-data-items) or [Get Data Item](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::66a530fa-224c-48ee-841f-99a87365c6c3slug::get-data-item*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/data-items/get-data-item) following an update to a collection's data, the data retrieved may not yet contain the most recent changes. See [Wix Data and Eventual Consistency](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::43ff214d-d87d-44b1-96aa-5986944b33d8*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency) for more information and instructions for overriding this.\n+ When querying Wix App Collections, check which fields can be filtered in the relevant collection field article.\n+ Updating a data item replaces the existing item entirely. If the existing item had fields with values and those fields aren't included in the updated item, the values in those properties are lost.\n+ Aggregations can't be performed on Wix App collections.\n+ After connecting external database collections to a Wix site using the [External Database Connections API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ae9cab4a-b40b-48f1-b1b3-e659595e3440*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/external-database-connections), you can use the Data Items API to manage and retrieve data from those collections as if they were Wix Data collections.\n","sourceRepo":"git@github.com:wix-private/cloud.git","path":"docs/DataItemsServiceIntro.md"}],"components":{"schemas":{"com.wixpress.cloud.data.api.data.DataItem":{"type":"object","properties":{"id":{"description":"Data item ID.","immutable":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataCollectionId":{"description":"ID of the collection this item belongs to","readOnly":true,"title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data item contents.\n\nProperty-value pairs representing the data item's payload. When retrieving a data item, it also includes the following read-only fields:\n\n+ `_id`: Item ID.\n+ `_createdDate`: Date and time the item was added to the collection.\n+ `_updatedDate`: Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.\n+ `_ownerId`: ID of the user who created the item. Can be modified with site owner permissions.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DataItem","description":""},"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":""},"com.wixpress.cloud.data.api.data.InsertDataItemRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection in which to insert the item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItem":{"description":"Item to insert.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","summary":"dataItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InsertDataItemRequest","description":""},"com.wixpress.cloud.data.api.Environment":{"type":"string","description":"","title":"Environment","enum":["LIVE","SANDBOX","SANDBOX_PREFERRED"]},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"com.wixpress.cloud.data.api.data.Options":{"type":"object","properties":{},"title":"Options","description":""},"com.wixpress.cloud.data.api.data.Options.PublishPluginOptions":{"type":"object","properties":{"showDraftItems":{"description":"","title":"showDraftItems","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PublishPluginOptions","description":""},"com.wixpress.cloud.data.api.data.InsertDataItemResponse":{"type":"object","properties":{"dataItem":{"description":"Inserted data item.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","summary":"dataItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InsertDataItemResponse","description":""},"com.wixpress.cloud.data.api.data.PatchDataItemRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection containing the existing item.","maxLength":256,"title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"patchSet":{"description":"Patch set applied during item update.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PatchSet","summary":"patchSet","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PatchDataItemRequest","description":""},"com.wixpress.cloud.data.api.data.PatchSet":{"type":"object","properties":{"dataItemId":{"description":"Data item ID.","maxLength":256,"title":"dataItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldUpdates":{"description":"Set of field updates to be applied","minItems":1,"maxItems":100,"title":"fieldUpdates","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.FieldUpdate"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PatchSet","description":""},"com.wixpress.cloud.data.api.data.FieldUpdate":{"type":"object","properties":{"fieldPath":{"description":"Field ID to be patched. For ex \"title\", \"address.street\"","maxLength":1000,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"action":{"description":"Action to be applied","title":"action","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.FieldUpdate.ACTION","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldUpdate","description":"","oneOf":[{"description":"","summary":"actionOptions","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.FieldUpdate.actionOptions"}]},"com.wixpress.cloud.data.api.data.FieldUpdate.actionOptions":{"type":"object","title":"actionOptions","properties":{"setField":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.FieldUpdate.SetField","summary":"setField","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"incrementField":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.FieldUpdate.IncrementField","summary":"incrementField","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appendToArray":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.FieldUpdate.AppendToArray","summary":"appendToArray","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"removeFromArray":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.FieldUpdate.RemoveFromArray","summary":"removeFromArray","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.data.api.data.FieldUpdate.ACTION":{"type":"string","description":"","title":"ACTION","enum":["UNKNOWN_ACTION","SET_FIELD","REMOVE_FIELD","INCREMENT_FIELD","APPEND_TO_ARRAY","REMOVE_FROM_ARRAY"]},"com.wixpress.cloud.data.api.data.FieldUpdate.SetField":{"type":"object","properties":{"value":{"description":"","title":"value","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SetField","description":""},"com.wixpress.cloud.data.api.data.FieldUpdate.IncrementField":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IncrementField","description":""},"com.wixpress.cloud.data.api.data.FieldUpdate.AppendToArray":{"type":"object","properties":{"value":{"description":"","title":"value","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AppendToArray","description":""},"com.wixpress.cloud.data.api.data.FieldUpdate.RemoveFromArray":{"type":"object","properties":{"value":{"description":"","title":"value","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveFromArray","description":""},"com.wixpress.cloud.data.api.data.PublishPluginOptions":{"type":"object","properties":{"includeDraftItems":{"description":"Whether to include draft items.\nWhen `true`, the response includes both published and draft items. Default: `false`.","title":"includeDraftItems","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PublishPluginOptions","description":""},"com.wixpress.cloud.data.api.data.PatchDataItemResponse":{"type":"object","properties":{"dataItem":{"description":"Updated data item.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","summary":"dataItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PatchDataItemResponse","description":""},"com.wixpress.cloud.data.api.data.BulkPatchDataItemsRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection in which to update items.","maxLength":256,"title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"patchSets":{"description":"Patch sets to apply.","minItems":1,"maxItems":100,"title":"patchSets","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PatchSet"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the updated data items.\nWhen `true`, the `results` objects contain a `dataItem` field.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkPatchDataItemsRequest","description":""},"com.wixpress.cloud.data.api.data.BulkPatchDataItemsResponse":{"type":"object","properties":{"results":{"description":"Information about the updated items.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.BulkDataItemResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkPatchDataItemsResponse","description":""},"com.wixpress.cloud.data.api.data.BulkDataItemResult":{"type":"object","properties":{"action":{"description":"The action attempted for the data item.","title":"action","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.BulkActionType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"itemMetadata":{"description":"Metadata related to the data item for which the action was attempted.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItem":{"description":"The data item for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","summary":"dataItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDataItemResult","description":""},"com.wixpress.cloud.data.api.data.upstream.wix.common.BulkActionType":{"type":"string","description":"","title":"BulkActionType","enum":["UNKNOWN_ACTION_TYPE","INSERT","UPDATE","DELETE","PATCH"]},"com.wixpress.cloud.data.api.data.upstream.wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. This field doesn't appear if there is no item ID, for example, when item creation fails.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"com.wixpress.cloud.data.api.data.upstream.wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items successfully processed.","title":"totalSuccesses","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"com.wixpress.cloud.data.api.data.UpdateDataItemRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection containing the existing item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItem":{"description":"Updated data item content. The existing data item's content is replaced entirely.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","summary":"dataItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateDataItemRequest","description":""},"com.wixpress.cloud.data.api.data.UpdateDataItemResponse":{"type":"object","properties":{"dataItem":{"description":"Updated data item.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","summary":"dataItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateDataItemResponse","description":""},"com.wixpress.cloud.data.api.data.SaveDataItemRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection in which to insert or update the item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItem":{"description":"Data item to insert or update.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","summary":"dataItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SaveDataItemRequest","description":""},"com.wixpress.cloud.data.api.data.SaveDataItemResponse":{"type":"object","properties":{"action":{"description":"The action carried out for the item.\n\n+ `INSERTED`: A new item was added to the collection.\n+ `UPDATED`: An existing item in the collection was updated.","title":"action","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.SaveDataItemResponse.Action","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItem":{"description":"Inserted or updated data item.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","summary":"dataItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SaveDataItemResponse","description":""},"com.wixpress.cloud.data.api.data.SaveDataItemResponse.Action":{"type":"string","description":"","title":"Action","enum":["UNKNOWN_ACTION","INSERTED","UPDATED"]},"com.wixpress.cloud.data.api.data.GetDataItemRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection from which to retrieve the data item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItemId":{"description":"ID of the data item to retrieve.","title":"dataItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf provided, the result text is returned in the specified language.\n**Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n\nIf not provided, result text is not translated.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\n**Note:** The `_id` system field is always returned.","maxItems":10000,"maxLength":1000,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetDataItemRequest","description":""},"com.wixpress.cloud.data.api.data.GetDataItemResponse":{"type":"object","properties":{"dataItem":{"description":"Retrieved item.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","summary":"dataItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetDataItemResponse","description":""},"com.wixpress.cloud.data.api.data.RemoveDataItemRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection from which to remove the item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItemId":{"description":"ID of the item to remove.","title":"dataItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveDataItemRequest","description":""},"com.wixpress.cloud.data.api.data.RemoveDataItemResponse":{"type":"object","properties":{"dataItem":{"description":"Removed item.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","summary":"dataItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveDataItemResponse","description":""},"com.wixpress.cloud.data.api.data.TruncateDataItemsRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection to truncate.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TruncateDataItemsRequest","description":""},"com.wixpress.cloud.data.api.data.TruncateDataItemsResponse":{"type":"object","properties":{},"title":"TruncateDataItemsResponse","description":""},"com.wixpress.cloud.data.api.data.QueryDataItemsRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection to query.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"query":{"description":"Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"Whether to return the total count in the response for a query with offset paging.\nWhen `true`, the `pagingMetadata` object in the response contains a `total` field.\n\nDefault: `false`","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includeReferencedItems":{"description":"Properties for which to include referenced items in the query's results.\nUp to 50 referenced items can be included for each item that matches the query.","title":"includeReferencedItems","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"replacedBy":"referenced_item_options","targetRemovalDate":"2025-08-01"}}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf provided, the result text is returned in the specified language.\n**Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n\nIf not provided, result text is not translated.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referencedItemOptions":{"description":"Options for retrieving referenced items.","maxItems":100,"title":"referencedItemOptions","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.QueryDataItemsRequest.ReferencedItemOptions"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryDataItemsRequest","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.cloud.data.api.data.upstream.wix.common.QueryV2":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\n\nExamples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n\n**Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to return for each item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\n**Note:** The `_id` system field is always returned.","title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryV2","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.QueryV2.pagingMethod"}]},"com.wixpress.cloud.data.api.data.upstream.wix.common.QueryV2.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Paging options to limit and skip the number of items.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.data.api.data.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","minLength":1,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"com.wixpress.cloud.data.api.data.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"com.wixpress.cloud.data.api.data.upstream.wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"com.wixpress.cloud.data.api.data.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"maximum":1000,"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\nYou can get the relevant cursor token\nfrom the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"com.wixpress.cloud.data.api.data.QueryDataItemsRequest.ReferencedItemOptions":{"type":"object","properties":{"fieldName":{"description":"Field containing references in the queried item.","maxLength":1000,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"Maximum number of referenced items to include for each queried item.","maximum":1000,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReferencedItemOptions","description":""},"com.wixpress.cloud.data.api.data.QueryDataItemsResponse":{"type":"object","properties":{"dataItems":{"description":"Retrieved items.","title":"dataItems","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging information.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryDataItemsResponse","description":""},"com.wixpress.cloud.data.api.data.CachingInfo":{"type":"object","properties":{"tags":{"description":"Caching tags for this collection","maxLength":1024,"maxItems":50,"title":"tags","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxAge":{"description":"max caching time if set","title":"maxAge","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CachingInfo","description":""},"com.wixpress.cloud.data.api.data.upstream.wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used, `returnTotalCount` is `true` in the request, and `tooManyToCount` is false.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Whether the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"com.wixpress.cloud.data.api.data.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor pointing to next page in the list of results.","title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to previous page in the list of results.","title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wixpress.cloud.data.api.data.AggregateDataItemsRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection on which to run the aggregation.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initialFilter":{"description":"Filter applied to the collection's data prior to running the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object.\n\n**Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).","title":"initialFilter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregation":{"description":"Aggregation applied to the data.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation","summary":"aggregation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"finalFilter":{"description":"Filter applied to the processed data following the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object.\n**Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).","title":"finalFilter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"Whether to return the total count in the response for a query with offset paging.\nWhen `true`, the `pagingMetadata` object in the response contains a `total` field.\n\nDefault: `false`","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf provided, the result text is returned in the specified language.\n**Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n\nIf not provided, result text is not translated.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregateDataItemsRequest","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.pagingMethod"}]},"com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Paging options to limit and skip the number of items.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation.Operation.Average":{"type":"object","properties":{"itemFieldName":{"description":"Name of the field for which to calculate the average value.","title":"itemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Average","description":""},"com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation.Operation.Min":{"type":"object","properties":{"itemFieldName":{"description":"Name of the field for which to calculate the minimum value.","title":"itemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Min","description":""},"com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation.Operation.Max":{"type":"object","properties":{"itemFieldName":{"description":"Name of the field for which to calculate the maximum value.","title":"itemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Max","description":""},"com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation.Operation.Sum":{"type":"object","properties":{"itemFieldName":{"description":"Name of the field for which to calculate the sum.","title":"itemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sum","description":""},"com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation.Operation.Count":{"type":"object","properties":{},"title":"Count","description":""},"com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation.Operation":{"type":"object","properties":{"resultFieldName":{"description":"Name of the field containing results of the operation.","title":"resultFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Operation","description":"","oneOf":[{"description":"","summary":"calculate","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation.Operation.calculate"}]},"com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation.Operation.calculate":{"type":"object","title":"calculate","properties":{"average":{"description":"Calculate the average value of a specified field for all items in the grouping.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation.Operation.Average","summary":"average","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"min":{"description":"Calculate the minimum value of a specified field for all items in the grouping.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation.Operation.Min","summary":"min","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"max":{"description":"Calculate the maximum value of a specified field for all items in the grouping.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation.Operation.Max","summary":"max","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sum":{"description":"Calculate the sum of values of a specified field for all items in the grouping.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation.Operation.Sum","summary":"sum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"itemCount":{"description":"Calculate the number of items in the grouping.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation.Operation.Count","summary":"itemCount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation":{"type":"object","properties":{"groupingFields":{"description":"Fields by which to group items for the aggregation. If empty, the aggregation is carried out on all items in the collection.","title":"groupingFields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"operations":{"description":"Operations to carry out on the data in each grouping.","title":"operations","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.AggregateDataItemsRequest.Aggregation.Operation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Aggregation","description":""},"com.wixpress.cloud.data.api.data.AggregateDataItemsResponse":{"type":"object","properties":{"results":{"description":"Aggregation results.","title":"results","type":"array","items":{"type":"object"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging information.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregateDataItemsResponse","description":""},"com.wixpress.cloud.data.api.data.CountDataItemsRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection for which to count query results.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filter":{"description":"Filter object in the following format:\n\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`.\n\nExamples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.\n\n**Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf provided, the result text is returned in the specified language.\n**Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n\nIf not provided, result text is not translated.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountDataItemsRequest","description":""},"com.wixpress.cloud.data.api.data.CountDataItemsResponse":{"type":"object","properties":{"totalCount":{"description":"Number of items matching the query.","title":"totalCount","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountDataItemsResponse","description":""},"com.wixpress.cloud.data.api.data.QueryDistinctValuesRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection to query.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldName":{"description":"Item field name for which to return all distinct values.","title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filter":{"description":"Filter object in the following format:\n\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`.\n\nExamples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.\n\n**Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"Whether to return the total count in the response for a query with offset paging.\nWhen `true`, the `pagingMetadata` object in the response contains a `total` field.\n\nDefault: `false`","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf provided, the result text is returned in the specified language.\n**Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n\nIf not provided, result text is not translated.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryDistinctValuesRequest","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.QueryDistinctValuesRequest.pagingMethod"}]},"com.wixpress.cloud.data.api.data.QueryDistinctValuesRequest.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Paging options to limit and skip the number of items.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.data.api.data.QueryDistinctValuesResponse":{"type":"object","properties":{"distinctValues":{"description":"List of distinct values contained in the field specified in `fieldName`.","title":"distinctValues","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging information.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryDistinctValuesResponse","description":""},"com.wixpress.cloud.data.api.data.BulkInsertDataItemsRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection in which to insert the items.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItems":{"description":"Data items to insert.","title":"dataItems","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the inserted data items.\nWhen `true`, the `results` objects contain a `dataItem` field.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkInsertDataItemsRequest","description":""},"com.wixpress.cloud.data.api.data.BulkInsertDataItemsResponse":{"type":"object","properties":{"results":{"description":"Information about the inserted items.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.BulkDataItemResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkInsertDataItemsResponse","description":""},"com.wixpress.cloud.data.api.data.BulkUpdateDataItemsRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection in which to update items.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItems":{"description":"Data items to update.","title":"dataItems","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the updated data items.\nWhen `true`, the `results` objects contain a `dataItem` field.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateDataItemsRequest","description":""},"com.wixpress.cloud.data.api.data.BulkUpdateDataItemsResponse":{"type":"object","properties":{"results":{"description":"Information about the updated items.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.BulkDataItemResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateDataItemsResponse","description":""},"com.wixpress.cloud.data.api.data.BulkSaveDataItemsRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection in which to insert or update the items.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItems":{"description":"Data items to insert or update.","title":"dataItems","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the saved data item.\nWhen `true`, the `results` objects contain a `dataItem` field.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkSaveDataItemsRequest","description":""},"com.wixpress.cloud.data.api.data.BulkSaveDataItemsResponse":{"type":"object","properties":{"results":{"description":"Information about the saved items.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.BulkDataItemResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkSaveDataItemsResponse","description":""},"com.wixpress.cloud.data.api.data.BulkRemoveDataItemsRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection from which to remove the item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItemIds":{"description":"IDs of data items to remove.","title":"dataItemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveDataItemsRequest","description":""},"com.wixpress.cloud.data.api.data.BulkRemoveDataItemsResponse":{"type":"object","properties":{"results":{"description":"Information about the removed data items.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.BulkDataItemResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveDataItemsResponse","description":""},"com.wixpress.cloud.data.api.data.QueryReferencedDataItemsRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection containing the referring item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemId":{"description":"ID of the referring item.","title":"referringItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemFieldName":{"description":"Field containing references in the referring item.","title":"referringItemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Order of the returned referenced items. Sorted by the date each item was referenced.","title":"order","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"Whether to return the total count in the response.\nWhen `true`, the `pagingMetadata` object in the response contains a `total` field.\n\nDefault: `false`","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf provided, the result text is returned in the specified language.\n**Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n\nIf not provided, result text is not translated.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to return for each referenced item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\n**Note:** The `_id` system field is always returned.","maxItems":10000,"maxLength":1000,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishPluginOptions":{"description":"Options for the Publish plugin.\nThis plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.PublishPluginOptions","summary":"publishPluginOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryReferencedDataItemsRequest","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.QueryReferencedDataItemsRequest.pagingMethod"}]},"com.wixpress.cloud.data.api.data.QueryReferencedDataItemsRequest.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Paging options to limit and skip the number of items.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.data.api.data.QueryReferencedDataItemsResponse":{"type":"object","properties":{"results":{"description":"Referenced items and/or IDs. For successfully resolved references, the referenced data item is returned. For references that can't be resolved, the ID is returned.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.QueryReferencedDataItemsResponse.ReferencedResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging information.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryReferencedDataItemsResponse","description":""},"com.wixpress.cloud.data.api.data.QueryReferencedDataItemsResponse.UnresolvedReference":{"type":"object","properties":{"referringItemId":{"description":"ID of the referring item.","title":"referringItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemFieldName":{"description":"Field specified to query for references.","title":"referringItemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UnresolvedReference","description":""},"com.wixpress.cloud.data.api.data.QueryReferencedDataItemsResponse.ReferencedResult":{"type":"object","properties":{},"title":"ReferencedResult","description":"","oneOf":[{"description":"","summary":"entity","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.QueryReferencedDataItemsResponse.ReferencedResult.entity"}]},"com.wixpress.cloud.data.api.data.QueryReferencedDataItemsResponse.ReferencedResult.entity":{"type":"object","title":"entity","properties":{"dataItem":{"description":"Data item referenced.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItem","summary":"dataItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"unresolvedReference":{"description":"Unresolved reference. Appears instead of the data item when the reference doesn't resolve, for example, when an ID isn't found or if an item is in draft state.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.QueryReferencedDataItemsResponse.UnresolvedReference","summary":"unresolvedReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.data.api.data.IsReferencedDataItemRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection containing the referring data item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemFieldName":{"description":"Field to check for a reference to the item that may be referenced.","title":"referringItemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemId":{"description":"ID of the referring item.","title":"referringItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referencedItemId":{"description":"ID of the item that may be referenced.","title":"referencedItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IsReferencedDataItemRequest","description":""},"com.wixpress.cloud.data.api.data.IsReferencedDataItemResponse":{"type":"object","properties":{"isReferenced":{"description":"Whether the specified reference exists.","title":"isReferenced","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IsReferencedDataItemResponse","description":""},"com.wixpress.cloud.data.api.data.InsertDataItemReferenceRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection in which to insert the reference.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItemReference":{"description":"Reference to insert","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItemReference","summary":"dataItemReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appOptions":{"description":"Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.\n\nWhen querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:\n- `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.\n- `includeVariants`: Whether to include product variants in the query. Default: `false`.","title":"appOptions","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InsertDataItemReferenceRequest","description":""},"com.wixpress.cloud.data.api.data.DataItemReference":{"type":"object","properties":{"referringItemFieldName":{"description":"Referring item field containing the references to the referenced items.","title":"referringItemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemId":{"description":"ID of the referring item.","title":"referringItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referencedItemId":{"description":"ID of the referenced item.","title":"referencedItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DataItemReference","description":""},"com.wixpress.cloud.data.api.data.InsertDataItemReferenceResponse":{"type":"object","properties":{"dataItemReference":{"description":"Inserted reference.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItemReference","summary":"dataItemReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InsertDataItemReferenceResponse","description":""},"com.wixpress.cloud.data.api.data.RemoveDataItemReferenceRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection containing the referring item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItemReference":{"description":"Reference to remove.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItemReference","summary":"dataItemReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveDataItemReferenceRequest","description":""},"com.wixpress.cloud.data.api.data.RemoveDataItemReferenceResponse":{"type":"object","properties":{"dataItemReference":{"description":"Removed reference.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItemReference","summary":"dataItemReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveDataItemReferenceResponse","description":""},"com.wixpress.cloud.data.api.data.BulkInsertDataItemReferencesRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection containing the referring items.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItemReferences":{"description":"References to insert.","title":"dataItemReferences","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the inserted data item references.\nWhen `true`, the `results` objects contain a `dataItemReference` field.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkInsertDataItemReferencesRequest","description":""},"com.wixpress.cloud.data.api.data.BulkInsertDataItemReferencesResponse":{"type":"object","properties":{"results":{"description":"Information about the inserted references.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.BulkDataItemReferenceResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkInsertDataItemReferencesResponse","description":""},"com.wixpress.cloud.data.api.data.BulkDataItemReferenceResult":{"type":"object","properties":{"action":{"description":"The action attempted for the reference.","title":"action","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.BulkActionType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referenceMetadata":{"description":"Metadata related to the reference for which the action was attempted.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.ItemMetadata","summary":"referenceMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItemReference":{"description":"The reference for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItemReference","summary":"dataItemReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDataItemReferenceResult","description":""},"com.wixpress.cloud.data.api.data.BulkRemoveDataItemReferencesRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection containing the referring items.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataItemReferences":{"description":"References to remove.","title":"dataItemReferences","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveDataItemReferencesRequest","description":""},"com.wixpress.cloud.data.api.data.BulkRemoveDataItemReferencesResponse":{"type":"object","properties":{"results":{"description":"Information about the removed references.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.BulkDataItemReferenceResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveDataItemReferencesResponse","description":""},"com.wixpress.cloud.data.api.data.ReplaceDataItemReferencesRequest":{"type":"object","properties":{"dataCollectionId":{"description":"ID of the collection containing the referring item.","title":"dataCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemFieldName":{"description":"Field containing references in the referring item.","title":"referringItemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemId":{"description":"ID of the referring item.","title":"referringItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newReferencedItemIds":{"description":"List of new referenced item IDs to replace the existing ones.","title":"newReferencedItemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReplaceDataItemReferencesRequest","description":""},"com.wixpress.cloud.data.api.data.ReplaceDataItemReferencesResponse":{"type":"object","properties":{"dataItemReferences":{"description":"Updated references.","title":"dataItemReferences","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.data.DataItemReference"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReplaceDataItemReferencesResponse","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":""},"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.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.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","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":"Data Item","description":"","fqdn":"wix.data.v2.data_item"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Data Items API\n\nThe Data Items API allows you to access and manage items in a Wix site's data collections.\n\nWith the Data Items API, you can:\n\n+ Create and manage data items in a site's collections.\n+ Retrieve data items from a collection individually or with filtering and sorting queries.\n+ Create and manage reference fields.\n+ Perform aggregations and calculations on data in collections.\n+ Truncate a data collection, removing all its contents.\n\nThe Data Items API only works with existing collections. To create and manage data collections, use the [Data Collections API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c54f4e4c-34cf-4541-9844-04cd84f5662e*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/data-collections).\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n+ The maximum size of an item you can save to a collection is 500 kb.\n+ We don't recommend updating a data item more than once per second.\n+ When using data retrieval endpoints such as [Query Data Items](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::66a530fa-224c-48ee-841f-99a87365c6c3slug::query-data-items*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/data-items/query-data-items) or [Get Data Item](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::66a530fa-224c-48ee-841f-99a87365c6c3slug::get-data-item*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/data-items/get-data-item) following an update to a collection's data, the data retrieved may not yet contain the most recent changes. See [Wix Data and Eventual Consistency](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::43ff214d-d87d-44b1-96aa-5986944b33d8*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency) for more information and instructions for overriding this.\n+ When querying Wix App Collections, check which fields can be filtered in the relevant collection field article.\n+ Updating a data item replaces the existing item entirely. If the existing item had fields with values and those fields aren't included in the updated item, the values in those properties are lost.\n+ Aggregations can't be performed on Wix App collections.\n+ After connecting external database collections to a Wix site using the [External Database Connections API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ae9cab4a-b40b-48f1-b1b3-e659595e3440*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/external-database-connections), you can use the Data Items API to manage and retrieve data from those collections as if they were Wix Data collections.\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Query Data Items

Permission Scopes