Sign in
Orders

Create an order adjustment

Create an adjustment (eg. refund) for an order.

post/v4/orders/{orderId}/adjustments

Path parameters

orderIdstring required

The Slope order ID or the partner external order ID

Request body

type'refund' required

The type of adjustment

externalIdstring

The partner assigned Order Adjustment external ID

Example request

{
  "externalId": "ext_ordadj_123",
  "refund": {
    "amount": 1000
  }
}

Response

The created adjustment

idstring required

The adjustment ID

createdAtstring date-time required

When the adjustment was created

type'refund' | 'dispute' required

The type of adjustment

orderIdstring required

The Slope assigned order ID this adjustment is for

externalOrderIdstring

The partner external order ID this adjustment is for

externalIdstring

The partner external order adjustment ID

status'pending' | 'succeeded' | 'failed' required

The status of the adjustment

Example response

{
  "id": "ordadj_123",
  "orderId": "ord_123",
  "externalOrderId": "ext_ord_123",
  "externalId": "ext_order_adjustment_123",
  "refund": {
    "amount": -1000,
    "merchantFee": -100
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.