Skip to main content
GET
/
api
/
v1
/
order-returns
cURL
curl --request GET \
  --url https://api-staging.getmeadow.com/api/v1/order-returns \
  --header 'X-Client-Key: <api-key>' \
  --header 'X-Consumer-Key: <api-key>'
{
  "id": 123,
  "refundType": "<string>",
  "refundInitial": 123,
  "refundTotal": 123,
  "creditsTotal": 123,
  "discountsTotal": 123,
  "adjustmentAmount": 123,
  "adjustmentDescription": "<string>",
  "paymentTypeName": "<string>",
  "loyaltyTotal": 123,
  "voidedAt": "<string>",
  "voidedReason": "<string>",
  "createdAt": "<string>",
  "lineItems": [
    {
      "orderLineItemId": 123,
      "type": "<string>",
      "inventoryAction": "<string>",
      "quantity": 123,
      "reason": "<string>",
      "fulfillAs": [
        {}
      ]
    }
  ],
  "taxes": [
    {
      "amount": 123,
      "description": "<string>",
      "refunded": true,
      "rate": 123,
      "included": true,
      "exemptable": true
    }
  ],
  "createdBy": {
    "id": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "voidedBy": {
    "id": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  }
}

Authorizations

X-Consumer-Key
string
header
required

The key assigned to your company and provided via Meadow

X-Client-Key
string
header
required

The key generated and provided by our mutual client

Query Parameters

startingAfter
integer<int64>

The id for an order return that you want to retrieve all order returns after this one. Pass in the last id in a response to retrieve the next page.

voided
boolean

Pass in true if you would like to only receive voided returns. Voided returns are ones that were cancelled and are no longer considered valid.

Response

Order return response

id
number

The ID of this return

refundType
string

One of payment-method, store-credit or none

refundInitial
number

The initial refund before taxes, credits, adjustments, loyalty, and discounts

refundTotal
number

The final refund total of the return

creditsTotal
number

The amount of credits refunded from the order

discountsTotal
number

The amount of discounts refunded from the order

adjustmentAmount
number

A manual adjustment of the refund for this return

adjustmentDescription
string | null

A description for the adjustment if there is one

paymentTypeName
string

The name of the payment type this refund was processed as

loyaltyTotal
number

The amount of a loyalty redemption returned

voidedAt
string | null

The date that this return was voided or null. If there is a value here, it means the return was canceled and is no longer applicable

voidedReason
string | null

The reason this return was voided

createdAt
string

The date this return was created

lineItems
object[]

An array of line items for this return

taxes
object[]

An array of tax information about this return

createdBy
object

The employee that created this return

voidedBy
object

The employee that voided this return (or {} if it is not voided)