> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trackstarhq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Return

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



## OpenAPI

````yaml put /wms/returns/{return_id}
openapi: 3.1.0
info:
  description: >

    Trackstar is a Unified API that provides standard endpoints for Supply Chain
    Logistics. We currently offer an API for Warehouse Management Systems (WMS).
  title: Trackstar API
  version: 0.1.0
servers:
  - description: Trackstar API
    url: https://production.trackstarhq.com
security: []
tags: []
externalDocs:
  description: Trackstar API Documentation
  url: https://docs.trackstarhq.com
paths:
  /wms/returns/{return_id}:
    put:
      tags:
        - wms
        - Returns
      summary: Update Return
      description: >-
        Get the required, optional, and integration specific fields by calling
        the [integrations](/api-reference/mgmt/integrations) endpoint.
      operationId: put_wms_update_return
      parameters:
        - in: path
          name: return_id
          schema:
            type: string
          required: true
        - in: header
          name: x-trackstar-api-key
          description: Your organization-level Trackstar API key.
          schema:
            type: string
            example: <x-trackstar-api-key>
          required: true
        - in: header
          name: x-trackstar-access-token
          description: >-
            Your user's access token for a specific integration (ShipHero,
            Extensiv, etc).
          schema:
            type: string
            example: <x-trackstar-access-token>
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatewmsReturnInputSchema'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/wmsUpdateReturnResponse'
          description: Successful response
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: Validation error
components:
  schemas:
    UpdatewmsReturnInputSchema:
      type: object
      properties: {}
      additionalProperties: false
      oneOf:
        - $ref: '#/components/schemas/UpdateReturnSchema--Base__Schema--'
        - $ref: '#/components/schemas/UpdatewmsReturn--Cirro--'
        - $ref: '#/components/schemas/UpdatewmsReturn--Deposco--'
        - $ref: '#/components/schemas/UpdatewmsReturn--Infoplus--'
        - $ref: '#/components/schemas/UpdatewmsReturn--Logiwa__IO--'
        - $ref: '#/components/schemas/UpdatewmsReturn--MasonHub--'
        - $ref: '#/components/schemas/UpdatewmsReturn--Ongoing__WMS--'
        - $ref: '#/components/schemas/UpdatewmsReturn--WMS__Sandbox--'
        - $ref: '#/components/schemas/UpdatewmsReturn--ShipBob--'
        - $ref: '#/components/schemas/UpdatewmsReturn--ShipHero--'
        - $ref: '#/components/schemas/UpdatewmsReturn--ShipMonk--'
        - $ref: '#/components/schemas/UpdatewmsReturn--ShipStream--'
        - $ref: '#/components/schemas/UpdatewmsReturn--Whiplash__-_Ryder_---'
      title: UpdatewmsReturnInputSchema
    wmsUpdateReturnResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/WmsReturnApiItemSchema'
        id:
          type: string
          description: The ID of the object that has been created or modified
          example: id
        unused_fields:
          type: array
          description: Unused fields
          items:
            type: string
            description: ''
      required:
        - id
        - unused_fields
      additionalProperties: false
      title: wmsUpdateReturnResponse
    HTTPError:
      properties:
        error:
          type: string
        id:
          type: string
          description: The ID of the item that wasn't found.
      required:
        - error
      type: object
      title: HTTPError
    ValidationError:
      properties:
        error:
          type: string
        detail:
          type: object
          properties:
            <location>:
              type: object
              properties:
                <field_name>:
                  type: array
                  items:
                    type: string
      required:
        - error
      type: object
      title: ValidationError
    UpdateReturnSchema--Base__Schema--:
      type: object
      properties:
        trackstar_tags:
          type:
            - array
            - 'null'
          description: >-
            A list of custom tags associated with the resource. A tag can be
            either a string or a dictionary with one key-value pair.
          example:
            - tag1
            - tag2
            - tag3: value3
          items: {}
        warehouse_id:
          type: string
          description: >-
            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.
          example: warehouse
        order_id:
          type: string
          description: >-
            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.
          example: order_id
        line_items:
          type: array
          description: A list of inventory items included in the return.
          example:
            - sku: sku
              expected_quantity: 1
          items:
            $ref: '#/components/schemas/UpdateWmsReturnLineItemSchema'
      additionalProperties: true
      title: Base Schema
    UpdatewmsReturn--Cirro--:
      type: object
      properties:
        trackstar_tags:
          type:
            - array
            - 'null'
          description: >-
            A list of custom tags associated with the resource. A tag can be
            either a string or a dictionary with one key-value pair.
          example:
            - tag1
            - tag2
            - tag3: value3
          items: {}
        warehouse_id:
          type: string
          description: >-
            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.
          example: warehouse
        carrier_id:
          type: string
          description: >-
            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.
          example: UPS
        carrier_name:
          type: string
          description: The carrier to use for the return shipment
          example: UPS
        tracking_number:
          type: string
          description: The tracking number for the return shipment
          example: 1Z12345E0205271688
        reference_number:
          type: string
          description: The reference number for the return shipment
          example: '1234567890'
        ship_to_address:
          $ref: '#/components/schemas/ReturnShipToAddressCirro'
        line_items:
          type: array
          description: A list of inventory items included in the return.
          example:
            - sku: null
              platform_name: SHOPIFY
              expected_quantity: 0
          items:
            $ref: '#/components/schemas/WmsReturnWriteLineItemcirro'
        return_reason:
          type: string
          description: The reason for the return. Damaged, Defective, Incorrect Item, etc.
        order_id:
          type: string
          description: >-
            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.
          example: order_id
      additionalProperties: false
      title: Cirro
    UpdatewmsReturn--Deposco--:
      type: object
      properties:
        trackstar_tags:
          type:
            - array
            - 'null'
          description: >-
            A list of custom tags associated with the resource. A tag can be
            either a string or a dictionary with one key-value pair.
          example:
            - tag1
            - tag2
            - tag3: value3
          items: {}
        warehouse_id:
          type: string
          description: >-
            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.
          example: warehouse
        ship_to_address:
          $ref: '#/components/schemas/ReturnShipToAddressDeposco'
        line_items:
          type: array
          description: A list of inventory items included in the return.
          example:
            - sku: null
              inventory_item_id: null
              expected_quantity: 0
          items:
            $ref: '#/components/schemas/WmsReturnWriteLineItemdeposco'
        order_id:
          type: string
          description: >-
            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.
          example: order_id
        number:
          type: string
          description: >-
            An optional return number to use for the return. If not provided, a
            unique number will be generated.
          example: RMA123
        return_reason:
          type: string
          description: >-
            The reason for the return. RTS, Partial Customer Return, Full
            Customer Return
        customer_order_number:
          type: string
          description: The customer order number in Deposco
          example: PF#
        tracking_number:
          type: string
          description: The tracking number of the return
          example: '9434636106023310081309'
      required:
        - line_items
      additionalProperties: false
      title: Deposco
    UpdatewmsReturn--Infoplus--:
      type: object
      properties:
        trackstar_tags:
          type:
            - array
            - 'null'
          description: >-
            A list of custom tags associated with the resource. A tag can be
            either a string or a dictionary with one key-value pair.
          example:
            - tag1
            - tag2
            - tag3: value3
          items: {}
        warehouse_customer_id:
          type:
            - string
            - 'null'
          description: >-
            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.
          example: warehouse_customer_id
        warehouse_id:
          type: string
          description: >-
            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.
          example: warehouse
        supplier_object:
          $ref: '#/components/schemas/WriteSupplierSchema'
          description: The supplier from which the shipment is being sent.
        return_type:
          type: string
          enum:
            - Job
            - Kit
            - Normal
            - Transfer
            - Blind
          description: Type of return
        order_id:
          type: string
          description: >-
            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.
          example: order_id
        line_items:
          type: array
          description: A list of inventory items included in the return.
          example:
            - sku: null
              expected_quantity: 0
          items:
            $ref: '#/components/schemas/WmsReturnWriteLineIteminfoplus'
      required:
        - line_items
        - order_id
        - return_type
        - supplier_object
        - warehouse_id
      additionalProperties: false
      title: Infoplus
    UpdatewmsReturn--Logiwa__IO--:
      type: object
      properties:
        trackstar_tags:
          type:
            - array
            - 'null'
          description: >-
            A list of custom tags associated with the resource. A tag can be
            either a string or a dictionary with one key-value pair.
          example:
            - tag1
            - tag2
            - tag3: value3
          items: {}
        order_id:
          type: string
          description: >-
            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.
          example: order_id
        warehouse_id:
          type: string
          description: >-
            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.
          example: warehouse
        rma_number:
          type: string
          description: >-
            An optional RMA number. If not provided, a random one will be
            generated.
          example: rma_number
        line_items:
          type: array
          description: A list of inventory items included in the return.
          example:
            - sku: null
              expected_quantity: 0
          items:
            $ref: '#/components/schemas/WmsReturnWriteLineItemlogiwa-io'
        tracking_number:
          type: string
          description: The tracking number of the return.
          example: tracking_number
      additionalProperties: false
      title: Logiwa IO
    UpdatewmsReturn--MasonHub--:
      type: object
      properties:
        trackstar_tags:
          type:
            - array
            - 'null'
          description: >-
            A list of custom tags associated with the resource. A tag can be
            either a string or a dictionary with one key-value pair.
          example:
            - tag1
            - tag2
            - tag3: value3
          items: {}
        return_type:
          type: string
          enum:
            - returned_to_sender
            - rma_submitted_by_customer
            - rma_created_by_distribution_center
          description: The type of return.
        ship_from_address:
          $ref: '#/components/schemas/ShipFromAddressMasonhub'
        line_items:
          type: array
          description: A list of inventory items included in the return.
          example:
            - sku: null
              expected_quantity: 0
              return_reason: null
              return_inventory_status: null
          items:
            $ref: '#/components/schemas/WmsReturnWriteLineItemmasonhub'
        order_id:
          type: string
          description: The ID of the original order.
      required:
        - line_items
        - return_type
        - ship_from_address
      additionalProperties: false
      title: MasonHub
    UpdatewmsReturn--Ongoing__WMS--:
      type: object
      properties:
        line_items:
          type: array
          description: A list of inventory items included in the return.
          example:
            - sku: null
              expected_quantity: 0
              return_cause: null
          items:
            $ref: '#/components/schemas/WmsReturnWriteLineItemongoing'
        warehouse_id:
          type: string
          description: >-
            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.
          example: warehouse
        tracking_number:
          type: string
          description: ''
        tracking_url:
          type: string
          description: ''
        trackstar_tags:
          type:
            - array
            - 'null'
          description: >-
            A list of custom tags associated with the resource. A tag can be
            either a string or a dictionary with one key-value pair.
          example:
            - tag1
            - tag2
            - tag3: value3
          items: {}
      additionalProperties: false
      title: Ongoing WMS
    UpdatewmsReturn--WMS__Sandbox--:
      type: object
      properties:
        trackstar_tags:
          type:
            - array
            - 'null'
          description: >-
            A list of custom tags associated with the resource. A tag can be
            either a string or a dictionary with one key-value pair.
          example:
            - tag1
            - tag2
            - tag3: value3
          items: {}
        warehouse_id:
          type: string
          enum:
            - N/A - Connect an account to see options
          description: >-
            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.
          example: warehouse
        order_id:
          type: string
          enum:
            - N/A - Connect an account to see options
          description: >-
            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.
          example: order_id
        line_items:
          type: array
          description: A list of inventory items included in the return.
          example:
            - sku: XS-RED-SHIRT
              expected_quantity: 1
              return_reason: damaged
          items:
            $ref: '#/components/schemas/WmsSandboxUpdateReturnLineItems'
      additionalProperties: false
      title: WMS Sandbox
    UpdatewmsReturn--ShipBob--:
      type: object
      properties:
        trackstar_tags:
          type:
            - array
            - 'null'
          description: >-
            A list of custom tags associated with the resource. A tag can be
            either a string or a dictionary with one key-value pair.
          example:
            - tag1
            - tag2
            - tag3: value3
          items: {}
        warehouse_id:
          type: string
          description: >-
            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.
          example: warehouse
        line_items:
          type: array
          description: A list of inventory items included in the return.
          example:
            - inventory_item_id: null
              expected_quantity: 0
          items:
            $ref: '#/components/schemas/WmsReturnWriteLineItemshipbob'
        tracking_number:
          type: string
          description: Tracking number of the return.
      required:
        - line_items
        - warehouse_id
      additionalProperties: false
      title: ShipBob
    UpdatewmsReturn--ShipHero--:
      type: object
      properties:
        status:
          type: string
          enum:
            - open
            - in-transit
            - receiving
            - received
            - cancelled
            - other
          description: >-
            The status of the return. See the [return information](info) for
            more details.
          example: open
        trackstar_tags:
          type:
            - array
            - 'null'
          description: >-
            A list of custom tags associated with the resource. A tag can be
            either a string or a dictionary with one key-value pair.
          example:
            - tag1
            - tag2
            - tag3: value3
          items: {}
      required:
        - status
        - trackstar_tags
      additionalProperties: false
      title: ShipHero
    UpdatewmsReturn--ShipMonk--:
      type: object
      properties:
        trackstar_tags:
          type:
            - array
            - 'null'
          description: >-
            A list of custom tags associated with the resource. A tag can be
            either a string or a dictionary with one key-value pair.
          example:
            - tag1
            - tag2
            - tag3: value3
          items: {}
        order_id:
          type: string
          description: >-
            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.
          example: order_id
        warehouse_id:
          type: string
          description: >-
            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.
          example: warehouse
        return_reason:
          type: string
          enum:
            - reason_exchange
            - reason_changed_mind
            - reason_undeliverable
            - reason_unknown
            - reason_incorrect_product
          description: Reason for the return.
        tracking_number:
          type: string
          description: The tracking number for the return.
          example: '123456789'
        line_items:
          type: array
          description: A list of inventory items included in the return.
          example:
            - sku: null
              expected_quantity: 0
              desired_action: null
          items:
            $ref: '#/components/schemas/WmsReturnWriteLineItemshipmonk'
      required:
        - line_items
        - order_id
        - return_reason
        - warehouse_id
      additionalProperties: false
      title: ShipMonk
    UpdatewmsReturn--ShipStream--:
      type: object
      properties:
        trackstar_tags:
          type:
            - array
            - 'null'
          description: >-
            A list of custom tags associated with the resource. A tag can be
            either a string or a dictionary with one key-value pair.
          example:
            - tag1
            - tag2
            - tag3: value3
          items: {}
        warehouse_id:
          type: string
          description: >-
            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.
          example: warehouse
        line_items:
          type: array
          description: A list of inventory items included in the return.
          example:
            - sku: null
              expected_quantity: 0
          items:
            $ref: '#/components/schemas/WmsReturnWriteLineItemshipstream'
        carrier_id:
          type: string
          description: Carrier ID. Will take precedence over carrier_name if passed.
        carrier_name:
          type: string
          description: Carrier name.
        carrier_tracking_number:
          type: string
          description: Carrier tracking number
        customer_name:
          type: string
          description: Customer name
        merchant_order_number:
          type: string
          description: Merchant order number
        tracking_numbers:
          type: array
          description: List of tracking numbers
          items:
            type: string
            description: ''
        merchant_rma_number:
          type: integer
          description: Merchant RMA number
          example: 0
        expected_arrival_date:
          type: string
          format: date
          description: Expected arrival date
        notes:
          type: string
          description: Notes
      additionalProperties: false
      title: ShipStream
    UpdatewmsReturn--Whiplash__-_Ryder_---:
      type: object
      properties:
        requires_label:
          type: boolean
          description: Whether or not a label is required.
          example: true
        carrier_id:
          type: string
          default: Whiplash
          description: The carrier for the return. Defaults to 'Whiplash'.
        tracking_number:
          type: string
          description: ''
        trackstar_tags:
          type:
            - array
            - 'null'
          description: >-
            A list of custom tags associated with the resource. A tag can be
            either a string or a dictionary with one key-value pair.
          example:
            - tag1
            - tag2
            - tag3: value3
          items: {}
      additionalProperties: false
      title: Whiplash (Ryder)
    WmsReturnApiItemSchema:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the return.
          example: return_id
        warehouse_customer_id:
          type:
            - string
            - 'null'
          description: >-
            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.
          example: warehouse_customer_id
        created_date:
          type: string
          format: date-time
          description: The date the return was created.
          example: '2022-01-01T00:00:00Z'
        updated_date:
          type: string
          format: date-time
          description: The date the return was last updated.
          example: '2022-01-02T05:05:05Z'
        status:
          type: string
          enum:
            - open
            - in-transit
            - receiving
            - received
            - cancelled
            - other
          description: >-
            The status of the return. See the [return information](info) for
            more details.
          example: open
        raw_status:
          type:
            - string
            - 'null'
          description: The raw status (if available) returned directly from the WMS.
          example: raw_status
        order_id:
          type:
            - string
            - 'null'
          description: >-
            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.
          example: order_id
        notes:
          type: array
          description: A list of notes associated with the return.
          example:
            - This is a note
          items:
            type: string
            description: This is a note
        line_items:
          type: array
          description: A list of inventory items included in the return.
          example:
            - inventory_item_id: item_id
              sku: sku
              expected_quantity: 1
              received_quantity: 1
              restocked_quantity: 1
              return_reason: Too Small
          items:
            $ref: '#/components/schemas/WmsReturnLineItem'
        shipments:
          type: array
          description: List of the shipments associated with the return.
          example:
            - tracking_number: tracking_number
              shipped_date: '2023-02-03T02:04:06Z'
              arrived_date: '2023-02-03T02:04:06Z'
              warehouse_id: warehouse_id
              carrier_id: carrier_id
              carrier_name: carrier_name
              scac: FDXG
              shipping_cost: 1.23
              measurements:
                length: 1
                width: 1
                height: 1
                unit: in
                weight: 1
                weight_unit: lb
              line_items:
                - inventory_item_id: item_id
                  sku: sku
                  quantity: 4
                  receiving_details:
                    - quantity: 1
                      condition: good
                      disposition: restocked
                    - quantity: 1
                      condition: damaged
                      disposition: scrapped
          items:
            $ref: '#/components/schemas/ReturnShipment'
        external_system_url:
          type:
            - string
            - 'null'
          description: URL link to the return in the external system (WMS/Freight etc).
          example: https://example.com/return/123
        trackstar_tags:
          type:
            - array
            - 'null'
          description: >-
            A list of custom tags associated with the resource. A tag can be
            either a string or a dictionary with one key-value pair.
          example:
            - tag1
            - tag2
            - tag3: value3
          items: {}
        additional_fields:
          type: object
          description: Integration-specific fields
          example:
            key: value
          additionalProperties: {}
        trackstar_created_date:
          type: string
          format: date-time
          description: ''
        trackstar_updated_date:
          type: string
          format: date-time
          description: ''
      required:
        - additional_fields
        - created_date
        - external_system_url
        - id
        - line_items
        - notes
        - order_id
        - raw_status
        - shipments
        - status
        - trackstar_created_date
        - trackstar_tags
        - trackstar_updated_date
        - updated_date
        - warehouse_customer_id
      additionalProperties: false
      title: WmsReturnApiItemSchema
    UpdateWmsReturnLineItemSchema:
      type: object
      properties:
        sku:
          type: string
          description: ''
          example: sku
        expected_quantity:
          type: integer
          description: ''
          example: 1
      required:
        - expected_quantity
        - sku
      additionalProperties: true
      title: UpdateWmsReturnLineItemSchema
    ReturnShipToAddressCirro:
      type: object
      properties:
        full_name:
          type: string
          description: ''
          example: John Doe
        address1:
          type: string
          description: ''
          example: 123 Main St
        address2:
          type: string
          description: ''
          example: Apt 2
        city:
          type: string
          description: ''
          example: San Francisco
        state:
          type: string
          description: ''
          example: CA
        postal_code:
          type: string
          description: ''
          example: '94105'
        country:
          type: string
          description: ''
          example: United States
      required:
        - address1
        - city
        - country
        - full_name
        - postal_code
        - state
      additionalProperties: false
      title: ReturnShipToAddressCirro
    WmsReturnWriteLineItemcirro:
      type: object
      properties:
        sku:
          type: string
          description: ''
        platform_name:
          type: string
          enum:
            - 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
          description: >-
            The name of the platform from which the sku originates. If provided,
            will be used to find the Cirro SKU.
          example: SHOPIFY
        expected_quantity:
          type: integer
          description: ''
          example: 0
      required:
        - expected_quantity
        - sku
      additionalProperties: false
      title: WmsReturnWriteLineItemcirro
    ReturnShipToAddressDeposco:
      type: object
      properties:
        full_name:
          type: string
          description: ''
          example: John Doe
        address1:
          type: string
          description: ''
          example: 123 Main St
        address2:
          type: string
          description: ''
          example: Apt 2
        city:
          type: string
          description: ''
          example: San Francisco
        state:
          type: string
          description: ''
          example: CA
        postal_code:
          type: string
          description: ''
          example: '94105'
        country:
          type: string
          description: ''
          example: United States
      required:
        - address1
        - city
        - country
        - postal_code
        - state
      additionalProperties: false
      title: ReturnShipToAddressDeposco
    WmsReturnWriteLineItemdeposco:
      type: object
      properties:
        sku:
          type: string
          description: The SKU of the product to return.
        inventory_item_id:
          type: string
          description: Deprecated. Use `sku` instead.
        expected_quantity:
          type: integer
          description: ''
          example: 0
      required:
        - expected_quantity
      additionalProperties: false
      title: WmsReturnWriteLineItemdeposco
    WriteSupplierSchema:
      type: object
      properties: {}
      additionalProperties: false
      oneOf:
        - $ref: '#/components/schemas/SupplierId'
        - $ref: '#/components/schemas/WriteSupplierName'
      discriminator:
        propertyName: type
        mapping:
          id:
            $ref: '#/components/schemas/SupplierId'
          name:
            $ref: '#/components/schemas/WriteSupplierName'
      title: WriteSupplierSchema
    WmsReturnWriteLineIteminfoplus:
      type: object
      properties:
        sku:
          type: string
          description: ''
        expected_quantity:
          type: integer
          description: ''
          example: 0
      required:
        - expected_quantity
        - sku
      additionalProperties: false
      title: WmsReturnWriteLineIteminfoplus
    WmsReturnWriteLineItemlogiwa-io:
      type: object
      properties:
        sku:
          type: string
          description: ''
        expected_quantity:
          type: integer
          description: ''
          example: 0
      required:
        - expected_quantity
        - sku
      additionalProperties: false
      title: WmsReturnWriteLineItemlogiwa-io
    ShipFromAddressMasonhub:
      type: object
      properties:
        full_name:
          type: string
          description: ''
          example: John Doe
        address1:
          type: string
          description: ''
          example: 123 Main St
        address2:
          type: string
          description: ''
          example: Apt 2
        city:
          type: string
          description: ''
          example: San Francisco
        state:
          type: string
          description: ''
          example: CA
        postal_code:
          type: string
          description: ''
          example: '94105'
        country:
          type: string
          description: ''
          example: United States
      required:
        - address1
        - city
        - country
        - full_name
        - postal_code
        - state
      additionalProperties: false
      title: ShipFromAddressMasonhub
    WmsReturnWriteLineItemmasonhub:
      type: object
      properties:
        sku:
          type: string
          description: ''
        expected_quantity:
          type: integer
          description: ''
          example: 0
        return_reason:
          type: string
          enum:
            - tooBig
            - tooSmall
            - damaged
            - wrongItem
            - other
          description: Customer supplied reason code for this return
        return_inventory_status:
          type: string
          default: qc
          enum:
            - available
            - qc
            - damaged
            - quarantine
          description: The inventory status to return the units into.
      required:
        - expected_quantity
        - return_reason
        - sku
      additionalProperties: false
      title: WmsReturnWriteLineItemmasonhub
    WmsReturnWriteLineItemongoing:
      type: object
      properties:
        sku:
          type: string
          description: ''
        expected_quantity:
          type: integer
          description: ''
          example: 0
        return_cause:
          $ref: '#/components/schemas/ReturnCause'
      required:
        - expected_quantity
        - sku
      additionalProperties: false
      title: WmsReturnWriteLineItemongoing
    WmsSandboxUpdateReturnLineItems:
      type: object
      properties:
        sku:
          type: string
          enum:
            - N/A - Connect an account to see options
          description: sku
          example: XS-RED-SHIRT
        expected_quantity:
          type: integer
          description: ''
          example: 1
        return_reason:
          type: string
          description: The reason for the return.
          example: damaged
      required:
        - expected_quantity
        - sku
      additionalProperties: false
      title: WmsSandboxUpdateReturnLineItems
    WmsReturnWriteLineItemshipbob:
      type: object
      properties:
        inventory_item_id:
          type: string
          description: ''
        expected_quantity:
          type: integer
          description: ''
          example: 0
      required:
        - expected_quantity
        - inventory_item_id
      additionalProperties: false
      title: WmsReturnWriteLineItemshipbob
    WmsReturnWriteLineItemshipmonk:
      type: object
      properties:
        sku:
          type: string
          description: ''
        expected_quantity:
          type: integer
          description: ''
          example: 0
        desired_action:
          type: string
          enum:
            - received_back_into_inventory
            - damaged_not_resellable
          description: Desired action for the returned item.
      required:
        - desired_action
        - expected_quantity
        - sku
      additionalProperties: false
      title: WmsReturnWriteLineItemshipmonk
    WmsReturnWriteLineItemshipstream:
      type: object
      properties:
        sku:
          type: string
          description: ''
        expected_quantity:
          type: integer
          description: ''
          example: 0
      required:
        - expected_quantity
        - sku
      additionalProperties: false
      title: WmsReturnWriteLineItemshipstream
    WmsReturnLineItem:
      type: object
      properties:
        inventory_item_id:
          type: string
          description: >-
            Can be passed into the
            [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for
            more details.
          example: item_id
        sku:
          type:
            - string
            - 'null'
          description: ''
          example: sku
        expected_quantity:
          type: integer
          description: How many units are expected to arrive.
          example: 1
        received_quantity:
          type: integer
          description: How many units actually arrived.
          example: 1
        restocked_quantity:
          type:
            - integer
            - 'null'
          description: The number of returned inventory items that have been restocked.
          example: 1
        return_reason:
          type:
            - string
            - 'null'
          description: The reason for the return.
          example: Too Small
      required:
        - expected_quantity
        - inventory_item_id
        - received_quantity
        - restocked_quantity
        - return_reason
        - sku
      additionalProperties: false
      title: WmsReturnLineItem
    ReturnShipment:
      type: object
      properties:
        tracking_number:
          type:
            - string
            - 'null'
          description: The tracking number of the shipment.
        shipped_date:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the shipment was sent.
        arrived_date:
          type:
            - string
            - 'null'
          format: date-time
          description: The date the shipment arrived.
        warehouse_id:
          type:
            - string
            - 'null'
          description: >-
            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.
          example: warehouse_id
        carrier_id:
          type:
            - string
            - 'null'
          description: The ID of the carrier for the shipment.
          example: carrier_id
        carrier_name:
          type:
            - string
            - 'null'
          description: The name of the carrier for the shipment.
          example: carrier_name
        scac:
          type:
            - string
            - 'null'
          description: The Standard Carrier Alpha Code (SCAC) for the shipment.
          example: FDXG
        shipping_cost:
          type:
            - number
            - 'null'
          description: The cost of the shipment.
          example: 0
        measurements:
          $ref: '#/components/schemas/ShipmentMeasurements'
        line_items:
          type: array
          description: List of inventory items items in the shipment.
          items:
            $ref: '#/components/schemas/ReturnShipmentLineItem'
      required:
        - arrived_date
        - carrier_id
        - carrier_name
        - line_items
        - measurements
        - scac
        - shipped_date
        - shipping_cost
        - tracking_number
        - warehouse_id
      additionalProperties: false
      title: ReturnShipment
    SupplierId:
      type: object
      properties:
        supplier_id:
          type: string
          description: The ID of the supplier.
          example: supplier_id
      required:
        - supplier_id
      additionalProperties: false
      title: SupplierId
    WriteSupplierName:
      type: object
      properties:
        supplier_name:
          type: string
          description: >-
            The name of the supplier. If supplier ID is provided, that will take
            precedence over this.
          example: supplier_name
      required:
        - supplier_name
      additionalProperties: false
      title: WriteSupplierName
    ReturnCause:
      type: object
      properties:
        code:
          type: string
          enum:
            - N/A
          description: The reason code for this return.
        return_reason:
          type:
            - string
            - 'null'
          enum:
            - Connect an account to get return causes.
          description: The reason description for this return.
      required:
        - code
      additionalProperties: false
      title: ReturnCause
    ShipmentMeasurements:
      type: object
      properties:
        length:
          type:
            - number
            - 'null'
          description: ''
          example: 1.5
        width:
          type:
            - number
            - 'null'
          description: ''
          example: 1.5
        height:
          type:
            - number
            - 'null'
          description: ''
          example: 1.5
        unit:
          type:
            - string
            - 'null'
          enum:
            - cm
            - in
          description: The unit of measurement for the size of the shipment.
          example: in
        weight:
          type:
            - number
            - 'null'
          description: ''
          example: 2.5
        weight_unit:
          type:
            - string
            - 'null'
          enum:
            - kg
            - oz
            - lb
          description: The unit of measurement for the weight of the shipment.
          example: lb
      required:
        - height
        - length
        - unit
        - weight
        - weight_unit
        - width
      additionalProperties: false
      title: ShipmentMeasurements
    ReturnShipmentLineItem:
      type: object
      properties:
        inventory_item_id:
          type: string
          description: >-
            Can be passed into the
            [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for
            more details.
          example: item_id
        sku:
          type:
            - string
            - 'null'
          description: ''
          example: sku
        quantity:
          type: integer
          description: How many units were shipped.
          example: 1
        receiving_details:
          type: array
          description: Details about received items in the shipment.
          example:
            - quantity: 1
              condition: good
              disposition: restocked
          items:
            $ref: '#/components/schemas/ReceivingDetails'
      required:
        - inventory_item_id
        - quantity
        - receiving_details
        - sku
      additionalProperties: false
      title: ReturnShipmentLineItem
    ReceivingDetails:
      type: object
      properties:
        quantity:
          type: integer
          description: How many units were received in this condition and disposition.
          example: 1
        condition:
          type:
            - string
            - 'null'
          description: The condition of the item received.
          example: good
        disposition:
          type:
            - string
            - 'null'
          description: The disposition of the item received, eg restocked or discarded.
          example: restocked
      required:
        - condition
        - disposition
        - quantity
      additionalProperties: false
      title: ReceivingDetails

````