--- title: "Update Return" method: PUT path: "/wms/returns/{return_id}" tags: ["wms", "Returns"] --- # Update Return `PUT /wms/returns/{return_id}` Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint. ## Path parameters - `return_id` string, required ## Headers - `x-trackstar-api-key` string, required - `x-trackstar-access-token` string, required ## Request body - union - object - `trackstar_tags` unknown[], nullable — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown - `warehouse_id` string — The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. - `order_id` string — The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details. - `line_items` UpdateWmsReturnLineItemSchema[] — A list of inventory items included in the return. - `sku` string, required - `expected_quantity` integer, required - object - `trackstar_tags` unknown[], nullable — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown - `warehouse_id` string — The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. - `carrier_id` string — The carrier to use for the return shipment. One of carrier_id or carrier_name is required. Will take precedence over carrier_name if provided. - `carrier_name` string — The carrier to use for the return shipment - `tracking_number` string — The tracking number for the return shipment - `reference_number` string — The reference number for the return shipment - `ship_to_address` ReturnShipToAddressCirro - `full_name` string, required - `address1` string, required - `address2` string - `city` string, required - `state` string, required - `postal_code` string, required - `country` string, required - `line_items` WmsReturnWriteLineItemcirro[] — A list of inventory items included in the return. - `sku` string, required - `platform_name` 'AMAZON' | 'SHOPIFY' | 'EBAY' | 'WOOCOMERCE' | 'TIKTOK_SHOP' | 'WALMART' | 'SHEIN' | 'EASYSHIP' | 'IML' | 'LINNWORKS' | 'PRESTASHOP' | 'SKUBANA' | 'ETSY' | 'MINTSOFT' | 'CHANNELADVISOR' | 'SPSCOMMERCE' | 'SHIPSTATION' | 'SPRING' | 'WIX' | 'ECWID' | 'SQUARESPACE' | 'BIGCOMMERCE' | 'MAGENTO' | 'CART.COM' | 'CHORD' | 'XCART' | 'ACENDA' | 'COMMERCETOOLS' | 'VTEX' | 'SELLERACTIVE' | 'WAYFAIR' | 'MIRAKL' | 'HOUZZ' | 'APPARELMAGIC' | 'SALESFORCE' | 'SQUARE' — The name of the platform from which the sku originates. If provided, will be used to find the Cirro SKU. - `expected_quantity` integer, required - `return_reason` string — The reason for the return. Damaged, Defective, Incorrect Item, etc. - `order_id` string — The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details. - object - `trackstar_tags` unknown[], nullable — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown - `warehouse_id` string — The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. - `ship_to_address` ReturnShipToAddressDeposco - `full_name` string - `address1` string, required - `address2` string - `city` string, required - `state` string, required - `postal_code` string, required - `country` string, required - `line_items` WmsReturnWriteLineItemdeposco[], required — A list of inventory items included in the return. - `sku` string — The SKU of the product to return. - `inventory_item_id` string — Deprecated. Use `sku` instead. - `expected_quantity` integer, required - `order_id` string — The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details. - `number` string — An optional return number to use for the return. If not provided, a unique number will be generated. - `return_reason` string — The reason for the return. RTS, Partial Customer Return, Full Customer Return - `customer_order_number` string — The customer order number in Deposco - `tracking_number` string — The tracking number of the return - object - `trackstar_tags` unknown[], nullable — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown - `warehouse_customer_id` string, nullable — The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. Used for 3PL accounts. - `warehouse_id` string, required — The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. - `supplier_object` union, required - object - `supplier_id` string, required — The ID of the supplier. - object - `supplier_name` string, required — The name of the supplier. If supplier ID is provided, that will take precedence over this. - `return_type` 'Job' | 'Kit' | 'Normal' | 'Transfer' | 'Blind', required — Type of return - `order_id` string, required — The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details. - `line_items` WmsReturnWriteLineIteminfoplus[], required — A list of inventory items included in the return. - `sku` string, required - `expected_quantity` integer, required - object - `trackstar_tags` unknown[], nullable — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown - `order_id` string — The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details. - `warehouse_id` string — The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. - `rma_number` string — An optional RMA number. If not provided, a random one will be generated. - `line_items` WmsReturnWriteLineItemlogiwaIo[] — A list of inventory items included in the return. - `sku` string, required - `expected_quantity` integer, required - `tracking_number` string — The tracking number of the return. - object - `trackstar_tags` unknown[], nullable — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown - `return_type` 'returned_to_sender' | 'rma_submitted_by_customer' | 'rma_created_by_distribution_center', required — The type of return. - `ship_from_address` ShipFromAddressMasonhub, required - `full_name` string, required - `address1` string, required - `address2` string - `city` string, required - `state` string, required - `postal_code` string, required - `country` string, required - `line_items` WmsReturnWriteLineItemmasonhub[], required — A list of inventory items included in the return. - `sku` string, required - `expected_quantity` integer, required - `return_reason` 'tooBig' | 'tooSmall' | 'damaged' | 'wrongItem' | 'other', required — Customer supplied reason code for this return - `return_inventory_status` 'available' | 'qc' | 'damaged' | 'quarantine' — The inventory status to return the units into. - `order_id` string — The ID of the original order. - object - `line_items` WmsReturnWriteLineItemongoing[] — A list of inventory items included in the return. - `sku` string, required - `expected_quantity` integer, required - `return_cause` ReturnCause - `code` 'N/A', required — The reason code for this return. - `return_reason` 'Connect an account to get return causes.', nullable — The reason description for this return. - `warehouse_id` string — The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. - `tracking_number` string - `tracking_url` string - `trackstar_tags` unknown[], nullable — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown - object - `trackstar_tags` unknown[], nullable — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown - `warehouse_id` 'N/A - Connect an account to see options' — The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. - `order_id` 'N/A - Connect an account to see options' — The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details. - `line_items` WmsSandboxUpdateReturnLineItems[] — A list of inventory items included in the return. - `sku` 'N/A - Connect an account to see options', required — sku - `expected_quantity` integer, required - `return_reason` string — The reason for the return. - object - `trackstar_tags` unknown[], nullable — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown - `warehouse_id` string, required — The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. - `line_items` WmsReturnWriteLineItemshipbob[], required — A list of inventory items included in the return. - `inventory_item_id` string, required - `expected_quantity` integer, required - `tracking_number` string — Tracking number of the return. - object - `status` 'open' | 'in-transit' | 'receiving' | 'received' | 'cancelled' | 'other', required — The status of the return. See the [return information](info) for more details. - `trackstar_tags` unknown[], nullable, required — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown - object - `trackstar_tags` unknown[], nullable — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown - `order_id` string, required — The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details. - `warehouse_id` string, required — The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. - `return_reason` 'reason_exchange' | 'reason_changed_mind' | 'reason_undeliverable' | 'reason_unknown' | 'reason_incorrect_product', required — Reason for the return. - `tracking_number` string — The tracking number for the return. - `line_items` WmsReturnWriteLineItemshipmonk[], required — A list of inventory items included in the return. - `sku` string, required - `expected_quantity` integer, required - `desired_action` 'received_back_into_inventory' | 'damaged_not_resellable', required — Desired action for the returned item. - object - `trackstar_tags` unknown[], nullable — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown - `warehouse_id` string — The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. - `line_items` WmsReturnWriteLineItemshipstream[] — A list of inventory items included in the return. - `sku` string, required - `expected_quantity` integer, required - `carrier_id` string — Carrier ID. Will take precedence over carrier_name if passed. - `carrier_name` string — Carrier name. - `carrier_tracking_number` string — Carrier tracking number - `customer_name` string — Customer name - `merchant_order_number` string — Merchant order number - `tracking_numbers` string[] — List of tracking numbers - `merchant_rma_number` integer — Merchant RMA number - `expected_arrival_date` string, date — Expected arrival date - `notes` string — Notes - object - `requires_label` boolean — Whether or not a label is required. - `carrier_id` string — The carrier for the return. Defaults to 'Whiplash'. - `tracking_number` string - `trackstar_tags` unknown[], nullable — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown ## Response `200` Successful response - WmsUpdateReturnResponse - `data` WmsReturnApiItemSchema - `id` string, required — The unique ID of the return. - `warehouse_customer_id` string, nullable, required — The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. - `created_date` string, date-time, required — The date the return was created. - `updated_date` string, date-time, required — The date the return was last updated. - `status` 'open' | 'in-transit' | 'receiving' | 'received' | 'cancelled' | 'other', required — The status of the return. See the [return information](info) for more details. - `raw_status` string, nullable, required — The raw status (if available) returned directly from the WMS. - `order_id` string, nullable, required — The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details. - `notes` string[], required — A list of notes associated with the return. - `line_items` WmsReturnLineItem[], required — A list of inventory items included in the return. - `inventory_item_id` string, required — Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details. - `sku` string, nullable, required - `expected_quantity` integer, required — How many units are expected to arrive. - `received_quantity` integer, required — How many units actually arrived. - `restocked_quantity` integer, nullable, required — The number of returned inventory items that have been restocked. - `return_reason` string, nullable, required — The reason for the return. - `shipments` ReturnShipment[], required — List of the shipments associated with the return. - `tracking_number` string, nullable, required — The tracking number of the shipment. - `shipped_date` string, date-time, nullable, required — The date the shipment was sent. - `arrived_date` string, date-time, nullable, required — The date the shipment arrived. - `warehouse_id` string, nullable, required — The ID of the warehouse the shipment was sent to. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. - `carrier_id` string, nullable, required — The ID of the carrier for the shipment. - `carrier_name` string, nullable, required — The name of the carrier for the shipment. - `scac` string, nullable, required — The Standard Carrier Alpha Code (SCAC) for the shipment. - `shipping_cost` number, nullable, required — The cost of the shipment. - `measurements` ShipmentMeasurements, required - `length` number, nullable, required - `width` number, nullable, required - `height` number, nullable, required - `unit` 'cm' | 'in', nullable, required — The unit of measurement for the size of the shipment. - `weight` number, nullable, required - `weight_unit` 'kg' | 'oz' | 'lb', nullable, required — The unit of measurement for the weight of the shipment. - `line_items` ReturnShipmentLineItem[], required — List of inventory items items in the shipment. - `inventory_item_id` string, required — Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details. - `sku` string, nullable, required - `quantity` integer, required — How many units were shipped. - `receiving_details` ReceivingDetails[], required — Details about received items in the shipment. - `quantity` integer, required — How many units were received in this condition and disposition. - `condition` string, nullable, required — The condition of the item received. - `disposition` string, nullable, required — The disposition of the item received, eg restocked or discarded. - `external_system_url` string, nullable, required — URL link to the return in the external system (WMS/Freight etc). - `trackstar_tags` unknown[], nullable, required — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown - `additional_fields` object, required — Integration-specific fields - `trackstar_created_date` string, date-time, required - `trackstar_updated_date` string, date-time, required - `id` string, required — The ID of the object that has been created or modified - `unused_fields` string[], required — Unused fields ## Other responses - `404` — Not found - `422` — Validation error --- [API](https://skmtc.dev/trackstarhq/apis/trackstar-api.md) · [All operations](https://skmtc.dev/trackstarhq/apis/trackstar-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/trackstarhq/trackstar-api/revisions/4bc5c6e1a8bf/schema)