v1

latestOpenAPI 3.0.32026-07-26170311887.2 KB
Boxes

List all Boxes

Retrieve a list of available courier boxes and your custom boxes.

Required authorization scope: public.box:read

This request returns box types specified with a slug when creating a shipment via the API or dashboard.

In Easyship API terms, slug is a string field used by the box object. Slugs contain dimensions of corresponding box types: when you create a shipment, we will get dimensions based on the slug provided.

get/2024-09/boxes

Query parameters

pageinteger

Page number to fetch, default: 1

per_pageinteger

Number of records per page to fetch, default: 20

courier_country_alpha2string

Filter records by courier country alpha 2

courier_umbrella_name'Australia Post MyPost Business' | 'Aramex' | 'FedEx' | 'USPS' | 'UPS'

Filter records by courier umbrella name

Response

list of boxes