Returns

List Order Returns

List order returns

GET

/v1/orders/returns

List Order Returns

curl --request GET \
  --url 'https://public-api.bladepro.io/v1/orders/returns?expand=%3Cstring%3E&status%5BIN%5D=%3Cany%3E&status%5BNOT_IN%5D=%3Cany%3E&order.channel.id%5BIN%5D=%3Cstring%3E&order.channel.id%5BNOT_IN%5D=%3Cstring%3E&warehouse.id%5BIN%5D=%3Cstring%3E&created%5BLESS_THAN%5D=%3Cany%3E&created%5BON_DATE%5D=%3Cany%3E&created%5BMORE_THAN%5D=%3Cany%3E&sorting=id'

{
  "data": [
    {
      "created": "2019-11-25T14:52:56.000Z",
      "id": 1,
      "modified": "2019-11-25T14:52:56.000Z",
      "order": {
        "channel": {
          "created": "2019-11-25T14:52:56.000Z",
          "id": 321,
          "modified": "2019-11-25T14:52:56.000Z",
          "name": "Demo Channel",
          "organisation": {
            "active": true,
            "contact_email": "joe.bloggs@example.com",
            "contact_mobile": "+44 00000000",
            "contact_name": "Mr Joe Bloggs",
            "contact_phone": "+44 01425 000 000",
            "created": "2019-11-25T14:52:56.000Z",
            "id": 1,
            "modified": "2019-11-25T14:52:56.000Z",
            "name": "Demo",
            "notes": "Demo account...",
            "vat_number": "GB999 9999 73"
          },
          "organisation_id": 321,
          "short_code": "DEMO",
          "status": "active"
        },
        "id": 1234567,
        "reference": "#154254",
        "status": "open"
      },
      "order_id": 1,
      "order_return_items": [
        {
          "action": "refund",
          "authorisation_required": "NO",
          "correct_item": "YES",
          "created": "2019-11-25T14:52:56.000Z",
          "description": "Damaged in box",
          "exchanged_product_component_id": 1,
          "expected_quantity": 2,
          "expiry_date": "2019-11-25T14:52:56.000Z",
          "id": 1,
          "modified": "2019-11-25T14:52:56.000Z",
          "order_goodsout_line_id": 1,
          "order_goodsout_line_item_id": 1,
          "order_return_id": 1,
          "order_return_item_reason_id": 1,
          "product_component_id": 1,
          "received_date": "2019-11-25T14:52:56.000Z",
          "received_quantity": 2,
          "rejected_reason": "Outside agreed return window",
          "resellable": "NO",
          "sku": "DEMO-SKU-01",
          "status": "pending"
        }
      ],
      "shipping_address_id": 1,
      "status": "pending",
      "tags": [
        {
          "description": "Processed by a 3rd party system",
          "name": "Processed",
          "shortcode": "processed"
        }
      ],
      "warehouse": {
        "active": true,
        "country_id": 1,
        "created": "2019-11-25T14:52:56.000Z",
        "currency_id": 1,
        "id": 1,
        "latitude": 50.739492,
        "longitude": -1.734224,
        "modified": "2019-11-25T14:52:56.000Z",
        "name": "Christchurch",
        "return_warehouse_id": 1,
        "short_code": "CHR",

Fuzzy search available

Scope(s): APP::RETURNS::READ

Query Parameters

expandstringquery

Usage: expand=*

Expand order, order.channel, order.channel.organisation, order_return_items, order_return_items.component, order_return_items.exchange_component, order_return_items.reason, tags, warehouse

status[IN]anyquery

Filter for status of the return (IN)

status[NOT_IN]anyquery

Filter for status of the return (NOT_IN)

order.channel.id[IN]stringquery

Filter for order channel. (IN)

order.channel.id[NOT_IN]stringquery

Filter for order channel. (NOT_IN)

warehouse.id[IN]stringquery

Filter for the warehouse dealing with the return. (IN)

created[LESS_THAN]anyquery

Filter for created date in bladepro. (LESS_THAN)

created[ON_DATE]anyquery

Filter for created date in bladepro. (ON_DATE)

created[MORE_THAN]anyquery

Filter for created date in bladepro. (MORE_THAN)

sortingenum<string>query

Sort by id, received_date (prefix with '-' for descending order).

Available options: id, -id, received_date, -received_date

Response

successful operation

createdany

Created date in BladePRO.

idnumber

ID.

modifiedany

Last modified date in BladePRO.

orderobject

The order related to the return.

order_idnumber

Order Id the return is attached to.

order_return_itemsany

The items being returned.

shipping_address_idnumber

Shipping Address Record.

statusenum<string>

Status of the return

Available options: draft, pending, received, rejected, awaiting_despatch, complete, delivered, customer_service

tagsany

Tags attached to the return.

warehouseobject

The warehouse dealing with the return.

warehouse_idnumber

The warehouse dealing with the return.

Still need help? Share an idea