Skip to main content
POST
Add a shipping box

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Replo-Api-Version
enum<string>
required

The public API version to use for this request.

Available options:
2026-11-17

Body

application/json
projectId
string<uuid>
required

Project to add the box to.

name
string
required
Required string length: 1 - 255
carrierPackage
string | null
required
Required string length: 1 - 64
lengthMm
integer | null
required
Required range: x <= 3000
widthMm
integer | null
required
Required range: x <= 3000
heightMm
integer | null
required
Required range: x <= 3000
weightGrams
integer
required
Required range: 0 <= x <= 70000
type
enum<string>

The box's shape: "box", "envelope" or "softPack". A new box without one is a "box".

Available options:
box,
envelope,
softPack
isDefault
boolean

True makes this the default box. A project's first box is always the default.

Response

Add a shipping box

id
string<uuid>
required
name
string
required
Required string length: 1 - 255
type
enum<string>
required

ShippingPackageType

Available options:
box,
envelope,
softPack
carrierPackage
string | null
required
Required string length: 1 - 64
lengthMm
integer | null
required
Required range: x <= 3000
widthMm
integer | null
required
Required range: x <= 3000
heightMm
integer | null
required
Required range: x <= 3000
weightGrams
integer
required
Required range: 0 <= x <= 70000
isDefault
boolean
required
object
enum<string>
required
Available options:
shipping_package