orders

Update one order

Replaces THREE legacy routes — patch, resolve-design and resolve-label — because from a seller's point of view they were one act: here is the missing piece, put my order back in the queue. What you send decides which.

Sending image_url to an order that is ON_HOLD releases it back to where it was held from. Sending label_url and tracking_number together attaches a shipment through the same code path the scan stations use, so the seller notification and the audit trail are identical.

Absent means leave it alone. Unknown field names are rejected rather than ignored — a typo you can see beats a silent no-op.

quantity is the one field locked after assignment: it changes what somebody has to make.

Send an Idempotency-Key when you may retry, for example from an offline queue: a replayed label link then returns the first answer instead of attaching again.

patch/orders/{id}

Request

  • Base URL: https://0.0.0.0:3000/api/v1
  • URL: https://0.0.0.0:3000/api/v1/orders/{id}
  • Auth: API key in header x-api-key

Path parameters

idinteger required

The order id.

Headers

Idempotency-Keystring

Optional. Reuse the same value on every retry of the same update; see Idempotency.

Request body

notestring

Free text for the floor.

quantityinteger

Only while the order is still PENDING.

add_onboolean

true or false ticks or unticks the product's add-on and re-prices the order. Only while it is PENDING and not yet charged.

image_urlstring

The design. Releases an ON_HOLD order.

external_idstring

Your own order id.

deadlinestring

When it must ship by.

shippingobject

Any of name, company, email, phone, line1, line2, city, state, zip, country. When sent, name, line1, city, state, zip and country must be real values — a placeholder such as 1, or an empty value over a real one, is refused and named in error.fields. A state you send must be its two-letter code, e.g. IL.

label_urlstring

A label you bought yourself. Must be sent with tracking_number.

tracking_numberstring

Must be sent with label_url.

carrierstring

Optional carrier name for the shipment.

Response

The updated order in full, so you never need a follow-up GET. meta.released says whether a hold was lifted.

Changes

No recorded changes to this operation across all 1 revision of this API.