Skip to main content
POST

Authorizations

Authorization
string
header
required

Token returned by POST /auth/token, sent as Authorization: Bearer <token>.

Body

application/json
store_id
integer
required

Id of the store the order belongs to.

Example:

1234

order_number
string
required

Your identifier for the order. Must be unique within the store.

Example:

"PS-0001"

shipping
object
required

Recipient and delivery address. Billing data is copied from this block.

packages
object[]
required

Physical packages to label; one label is generated per entry.

Minimum array length: 1
shipping_method_id
integer

Id of a Cubbo shipping method. Get it from GET /shipping-methods/quote: each option in the response has a shipping_method_id. Exactly one of shipping_method_id or integration_shipping_method must be sent. Coverage for the destination is validated through the order validation (errors response).

Example:

12

integration_shipping_method
string

Exact name of a shipping method you created in the Cubbo app, under Integrations, your Open API integration, Shipping Methods (field Integration Delivery Method). It must match character by character: the comparison is case-sensitive and does not trim spaces. Cubbo uses the shipping configuration assigned to that method to pick the carrier. See Set up your integration. Exactly one of shipping_method_id or integration_shipping_method must be sent. There is no fallback here: an unknown name returns 422 MISSING_INTEGRATION_SHIPPING_METHOD.

Example:

"Express"

products
object[]

Optional content description of the parcel; each SKU must exist in the store.

Response

Order created and packed; one shipping label per requested package.

id
integer

Shipping label id; use it with GET /shipping-labels/{shipping_label_id}.

Example:

778899

order_id
integer

Id of the order that was created.

Example:

987655

billing_file
object | null

Carrier billing document when the carrier provides one; otherwise null.

shipping_number
string | null

Carrier tracking number.

Example:

"1234567890"

label_file
object

Downloadable file. An empty object when no file is attached.

label_type
string

Kind of label, normally shipping.

Example:

"shipping"

tracking_url
string | null

Carrier tracking page.

Example:

"https://carrier.example.com/track/1234567890"

cubbo_tracking_url
string | null

Cubbo tracking page for the order.

Example:

"https://tracking.cubbo.com/t/abc123"