Sign in

v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB
Orders API

Update order line

⚠️ We no longer recommend using the Orders API. Please refer to the Payments API instead.

Update an order line belonging to an order. Only lines with status created, pending, or authorized can be updated.

This endpoint is useful for cases where specific details of an order line are changed. For example, if a customer changes a red shirt for a blue one of the same model. In this case only specific properties of the order line need to be updated, such as the name, the imageUrl, and perhaps the amount.

To swap out an order line for an entirely new order line, use the Manage order lines endpoint instead.

For an in-depth explanation of each parameter, refer to the lines parameter of the Create order endpoint.

🔑 Access with

API key

Advanced access token with orders.write

OAuth access with orders.write

patch/orders/{orderId}/lines/{orderlineId}

Request body

namestring

A description of the line item. For example LEGO 4440 Forest Police Station.

imageUrlstring

A link pointing to an image of the product sold.

productUrlstring

A link pointing to the product page in your web shop of the product sold.

skustring

The SKU, EAN, ISBN or UPC of the product sold.

quantityinteger

Required when a unitPrice, discountAmount, totalAmount, vatAmount, or vatRate is also provided in the same request.

vatRatestring

Required when a quantity, unitPrice, discountAmount, totalAmount, or vatAmount is also provided in the same request.

testmodeboolean

Whether the entity was created in test mode or live mode. This field does not update the mode of the entity.

Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode to true.

Example request

{
  "name": "Ready Player One",
  "imageUrl": "https://www.example.com/image",
  "productUrl": "https://www.example.com/product",
  "sku": "978-1524763282",
  "quantity": 2,
  "unitPrice": {
    "currency": "EUR",
    "value": "10.00"
  },
  "discountAmount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "totalAmount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "vatAmount": {
    "currency": "EUR",
    "value": "10.00"
  }
}

Response

The updated order object.