Pagination - Statuses

Overview

When retrieving status data through the Venddor API, you can control how many results are returned and which page of results to display using pagination parameters.

Base URL: https://www.venddor.com.br/api

Pagination Parameters

Add these parameters to your API requests to control the pagination of status data:

Parameter	Description
`page`	Specifies which page of statuses to display. Pages are numbered starting from 1.
`items_per_page`	Controls how many statuses are included on each page. Default value is 10.

Tip: Status data often includes many different status types for orders, deliveries, payments, and more. Using pagination helps you focus on specific status categories.

Examples

GET /api/statuses?page=5

This request will return 10 statuses from the 5th page.

Since items_per_page is not specified, the default value of 10 is used.

GET /api/statuses?items_per_page=20

This request will return 20 statuses from the first page.

Since page is not specified, the default value of 1 is used.

GET /api/statuses?page=5&items_per_page=20

This request will return 20 statuses from the 5th page.

Both pagination parameters are specified, giving you complete control over the results.

Response Format

The API will return a JSON array containing status objects based on your pagination parameters. Each status object will include details like the status ID, name, description, type (e.g., order status, payment status), and associated color codes or icons.

Note: Status data is typically used for displaying order processing stages, payment states, and other workflow states in your application. It's important to retrieve the complete set of statuses when initializing your application to ensure consistent state representation.