put
https://api.gobeeping.com/api/v1/client/orders/
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:
| Value | Meaning |
|---|---|
| paid | Order has been paid |
| pending | Order pending payment |
| refunded | Order has been refunded |
| partially_refunded | Order 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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
400Malformed request or invalid data
401Unauthorized (invalid or expired token)
422Validation error
