containers
The containers GraphQL API schema retrieves a list of containers based on the specified containerType, tenantId, filter, page, and sort parameters.
Argument | Description |
containerType | The type of the container to filter the data. Required |
tenantId | The tenantId string specifies the client's information for identification purposes. Required |
filter | Filter string to apply on the returned containers. |
page | The page number for the set of containers to be returned (for pagination). |
sort | Sort parameter used to order the returned list of containers. |
The containers schema returns an object with the following fields:
The data field includes a list of containers, each of which has the following fields:
Field | Description |
attributes | Attributes associated with the container. |
containerType | Type of the container. |
createdAt | Timestamp of when the container was created. |
createdBy | User who created the container. |
eventCode | Code related to an event associated with the container. |
id | Unique identifier for the container. |
items | Items present in the container. Each item has fields for code, cost, name, and quantity. |
parentId | ID of the parent container. |
reasonCode | Code representing a reason associated with the container. |
state | Current state of the container. |
tenantId | Identifier for the tenant that the container belongs to. |
trackingDetails | Details for tracking the container. |
updatedAt | Timestamp of when the container was last updated. |
updatedBy | User who last updated the container. |
The pagination field includes pagination details of the container list:
Field | Description |
currPage | Current page number in the pagination. |
hasNextPage | Boolean indicating whether there is a next page in the pagination. |
nextPage | The next page number in the pagination. |
pageSize | The number of containers per page in the pagination. |
prevPage | The previous page number in the pagination. |
totalCount | Total count of containers in the pagination. |