Create Box

💡

Authentification

Bearer token authentication is required.

The box is always created for the currently authenticated user (user_id is taken from the token).

📌

Automatic fields

user_id: Automatically filled from the authenticated user and cannot be overridden.

weight: Defaults to 0 if not provided in the request.

💡

Behavior

Validates required fields (type, length, width, height, weight) before creation.

Persists the box with its full dimensions so it can be selected later in shipment flows.

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://app.gotreek.com/api/auth/login

Header Params

Body Params application/jsonRequired

Examples

curl --location --request POST 'https://app.gotreek.com/api/boxes' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "type": "primary", "length": 22, "width": 15, "height": 36, "weight": 3 }'

{ "success": true, "message": "Box created successfully", "data": { "id": 1, "type": "Small Box", "length": 33, "width": 14, "height": 8, "weight": 31, "user_id": 94, "created_at": "2025-07-21T13:05:41Z", "updated_at": "2025-07-21T13:05:41Z" } }

Request

Responses