Pagination - Shipping Methods

Overview

When retrieving shipping methods 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 shipping methods:

Parameter Description
page Specifies which page of shipping methods to display. Pages are numbered starting from 1.
items_per_page Controls how many shipping methods are included on each page. Default value is 10.
Tip: Shipping methods often include various options with different pricing rules, making pagination especially useful when retrieving this data.

Examples

GET /api/shippings?page=5

This request will return 10 shipping methods from the 5th page.

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

GET /api/shippings?items_per_page=20

This request will return 20 shipping methods from the first page.

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

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

This request will return 20 shipping methods 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 shipping method objects based on your pagination parameters. Each shipping method object will include details like the method ID, name, description, pricing rules, estimated delivery times, and geographic restrictions (if applicable).

Important: Some shipping methods may be available only for specific regions, product types, or order values. Always check the eligibility criteria included in each shipping method object.