---
title: "Create Return"
method: POST
path: "/wms/returns"
tags: ["wms", "Returns"]
---

# Create Return

`POST /wms/returns`

Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.

## 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` CreateWmsReturnLineItemSchema[] — 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.
    - `line_items` WmsReturnWriteLineItembleckmann[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `expected_quantity` integer, required
    - `tracking_number` string — The tracking number 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
    - `order_number` string, required — The customer order number associated with the return.
    - `reference_id` string, required — The external ID of the return.
    - `tracking_number` string, required — The tracking number of the return.
    - `line_items` WmsReturnWriteLineItembluebox[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `expected_quantity` integer, required — Total quantity expected to be returned.
      - `return_reason` string — The reason for the 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.
    - `external_source` string — The external source 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_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.
    - `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, required — The tracking number for the return shipment
    - `reference_number` string — The reference number for the return shipment
    - `ship_to_address` ReturnShipToAddressCirro, 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` WmsReturnWriteLineItemcirro[], required — 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, 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.
  - 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.
    - `line_items` WmsReturnWriteLineItemcontrolport[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `line_item_id` string — The specific order line to return against, needed only when a product is on the order more than once.
      - `expected_quantity` integer, required
      - `return_reason` 'connect an account to see available return reasons', required — return reason name or id from the return-reason endpoint
      - `desired_outcome` 'exchange' | 'refund' | 'replacement' | 'other', required — what should happen to the returned item
    - `tracking_number` string — tracking number for the return shipment
    - `carrier_name` string — carrier bringing the return back
  - 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
    - `ship_to_address` ShipToAddressDcl, required
      - `full_name` string
      - `company` string
      - `address1` string, required
      - `address2` string
      - `city` string, required
      - `state` string, required
      - `postal_code` string, required
      - `country` string, required
    - `carrier_id` string — The carrier used to ship the return.
    - `shipping_method` string — The method used to ship the return.
    - `warehouse_id` 'FR' | 'LA' | 'LN' | 'KY' | 'YK' | 'EX' | 'EU', 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` WmsReturnWriteLineItemdcl[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `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.
    - `return_type` '1: Replace Upon Receipt.' | '2: Replace Now - No Return.' | '3: Replace Now - With Return.' | '11: Refund Upon Receipt.' | '12: Refund Now - No Return.' | '13: Refund Now - With Return.' | '21: Gift Voucher Upon Receipt.' | '22: Gift Voucher Now - No Return.' | '23: Gift Voucher Now - With Return.' | '24: Gift Card Upon Receipt.' | '25: Gift Card Now - No Return.' | '26: Gift Card Now - With Return.' | '31: Upgrade Upon Receipt.' | '32: Upgrade Now - No Return.' | '33: Upgrade Now - With Return.' | '81: Return For Repair.' | '82: Not For DCL.' | '99: Review.', required
    - `disposition` '1: Await Decision.' | '2: Return To Stock.' | '3: Scrap.' | '5: Rework.' | '10: Test.' | '18: Return To Vendor.', 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.
    - `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_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.
    - `reference_number` string, required — Reference Number
    - `line_items` WmsReturnWriteLineItemextensiv3plCentral[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `expected_quantity` integer, required
    - `tracking_number` string — Tracking Number
  - 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
    - `rma` string, required — The RMA of the return, typically generated by the merchant.
    - `reference_id` string, required — The unique reference ID of the return.
    - `line_items` WmsReturnWriteLineItemflexport[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `expected_quantity` integer, required
    - `ship_from_address` ReturnAddressFlexport, required
      - `full_name` string, required
      - `company` string
      - `address1` string, required
      - `address2` string
      - `city` string, required
      - `state` string, required
      - `postal_code` string, required
      - `country` string, 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.
    - `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` WmsReturnWriteLineItemfulfil[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `expected_quantity` integer, required
      - `id` string — The specific order line to return against, needed only when a SKU appears on the order more than once.
      - `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
    - `reference_id` string, required — The order reference.
    - `line_items` WmsReturnCreateLineItemiFulfilment[], required — A list of inventory items included in the return.
      - `sku` string, required — The SKU of the item.
      - `expected_quantity` integer — The expected quantity to return.
      - `quantity` integer — Use `expected_quantity` instead.
      - `action` 'refund' | 'exchange' | 'stock', required — The return action.
      - `return_reason` 'Size and fit - too large' | 'Size and fit - too small' | 'Size and fit - doesn't fit well' | 'Design - colour' | 'Quality - faulty' | 'Quality - poor quality' | 'Ordering - multi purchase for size trial' | 'Ordering - wrong item delivered' | 'Ordering - no longer required' | 'Other - please specify', required — The reason for the return.
      - `description` string — The description of why the return is being created.
  - 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, 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` WmsReturnWriteLineItemjazzCentral[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `expected_quantity` integer, required
      - `return_reason` 'N/A - Connect an account to see options', 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
    - `line_items` WmsReturnWriteLineItemlinnworks[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `expected_quantity` integer, required
      - `return_reason` string
      - `exchange_items` ExchangeItemSchema[] — A list of items to exchange for this line item
        - `sku` string, required — SKU of the item to exchange for
        - `quantity` integer, required — Quantity of the item to exchange for
    - `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.
  - 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` WmsReturnWriteLineItemlogiwa[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `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.
  - 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 — 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[], required — 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
    - `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.
    - `line_items` WmsReturnWriteLineItemmintsoft[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `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
    - `line_items` WmsReturnWriteLineItemnimble[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `expected_quantity` integer, required
    - `warehouse_id` 'N/A - Connect an account to see options', 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.
    - `destination_location_name` string — Destination location name
    - `supplier_first_name` string — Supplier first name
    - `supplier_last_name` string — Supplier last name
    - `tracking_number` string — Tracking number
    - `shopify_order_name` string — Shopify order name
    - `return_platform_name` 'NIMBLE' | 'LOOP' | 'HAPPY_RETURNS' | 'REDO' — Return platform name
    - `return_platform_id` string — Return platform ID
    - `loop_status` 'OPEN' | 'CLOSED' | 'CANCELLED' | 'EXPIRED' | 'REVIEW' — Loop status
    - `loop_return_id` string — Loop return ID
    - `return_reason` string, required — Return reason
    - `carrier_id` string — Shipping carrier
    - `shipping_method_id` string — Shipping service
  - 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
    - `id` string, required — The return authorization number. Used as the primary reference ID for the 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.
    - `client_reference_number_2` string — Optional secondary reference number for the return.
    - `line_items` WmsReturnWriteLineItemnri[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `expected_quantity` integer, required
      - `return_reason` string, required — The NRI reason code for the return line. Client-configured in NRI (e.g. 'RR').
      - `ra_line_action_code` string, required — The NRI line action code. Client-configured in NRI (e.g. 'UN').
  - 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_number` string, required — Return number
    - `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 — 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` WmsReturnWriteLineItemongoing[], required — 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.
    - `tracking_number` string
    - `tracking_url` string
  - 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.
    - `return_number` string, required — Client assigned RMA number
    - `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` WmsReturnWriteLineItemquiet[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `expected_quantity` integer, required
      - `return_reason` string
    - `tracking_number` string
  - 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', 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.
    - `order_id` 'N/A - Connect an account to see options', 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` WmsReturnWriteLineItemsandbox[], required — 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.
    - `reference_id` string, required — External unique identifier for the return order.
    - `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.
    - `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
    - `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` WmsReturnWriteLineItemshipedge[], 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
    - `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` string, required — Reason for return.
    - `order_id` string, required — Order associated with this return.
    - `label_type` 'FREE' | 'PAID' | 'SELF_RETURN' | 'FLAT_RATE', required — Return label type.
    - `shipping_method` string, required — The shipping_method used to return the item.
    - `carrier_id` string, required — The carrier used to return the item.
    - `label_cost` number, required — Cost of the return label.
    - `ship_from_address` FromAddressShiphero, required
      - `full_name` string, required
      - `address1` string, required
      - `city` string, required
      - `state` string, required
      - `postal_code` string, required
      - `country` string, required
    - `line_items` WmsReturnWriteLineItemshiphero[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `expected_quantity` integer, required
      - `return_reason` string, required
    - `measurements` Dimensions, required
      - `length` integer, required
      - `width` integer, required
      - `height` integer, required
      - `unit` 'cm' | 'in', required — The unit of measurement for the size of the return.
      - `weight` number, required
      - `weight_unit` 'kg' | 'oz' | 'lb', required — The unit of measurement for the weight of the return.
    - `tracking_number` string
  - 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
    - `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` WmsReturnWriteLineItemshippingbo[], 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
    - `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` WmsReturnWriteLineItemshipstream[], required — 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
    - `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.
    - `line_items` WmsReturnWriteLineItemshipwire[], 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
    - `reference_id` string, required — Customer defined reference associated with the receipt.
    - `expected_arrival_date` string, date-time, required — Date the shipment is expected to reach the warehouse.
    - `line_items` WmsReturnWriteLineItemsmartWarehousing[], required — A list of inventory items included in the return.
      - `sku` string, required — sku
      - `expected_quantity` integer, required
    - `tracking_number` string — Tracking number associated with the inbound shipment.
  - 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.
    - `line_items` WmsReturnWriteLineItem[], required — A list of inventory items included in the return.
      - `sku` string, required
      - `quantity` integer, required
      - `return_reason` string, required
    - `ship_from_address` ShipFromAddressStord, required
      - `full_name` string, required
      - `address1` string, required
      - `address2` string, required
      - `city` string, required
      - `state` string, required
      - `postal_code` string, required
      - `country` string, required
    - `external_tracking_number` string — Tracking number from an externally-generated return label. Requires carrier_name and warehouse_id.
    - `carrier_name` string — Carrier for an externally-generated return label. Required when external_tracking_number is set.
    - `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.
    - `external_return_id` string — External identifier for the return; must be unique within the network.
  - 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.
    - `requires_label` boolean, required — Whether or not a label is required.
    - `carrier_id` string — The carrier for the return. Defaults to 'Whiplash'.
    - `line_items` WmsReturnWriteLineItemwhiplash[] — A list of inventory items included in the return.
      - `sku` string, required
      - `expected_quantity` integer, required
      - `return_reason` 'Did not fit' | 'Defective' | 'Ordered wrong item' | 'Wrong item sent' | 'Unexpected/Additional Item' | 'Item not as expected' | 'Unclaimed/Undeliverable' | 'Other', required
      - `return_action` 'requires_attention' | 'exchange' | 'refund' | 'credit' | 'unknown' | 'no_action_required', required
    - `tracking_number` string
    - `notes` string[] — List of notes associated with the return.
    - `reference` string — Purchase order number or other human readable token to another system
    - `sender` string — The customer's name

## Response `200`

Successful response

- WmsCreateReturnResponse
  - `data` CreateReturnResponseDataSchema
    - `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

- `422` — Validation error

---

[API](https://skmtc.net/trackstarhq/apis/trackstar-api.md) · [All operations](https://skmtc.net/trackstarhq/apis/trackstar-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trackstarhq/trackstar-api/versions/4bc5c6e1a8bf/schema)