Returns

Create Return

Creates a return.

POST

/v1/orders/returns

Create Return

curl --request POST \
  --url 'https://public-api.bladepro.io/v1/orders/returns?expand=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": "<any>",
  "reference": "<string>",
  "third_party_tracking_number": "<string>"
}
'

{
  "data": {
    "created": "2019-11-25T14:52:56.000Z",
    "id": 1,
    "modified": "2019-11-25T14:52:56.000Z",
    "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",
    "warehouse_id": 1
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP::RETURNS::MANAGE

Query Parameters

expandstringquery

Usage: expand=*

Expand order_return_items

Body

itemsanyrequired

List of items.

referencestringrequired

Order specific reference.

third_party_tracking_numberstring

Third party tracking number.

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