shipstation-client/docs/ListLabelsResponseBody.md

ShipStation V2 SDK

# ListLabelsResponseBody

A list label response body

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**labels** | [**Array<Label>**](Label.md) | The labels that matched the query criteria.  If no matching labels were found, then this array is empty; otherwise, it contains one page of results.  The last page of results may have fewer labels than the `page_size`.  | [default to undefined]
**total** | **number** | The total number of items across all pages of results | [default to undefined]
**page** | **number** | The current page number of results.  For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4.  The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. | [default to undefined]
**pages** | **number** | The total number of pages of results.  For example, if there are 80 results, and the page size is 25, then `pages` would be 4.  The first three pages would contain 25 items each, and the fourth page would contain the five remaining items.  If there are no results, then `pages` will be zero. | [default to undefined]
**links** | [**PaginationLink**](PaginationLink.md) |  | [default to undefined]

## Example

```typescript
import { ListLabelsResponseBody } from 'shipstation-client';

const instance: ListLabelsResponseBody = {
    labels,
    total,
    page,
    pages,
    links,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)