Add order-line-items of order processed by Ratepay

You can add a debit or credit to the processed order by Ratepay. It is required that at least one order-item has been marked as shipped and not returned.

SecurityoAuth
Request
path Parameters
orderId
required
string^[0-9a-f]{32}$

Identifier of the order

Request Body schema: application/json
grossAmount
required
number

Gross amount of debit/credit. Have to be negative for credits.

name
required
string

Description of the order-line-item.

taxId
required
string^[0-9a-f]{32}$

Tax-id to apply

Responses
204

Item(s) has been successfully added

400

The provided order-line-items does not belongs to the order, or the quantity is zero.

404

The order does not exist.

500

An error occurred during the adding

post/_action/order/{orderId}/ratepay/addItem
Request samples
application/json
{
  • "grossAmount": -5,
  • "name": "Discount for damaged goods",
  • "taxId": "a06c753d068c487991d6a833b4133560"
}
Response samples
application/json
{
  • "status": false,
  • "message": "string"
}