---
title: "order.return.update"
method: PUT
path: "/order.return.update.json"
tags: ["order"]
---

# order.return.update

`PUT /order.return.update.json`

## Request

- Base URL: `https://api.api2cart.com/v1.1`
- URL: `https://api.api2cart.com/v1.1/order.return.update.json`
- Auth: API key in header `x-api-key` and API key in header `x-store-key`

Update order's shipment information.

## Request body

- OrderReturnUpdate
  - `return_id` string, required: Return ID
  - `order_id` string: Defines the order id
  - `store_id` string: Store Id
  - `item_restock` boolean: Boolean, whether or not to add the line items back to the store inventory.
  - `return_status_id` string: Defines return request status
  - `return_reason_id` string: Defines return request reason
  - `return_action_id` string: Defines return request action
  - `staff_note` string: Specifies staff note
  - `comment` string: Specifies return comment
  - `message` string: Customer-visible message attached to the return request (updated).
  - `send_notifications` boolean: Send notifications to customer after order was created
  - `reject_reason` string: Defines return reject reason
  - `return_action` string: Defines return request action
  - `return_reason` string: Defines return request reason
  - `is_online` boolean: Indicates whether refund type is online
  - `fee_price` number: Specifies refund's fee price
  - `shipping_price` number: Specifies order's shipping price
  - `idempotency_key` string: A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>
  - `order_products` object[], required
    - `order_product_id` string, required: Defines which products from the order should be returned
    - `order_product_quantity` integer, required: Defines how many product units from the order should be returned
    - `order_product_status` string: Defines product return status
    - `order_product_action_id` string, required: Defines the ID of the return action

## Response `200`

successful operation

- object
  - `return_code` integer
  - `return_message` string
  - `result` object
    - `updated_items` integer

---

[API](https://skmtc.dev/api2cart/apis/api2cart-openapi.md) · [All operations](https://skmtc.dev/api2cart/apis/api2cart-openapi/llms.txt) · [OpenAPI document](https://skmtc.dev/api2cart/apis/api2cart-openapi/revisions/c34440741693?raw)