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

Organization access token with orders.write

OAuth access with orders.write

Path Params
string
required

Provide the ID of the related order.

string
required

Provide the ID of the related order.

Body Params
string

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

string

A link pointing to an image of the product sold.

string

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

string
length ≤ 64

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

Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.

integer
≥ 1

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

unitPrice
object

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

discountAmount
object

In v2 endpoints, monetary amounts are represented as objects with a currency and value field.

totalAmount
object

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

vatAmount
object

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

string

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

boolean

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.

Responses

Language
Credentials
Request
Response
Choose an example:
application/hal+json