Skip to content
Merchant API/
/
Update an order

Update an order

Request

Update an authorized order's amount, order number, PO number, line items, or metadata. At least one field must be provided.

Security
bearerAuth or basicAuth
Path
order_idstringrequired

ID of the order to update.

Bodyapplication/json

Fields to update on an authorized order. At least one field must be provided.

non-empty
amountnumber, (double), >= 0

Updated authorization amount in USD.

Example:1200
order_numberstring

Updated internal order number.

Example:"5055"
po_numberstring

Updated purchase order number.

Example:"PO-555"
line_itemsArray of objects, non-empty(OrderLineItem)

Updated line items for the order.

curl -i -X PUT \
  'https://docs.resolvepay.com/_mock/merchant-api/openapi/orders/{order_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 1200,
    "order_number": "5055",
    "po_number": "PO-555",
    "line_items": [
      {
        "name": "Widget A",
        "quantity": 2,
        "unit_price": 50,
        "sku": "ABC-123",
        "total_price": 100,
        "type": "product",
        "tax_amount": 8.5
      }
    ]
  }'

Responses

An object representing an order.

Bodyapplication/json
idstring

Unique identifier for the order.

Example:"ORDlaE5wbg0"
checkout_idstring

ID of the checkout session associated with this order.

Example:"CHKabc123"
numberstring

Order number identifier.

Example:"ord_100001"
po_numberstring

Purchase order number associated with the order.

Example:"PO-555"
advance_requestedboolean

Whether an advance was requested for this order.

Example:false
sourcestring

Source channel that created the order.

Example:"checkout"
statusstring

Current status of the order.

Example:"authorized"
amount_authorizednumber, (double)

Total authorized amount for the order in USD.

Example:1000
amount_capturednumber, (double)

Total captured amount for the order in USD.

Example:500
amount_cancelednumber, (double)

Total canceled amount for the order in USD.

Example:0
amount_remainingnumber, (double)

Remaining authorized amount available for capture in USD.

Example:500
first_captured_atstring or null, (date-time)

Timestamp of the first capture event.

Example:"2024-01-15T10:00:00.000Z"
line_itemsArray of objects(OrderLineItem)

Line items associated with the order.

authorization_expires_atstring, (date-time)

Timestamp when the authorization expires.

Example:"2024-02-15T10:00:00.000Z"
authorization_expiry_sourcestring

Source that determined the authorization expiry.

Example:"system"
capture_eventsArray of objects(OrderCaptureEvent)

List of capture events for this order.

authorized_atstring, (date-time)

Timestamp when the order was authorized.

Example:"2024-01-01T00:00:00.000Z"
updated_atstring, (date-time)

Timestamp when the order was last updated.

Example:"2024-01-15T10:00:00.000Z"
customerobject(OrderCustomer)
Response
{
  "id": "ORDlaE5wbg0",
  "checkout_id": "CHKabc123",
  "number": "ord_100001",
  "po_number": "PO-555",
  "advance_requested": false,
  "source": "checkout",
  "status": "authorized",
  "amount_authorized": 1000,
  "amount_captured": 500,
  "amount_canceled": 0,
  "amount_remaining": 500,
  "first_captured_at": "2024-01-15T10:00:00.000Z",
  "line_items": [
    { … }
  ],
  "authorization_expires_at": "2024-02-15T10:00:00.000Z",
  "authorization_expiry_source": "system",
  "capture_events": [
    { … }
  ],
  "authorized_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-15T10:00:00.000Z",
  "customer": {
    "id": "X50sgfRd",
    "name": "Acme Corp",
    "remaining_credit": 5000
  }
}