> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # QueryDisputeEvidenceDocuments # Package: disputes # Namespace: DisputeEvidenceDocumentService # Method link: https://dev.wix.com/docs/api-reference/business-management/payments/disputes/dispute-evidence-documents/query-dispute-evidence-documents.md ## Permission Scopes: Read Disputes: SCOPE.DC-PAYMENTS.READ-DISPUTES ## Introduction Retrieves a list of dispute evidence documents, given the provided paging, filtering, and sorting. Query Dispute Evidence Documents runs with these defaults, which you can override: - `createdDate` is sorted in `DESC` order - `paging.limit` is `50` - `paging.offset` is `0` To learn how to query disputes, see [About the Wix API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md). --- ## REST API ### Schema ``` Method: queryDisputeEvidenceDocuments Description: Retrieves a list of dispute evidence documents, given the provided paging, filtering, and sorting. Query Dispute Evidence Documents runs with these defaults, which you can override: - `createdDate` is sorted in `DESC` order - `paging.limit` is `50` - `paging.offset` is `0` To learn how to query disputes, see [About the Wix API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md). URL: https://www.wixapis.com/payments/dispute-evidence-documents/v1/dispute-evidence-documents/query Method: POST Method parameters: param name: query | type: CursorQuery - name: cursorPaging | type: 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`. - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` - name: sort | type: array | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: QueryDisputeEvidenceDocumentsResponse - name: disputeEvidenceDocuments | type: array | description: Retrieved dispute evidence documents. - name: id | type: string | description: Dispute evidence document GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the dispute evidence document is updated. To prevent conflicting changes, the existing revision must be specified when updating a dispute evidence document. Ignored when creating a dispute evidence document. - name: createdDate | type: string | description: Date and time the dispute evidence document was created. - name: updatedDate | type: string | description: Date and time the dispute evidence document was updated. - name: disputeId | type: string | description: GUID of the dispute this evidence document supports. - name: file | type: DocumentFile | description: File details for the uploaded evidence document. If a file hasn't been uploaded yet, this field is `null`. - name: filename | type: string | description: Name of the uploaded evidence file. - name: size | type: string | description: Size of the uploaded evidence file in bytes. - name: checksum | type: string | description: Hexadecimal checksum of the uploaded file. - name: extendedFields | type: ExtendedFields | description: Custom field data for the dispute evidence document object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags assigned to the dispute evidence document for organization and filtering purposes. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs. - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata for the query results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### Query dispute evidence documents Retrieves all evidence documents for a specific dispute with pagination ```curl curl -X POST \ 'https://www.wixapis.com/dispute-evidence-documents/v1/dispute-evidence-documents/query' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "query": { "filter": { "disputeId": { "$eq": "12345678-1234-1234-1234-123456789012" } }, "paging": { "limit": 50 } } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.disputes.DisputeEvidenceDocumentService.queryDisputeEvidenceDocuments(query) Description: Retrieves a list of dispute evidence documents, given the provided paging, filtering, and sorting. Query Dispute Evidence Documents runs with these defaults, which you can override: - `createdDate` is sorted in `DESC` order - `paging.limit` is `50` - `paging.offset` is `0` To learn how to query disputes, see [About the Wix API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: query Method parameters: param name: query | type: DisputeEvidenceDocumentQuery | required: true - name: cursorPaging | type: 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`. - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` - name: sort | type: array | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: PROMISE - name: disputeEvidenceDocuments | type: array | description: Retrieved dispute evidence documents. - name: _id | type: string | description: Dispute evidence document GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the dispute evidence document is updated. To prevent conflicting changes, the existing revision must be specified when updating a dispute evidence document. Ignored when creating a dispute evidence document. - name: _createdDate | type: Date | description: Date and time the dispute evidence document was created. - name: _updatedDate | type: Date | description: Date and time the dispute evidence document was updated. - name: disputeId | type: string | description: GUID of the dispute this evidence document supports. - name: file | type: DocumentFile | description: File details for the uploaded evidence document. If a file hasn't been uploaded yet, this field is `null`. - name: filename | type: string | description: Name of the uploaded evidence file. - name: size | type: string | description: Size of the uploaded evidence file in bytes. - name: checksum | type: string | description: Hexadecimal checksum of the uploaded file. - name: extendedFields | type: ExtendedFields | description: Custom field data for the dispute evidence document object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags assigned to the dispute evidence document for organization and filtering purposes. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs. - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata for the query results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### queryDisputeEvidenceDocuments ```javascript import { disputeEvidenceDocuments } from '@wix/payments'; async function queryDisputeEvidenceDocuments(query) { const response = await disputeEvidenceDocuments.queryDisputeEvidenceDocuments(query); }; ``` ### queryDisputeEvidenceDocuments (with elevated permissions) ```javascript import { disputeEvidenceDocuments } from '@wix/payments'; import { auth } from '@wix/essentials'; async function myQueryDisputeEvidenceDocumentsMethod(query) { const elevatedQueryDisputeEvidenceDocuments = auth.elevate(disputeEvidenceDocuments.queryDisputeEvidenceDocuments); const response = await elevatedQueryDisputeEvidenceDocuments(query); } ``` ### queryDisputeEvidenceDocuments (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { disputeEvidenceDocuments } from '@wix/payments'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { disputeEvidenceDocuments }, // Include the auth strategy and host as relevant }); async function queryDisputeEvidenceDocuments(query) { const response = await myWixClient.disputeEvidenceDocuments.queryDisputeEvidenceDocuments(query); }; ``` ---