Update a pending order

Request

Updates an order. Can only be performed on orders that are still in the pending state.

payment_mode and payment_amount are the only attributes currently supported, and must be provided together.

When setting payment_mode to pre_paid, payment_amount must be 0.0. Otherwise payment_amount must be above 1.

Available payment modes are pre_paid and paid_on_delivery. cash_on_delivery and card_on_delivery are retired; they appear in inherited integrations, do not build against them.

Security

bearerToken or oauthToken

Path

order_idstringrequired

The order id returned as order.id when the order was created.

Bodyapplication/json

payment_modestringrequired

Enum:"pre_paid""paid_on_delivery"

payment_amountnumberrequired

0 when prepaid, above 1 for collection on delivery.

curl -i -X PUT \
  'https://api.staging.quiqup.com/orders/{order_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "payment_mode": "pre_paid",
    "payment_amount": 0
  }'

Responses

The body is the literal true, sent with no Content-Type header. It is not the updated order. Re-read the order with GET /orders/{order_id} if you need the new values.

Bodytext/plain

boolean

Response

true