Returns responses

Return order

The possible responses for a return order are:

Status	Meaning	Description
200	OK	The response [success] the webhook expects from your application endpoint.

This operation does not require authentication.

Return request

The possible responses for a return request are:

Status	Meaning	Description
200	OK	The return request order was found and has data available for a response.
404	Not Found	The completed order details could not be found based on the provided order_reference and email_address
502	Bad Gateway	The return request order details could not be fetched from the connected Order Management Platform due to a request failure when communicating with the Order Management Platform.

This operation does not require authentication.

Examples

Example responses

Successful responses

200 response:

{
  "return_request": {
    "id": 1355,
    "reference": "#1001",
    "api_reference": "845450641471",
    "date": "2019-04-11T03:30:30+00:00",
    "customer": {
      "id": 1348,
      "api_reference": "1047141580863",
      "email": "test@shippit.com",
      "firstname": "John",
      "lastname": "Wick"
    },
    "billing_address": {
      "id": 1291,
      "firstname": "John",
      "lastname": "Wick",
      "street": [
        "10 Flinders Street"
      ],
      "suburb": "Sydney",
      "postcode": "2000",
      "region": "New South Wales",
      "region_code": "NSW",
      "country": "Australia",
      "country_code": "AU"
    },
    "shipping_address": {
      "id": 1290,
      "firstname": "John",
      "lastname": "Wick",
      "street": [
        "10 Flinders Street"
      ],
      "suburb": "Sydney",
      "postcode": "2000",
      "region": "New South Wales",
      "region_code": "NSW",
      "country": "Australia",
      "country_code": "AU"
    },
    "items": [
      {
        "id": 1890,
        "api_reference": "1936837640255",
        "sku": "TACO",
        "name": "Single Taco",
        "weight": 0.5,
        "options": [
          {
            "api_reference": "2380278235199",
            "label": "Title",
            "value": "Default Title"
          }
        ],
        "qty": 1,
        "qty_ordered": 1,
        "qty_shipped": 0,
        "qty_refunded": 0,
        "non_return_reason": "This product cannot be returned because it is a sale item",
        "price": 20,
        "original_price": 20,
        "discount_amount": 0,
        "tax": 2,
        "is_price_incl_tax": true,
        "image_url": "https://cdn.shopify.com/s/files/1/0083/3798/1503/products/Taco.jpeg?v=1554966383",
        "is_virtual": false
      }
    ],
    "currency_code": "AUD",
    "subtotal": 20,
    "tax_amount": 2,
    "shipping_amount": 10,
    "grand_total": 32,
    "merchants": [],
    "created_at": "2019-04-12T00:07:19+00:00",
    "updated_at": "2019-04-12T00:07:19+00:00"
  }
}