Pagination - Shipments

Overview

When retrieving shipment 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 shipment data:

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

Tip: Pagination is particularly useful for tracking shipments over time, as businesses may have hundreds or thousands of active shipments at any given moment.

Examples

GET /api/shipments?page=5

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

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

GET /api/shipments?items_per_page=20

This request will return 20 shipments from the first page.

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

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

This request will return 20 shipments 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 shipment objects based on your pagination parameters. Each shipment object will include details like the shipment ID, associated order, shipping carrier, tracking number, shipping date, estimated delivery date, and current status.

Important: When working with shipment data, always check the status field to ensure you're displaying the most current information to your customers.