---
displayed_sidebar: homepage
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# StoreReturnsRes

 **StoreReturnsRes**: `Object`

The return's details.

## Type declaration

<ParameterTypes parameters={[
  {
    "name": "return",
    "type": "[Return](../../entities/classes/entities.Return.mdx)",
    "description": "Return details.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "claim_order",
        "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
        "description": "The details of the claim that the return may belong to.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": []
      },
      {
        "name": "claim_order_id",
        "type": "`null` \\| `string`",
        "description": "The ID of the claim that the return may belong to.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "created_at",
        "type": "`Date`",
        "description": "The date with timezone at which the resource was created.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The return's ID",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "idempotency_key",
        "type": "`null` \\| `string`",
        "description": "Randomly generated key used to continue the completion of the return in case of failure.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "items",
        "type": "[ReturnItem](../../entities/classes/entities.ReturnItem.mdx)[]",
        "description": "The details of the items that the customer is returning.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": []
      },
      {
        "name": "location_id",
        "type": "`null` \\| `string`",
        "description": "The ID of the stock location the return will be added back.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "metadata",
        "type": "`null` \\| `Record<string, unknown>`",
        "description": "An optional key-value map with additional details",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "no_notification",
        "type": "`null` \\| `boolean`",
        "description": "When set to true, no notification will be sent related to this return.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "order",
        "type": "[Order](../../entities/classes/entities.Order.mdx)",
        "description": "The details of the order that the return was created for.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": []
      },
      {
        "name": "order_id",
        "type": "`null` \\| `string`",
        "description": "The ID of the order that the return was created for.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "received_at",
        "type": "`Date`",
        "description": "The date with timezone at which the return was received.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "refund_amount",
        "type": "`number`",
        "description": "The amount that should be refunded as a result of the return.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "shipping_data",
        "type": "`Record<string, unknown>`",
        "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "shipping_method",
        "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)",
        "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": []
      },
      {
        "name": "status",
        "type": "[ReturnStatus](../../entities/enums/entities.ReturnStatus.mdx)",
        "description": "Status of the Return.",
        "optional": false,
        "defaultValue": "requested",
        "expandable": false,
        "children": []
      },
      {
        "name": "swap",
        "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
        "description": "The details of the swap that the return may belong to.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": []
      },
      {
        "name": "swap_id",
        "type": "`null` \\| `string`",
        "description": "The ID of the swap that the return may belong to.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "updated_at",
        "type": "`Date`",
        "description": "The date with timezone at which the resource was updated.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} />
