Skip to main content
POST
Create a prepackaged preset for a product

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key
string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours. Pattern: or --.

Maximum string length: 255

Path Parameters

id
string<uuid>
required

UUID of the product to attach the preset to.

Body

application/json
label
string

Operator-facing preset label.

Maximum string length: 100
length
number

Outer length (inches).

width
number

Outer width (inches).

height
number

Outer height (inches).

weight
number

Package weight (lbs).

quantity
integer
default:1

Units of the product per package configuration.

quantity_uom
string
default:EA

Unit of measure for quantity.

box_product_id
string<uuid> | null

Optional box/packaging product reference.

Response

Prepackaged preset created.

The response is of type object.