> ## Documentation Index
> Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Shipping packages

> List, read, create, update and delete shipping packages, the boxes described by their size and weight.

A shipping package describes a box by its length, width, height and weight, each with an optional unit. These endpoints list, read, create, update and delete shipping packages. This area has 5 endpoints, each available in all seven SDKs.

## At a glance

| Endpoint | Method | Path | What it does |
| - | - | - | - |
| [List shipping packages](https://exsited.mintlify.site/api-reference/shipping-packages/list-shipping-packages.md) | GET | `/settings/shipping_packages` | Returns a page of shipping packages. |
| [Create a shipping package](https://exsited.mintlify.site/api-reference/shipping-packages/create-a-shipping-package.md) | POST | `/settings/shipping_packages` | Creates a shipping package and returns it under `shipping_package`. |
| [Retrieve a shipping package](https://exsited.mintlify.site/api-reference/shipping-packages/retrieve-a-shipping-package.md) | GET | `/settings/shipping_packages/{shipping_package_id}` | Returns one shipping package by its `id`. |
| [Delete a shipping package](https://exsited.mintlify.site/api-reference/shipping-packages/delete-a-shipping-package.md) | DELETE | `/settings/shipping_packages/{shipping_package_id}` | Deletes a shipping package. A successful call returns `204` with no body. |
| [Update a shipping package](https://exsited.mintlify.site/api-reference/shipping-packages/update-a-shipping-package.md) | PATCH | `/settings/shipping_packages/{shipping_package_id}` | Changes a shipping package and returns it. |

## Before you call

Register your API credentials once when your app starts, as shown in
[Authentication](https://exsited.mintlify.site/authentication.md). Every SDK sample on these pages then gets its client in one line.
With cURL, send the access token in an `Authorization` header: `Authorization: Bearer $ACCESS_TOKEN`.

## Things to know

* **Writes are wrapped in `shipping_package`, and one package comes back under `shipping_package`.** The example create sends a `name`, a `length` and a `weight`.
* **Dimensions are numbers.** `length`, `width`, `height` and `weight` take numbers such as `10` or `1.5`.
* **A `*_uom` field takes the unit's bare uuid.** Not the unit's prefixed `id` from `GET /settings/uom`.
* **The listing pages by cursor.** Pass `limit`, then send the `next_cursor` from `pagination` as `cursor` until `has_more` is `false`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.