OR32 - Adjust order line

Request

Description

Update order line actual measurement either upwards or downwards, within the limit defined at the platform level.

Error Codes

Code	Description
`ORDER_ADJUSTMENT_FEATURE_DISABLED`	The order adjustment feature is not enabled
`ORDER_LINE_ADJUSTMENT_EQUAL_TO_ORDERED`	The actual measurement equals the ordered measurement
`ORDER_LINE_ADJUSTMENT_EXCEEDS_DOWNWARD_LIMIT`	The downward adjustment exceeds the allowed limit
`ORDER_LINE_ADJUSTMENT_EXCEEDS_UPWARD_LIMIT`	The upward adjustment exceeds the allowed limit
`ORDER_LINE_ALREADY_ADJUSTED`	The order line has already been adjusted
`ORDER_LINE_ALREADY_REFUNDED`	The order line has already been refunded
`ORDER_LINE_DUPLICATE_ID`	The order lines list contains duplicate order line IDs
`ORDER_LINE_INVALID_STATE`	Order lines are not in the expected state for this operation
`ORDER_LINE_MISSING_MEASUREMENT`	The order line does not have a measurement unit
`ORDER_LINE_NOT_FOUND`	The requested order line does not exist or is not associated with the order
`ORDER_LINE_PAY_PER_SHIPMENT_NOT_ADJUSTABLE`	The order line cannot be adjusted with the current pay-per-shipment state
`ORDER_LINE_PAY_PER_SHIPMENT_WAITING_DEBIT`	The order line is part of a shipment waiting for debit
`ORDER_LINE_ZERO_AMOUNT`	The order line amount is zero
`VALIDATION_ERROR`	Input validation failed

Call Frequency

Recommended usage: At each adjustment of one or multiple order lines

Maximum usage: Once per minute, 100 order lines per call

Security

Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_ORDER_ADJUST)

Query

shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

Bodyapplication/json

order_linesArray of objects, [ 1 .. 100 ] itemsrequired

Order lines to be updated, maximum number of order lines per call: 100

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/orders/adjust?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_lines": [
      {
        "actual_measurement": 0.85,
        "order_line_id": "ORDER_0014-A-1"
      },
      {
        "actual_measurement": 1,
        "order_line_id": "ORDER_9999-A-1"
      }
    ]
  }'

Responses

OK

Bodyapplication/json

order_lines_adjustedArray of objects

A list of updated order lines and orders in error objects

Response

{
  "order_lines_adjusted": [
    { … },
    { … }
  ]
}