Shipbubble API Documentation
  • Shipbubble API
  • Get started
    • Authentication
    • Request and Responses
    • Errors
    • Rate Limiting
    • Pagination
    • Postman
  • API Reference
    • Wallet
      • Get shipping wallet balance
      • Request wallet fund
    • Addresses
      • Validate address (global)
      • Get validated addresses
      • Edit address details
      • Get single address details
    • Package categories
    • Package dimensions
    • Couriers
    • Rates
      • Request shipping rates
      • Request shipping rates from selected couriers
      • Edit request token details
    • Cash on delivery
    • Insurance
      • Get Insurance Rates
    • Shipments
      • Create shipment
      • Cancel shipment
    • Returns
      • Get rates for a return shipment request
    • Tracking
      • Get shipments
      • Get multiple specific shipments
    • Webhooks
      • Webhook simulator (sandbox)
Powered by GitBook
On this page

Was this helpful?

  1. Get started

Pagination

Whenever you try to retrieve a list (e.g shipping labels list), the pagination property is added to their response by default

We include the following as query parameters to limit our queries.

GET /example_list_url?Page=1&PerPage=1

Query Parameters

Name
Type
Description

PerPage

number

This is the maximum number of records that will be returned after the request. This can be modified by passing a new value into the query parameter. Default is 50

Page

number

This is current page to be returned per request. Default: 1

{
    "status": "success",
    "message": "Retrieved successfully",
    "data": {
        "results": [],
        "pagination": {
            "current": 1,
            "perPage": 1,
            "previous": 0,
            "next": 7,
            "total": 8
        }
    }
}

PreviousRate LimitingNextPostman

Last updated 3 years ago

Was this helpful?