Big Post - API Fair Use Policy

Big Post - API Fair Use Policy

At Big Post, we support our customers by providing smart, simple, and competitive transport solutions. Our aim is to assist companies and developers with delivering an excellent user experience to their clients through the use of Big Post integration methods, which support quoting, booking and job status tracking.

The actions individuals take can influence the performance of our system as a whole. As the Big Post system is also integrated with our carrier APIs, too many API calls made through our API can have a flow-on effect to our carrier systems.

To maintain optimal performance across our system and API, and to deliver a great user experience for all our customers and partners, we request that developers avoid excessive API calls and consider optimising their API call patterns and flows.

Fair Use Guidelines

  1. Developers must optimise API calls and avoid unnecessary or duplicate requests.
  2. Usage limits:
    1. Maximum 60 API calls per minute.
    2. Maximum 2,000 API calls per day (12:00am–11:59pm).
    3. Bulk API calls should be scheduled outside business hours (after 6:00pm) wherever possible. Please notify us in advance with the planned timing and expected volume.
  3. If an application creates excessive load, Big Post may restrict or suspend API access without prior notice.
  4. The API must not be used to transmit or distribute malicious or harmful code (e.g. malware, viruses, spyware, etc.) intended to disrupt, damage, or compromise systems or data.
  5. Big Post may monitor API usage to verify compliance.

By using the Big Post API, you acknowledge and agree to comply with this API Fair Use Policy.

Please feel free to contact us if you require support or have any questions about the Big Post API Fair Use Policy at helpdesk@bigpost.com.au.


    • Related Articles

    • Big Post Integration - Functions & Constraints

      Integration Functions Overview Below is a comparison of the functions offered and not offered for the Big Post integrations - Big Post API, WooCommerce Plugin and Shopify App (collectively the Big Post Integrations). Big Post Shopify App Big Post ...

    • Creating an API Token

      This article will guide you in creating an API token for the integration. 1. Log into your Big Post account and navigate to Admin at the top and click on My API Tokens 2. Click on the ‘Create API Token’ button. 3. Enter a name for your API token and ...

    • CIS x WooCommerce Plugin - Quick Set Up Guide

      Quick Set-Up Guide This article will guide you through a quick setup of the Custom Integration System (CIS for short) for WooCommerce with minimal customisation. To set the plugin up to work using the CIS you are required to complete the following ...

    • Shopify App - Quick Set Up Guide

      Quick Set Up Summary This article will guide you through a quick setup with simple customisation. In order to set up the app you are required to complete the following steps: Search and install the Big Post Shipping app. Create a Big Post Custom ...

    • Shopify Trial - Migrating to the New App

      Welcome to the Shopify Migration Guide. In this guide, we'll walk you through the steps to seamlessly transition your current Shopify integration from the trial app to the new app. Follow along closely to ensure a smooth migration process and get ...