GraphQl Schemas
GraphQL: Dispatch Queries
dispatchListV2
3min
The dispatchListV2 GraphQL schema is designed to retrieve a list of dispatches based on specified criteria.
- tenant: A string representing the tenant for which the dispatches should be retrieved.
- filter: A string representing additional filtering criteria for the dispatches.
- page: An integer indicating the current page number of the dispatch list.
- size: An integer representing the number of dispatches to be included in each page.
- sort: A string specifying the sorting order for the dispatches.
- data: An object containing the dispatch information for each entry in the dispatch list. It includes the following fields:
- createdAt: A timestamp indicating the creation date and time of the dispatch.
- createdBy: A string representing the user or entity who created the dispatch.
- customData: An object containing custom data associated with the dispatch. The structure and content of this field may vary depending on the implementation.
- dispatchRef: A string representing the reference number or identifier of the dispatch.
- dispatchTypeId: An identifier indicating the type of the dispatch.
- dispatchTypeName: A string representing the name or description of the dispatch type.
- id: An identifier unique to each dispatch entry.
- participants: An array of strings representing the participants or stakeholders associated with the dispatch.
- status: A string indicating the current status of the dispatch.
- subStatus: A string representing the sub-status of the dispatch.
- tenantId: An identifier specifying the tenant to which the dispatch belongs.
- updatedAt: A timestamp indicating the date and time when the dispatch was last updated.
- updatedBy: A string representing the user or entity who last updated the dispatch.
- pagination: An object providing pagination information for the dispatch list. It includes the following fields:
- currPage: An integer indicating the current page number.
- hasNextPage: A boolean value indicating whether there is a next page available.
- nextPage: An integer representing the page number of the next page, if available.
- pageSize: An integer specifying the number of dispatches included in each page.
- prevPage: An integer representing the page number of the previous page, if available.
- totalCount: An integer representing the total number of dispatches in the list.

Updated 03 Aug 2023
Did this page help you?