Sign in

v1

latestOpenAPI 3.0.02026-07-244074117.0 KB
Orders

Get an order adjustment

Get details about an order adjustment.

get/v4/orders/{orderId}/adjustments/{id}

Path parameters

orderIdstring required

The Slope order ID or the partner external order ID

idstring required

The Slope order adjustment ID or the partner external order adjustment ID

Response

The order 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
  }
}