BObossinsights
OrderReturn

Retrieves the collection of OrderReturn resources.

Retrieves the collection of OrderReturn resources.

get/order_returns

Request

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

OrderReturn collection

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

Unique identifier for each order return

amountinteger nullable

The total amount (price) for the returned order

createdstring date-time nullable

Date and time the order return was created

currencystring nullable

The currency the refund will be paid in

descriptionstring nullable

A description of the order return

quantityinteger nullable

The number of items within the return order

orderIdstring nullable

The ID of the original order

refundIdstring nullable

The ID of the refund issued for the order

Example response

[
  {
    "integration": "quickbooks"
  }
]

Changes

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