Skip to content

Latest commit

 

History

History
executable file
·
12 lines (9 loc) · 1.16 KB

V1LabelsResponse.md

File metadata and controls

executable file
·
12 lines (9 loc) · 1.16 KB

ShipEngineApi::V1LabelsResponse

Properties

Name Type Description Notes
total Integer The total number of items across all pages of results
page Integer 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.
pages Integer 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.
links Links
labels Array<Label> The labels that matched the query criteria. If no matching labels were found, then this array will be empty; otherwise, it will contain one page of results. The last page of results may have fewer labels than the `page_size`.