Boxy API
  1. Getting Started
Boxy API
  • Getting Started
    • Introduction
    • Environments
    • Security & Authentication
    • Rate Limit
    • Postman Collections
    • Schemas
    • Webhooks
  • Guides
    • Order Flow (Statuses)
    • Provinces & Regions
  • API Reference
    • Merchant
      • Get Merchant Info
    • Orders
      • Create Order
      • Create Bulk Orders (Sync)
      • Create Bulk Orders (Async)
      • List Orders
      • Show Order By UID
      • Show Order By Custom ID
      • Get Label Single
      • Get Label Bulk
      • Cancel Order
      • Update Order
      • Delete Order
    • Pick-ups
      • Request Pick-up
      • Request Pick-up Bulk
      • List Pick-ups
      • Show Pick-up
      • Get Pick-up Labels
      • Cancel Pick-up
      • Cancel Bulk Pick-ups
    • Pick-up Locations
      • Create Pick-up Location
      • List Pick-up Locations
      • Show Pick-up Location
      • Show Cash Drop-off Location
      • Update Pick-up Location
      • Delete Pick-up Location
    • Regions
      • List Regions
  1. Getting Started

Introduction

The Boxy API is organized around REST. Our API has resource-oriented URLs, accepts JSON-encoded bodies, returns JSON-encoded responses, and uses standard HTTP response codes, and verbs.
You can develop against the Boxy API Sandbox without affecting your live data or interacting with real systems. The Sandbox uses a separate API URL and API key.

Key concepts#

The key data models in the Boxy API are the Order object and the Product object.
Think of creating an Order as making a request to Boxy to come and pick up a Package from you, and deliver it to a customer. The Order starts the process of Boxy planning the logistics of the pickup, sorting, and delivery of this Package, and also generates labels.
An Order has a one-to-many relationship with the Product object, meaning each Order can have many Products associated with it.
An Order contains other top-level information, including service type, customer details, destination and dimensions of the package. Product object has quantity and price that is automatically calculated for the cash on delivery.

Status Codes#

HTTP response status codes let you know whether your API request was processed successfully or if an error occurred. Boxy uses the following status codes:
Status CodeNameDescription
200SuccessThe HTTP request was successful.
201CreatedThe requested resource was successfully created.
204No ContentThe HTTP request was successful and the response is empty.
207Multi-StatusThe HTTP request was successful but contains separate response codes that each need to be evaluated.
400Bad RequestThere's something wrong with your request. See the error code for more details about the problem.
401UnauthorizedYour API key is invalid, expired, or has been deactivated.
404Not FoundThe resource you requested does not exist.
405Not AllowedThe HTTP method you used is not supported by Boxy.
409ConflictThe request conflicts with the current state of the server. For example, you may be attempting to create a resource that already exists or ship a package that has already been shipped.
500Internal Server ErrorThe server cannot process the request. If this occurs persistently, please contact support for help.

Format#

Our API is REST based and observes the following requirements:
It makes use of standard HTTP methods like GET, POST, PUT and PATCH
Uses standard HTTP error responses to describe errors
All communication with our servers must be over SSL (https://)
POST data must be encoded as application/json
All our responses are encoded as application/json
UTF-8 encoding required for non ASCII characters
Modified at 2025-02-07 14:21:36
Next
Environments
Built with