Update order

What is it for?

Modifies the data of an existing order.

Conditions

  • Requires authentication.
  • Validations:
    • The order MUST be in one of these statuses:
    • → To be confirmed (TO_BE_CONFIRMED) (1)
    • → Pending (PENDING) (2)
    • → Ready to prepare (READY_TO_PREPARE) (3)
    • → Cancelled (CANCELED) (9)
    • If the order is in PICKING, PACKING, Prepared (PREPARED), Shipped (SHIPPED) or Returned (RETURNED):
    • Error: ORDER_CANNOT_BE_UPDATED (HTTP 409)
    • Message: "The order with ID {id} cannot be updated."
    • If any product_id or pack_id in the lines does not exist:
    • Error: PRODUCT_NOT_FOUND / PACK_NOT_FOUND (HTTP 422)
    • Side effects when updating:
    • → If you change the shipping address: packages/preparations are deleted
    • → If you change the order lines: stock is released and the order returns to Pending (PENDING) (2)
    • → The assigned courier and tracking number are removed

Parameters

Fill in the fields in Body Params, Query Params and/or Path Params as applicable.

Expected response

HTTP 200 → The order with the updated data

External Financial Status Reference

The external_financial_status field reflects the financial state coming from the external e-commerce platform (Shopify, WooCommerce, MercadoPago). Accepted values:

ValueMeaning
paidOrder has been paid
pendingOrder pending payment
refundedOrder has been refunded
partially_refundedOrder has been partially refunded

Note: When sent in a request (POST/PUT), the value is accepted as free string and stored as-is.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

ID

Body Params
integer | null

Payment method ID (can be null)

string | null

External payment method name

string | null

External financial status (e.g.: 'paid', 'pending')

date-time
required

Date and time the order was created (valid date/time format)

date-time | null

Date and time the order was paid (if applicable)

customer
object
required

Customer information

float
required

Total order taxes

float
required

Total shipping cost

float
required

Total discount applied to the order

string
required

Currency code (e.g.: 'EUR', 'USD')

lines
array of objects
required
length ≥ 1

Order line items (at least 1)

lines*
integer | null

Associated product ID (optional)

integer
required

Number of items in the line

float
required

Total cost for this line (subtotal)

string | null

External product ID

string | null

External product variant ID

integer | null

Pack ID (si aplica)

Responses

400

Malformed request or invalid data

401

Unauthorized (invalid or expired token)

422

Validation error

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json