---
title: "List return orders V3"
method: GET
path: "/api/v3/returnOrders"
tags: ["ReturnOrder"]
---

# List return orders V3

`GET /api/v3/returnOrders`

This endpoint requires the following scopes: `return:read`.

Paginated list of return orders.

## Query parameters

- `filter` object[]
  - `key` 'id' | 'documentNumber' | 'documentDate' | 'writeProtection' | 'address.id' | 'project.id' | 'tags' | 'tags.id' | 'language' | 'bodyIntroduction' | 'bodyOutroduction' | 'project.abbreviation' | 'internalDesignation' | 'vatId' | 'deliveryTerms' | 'internalComment' | 'isDocumentSent' | 'editor.id' | 'createdAt' | 'updatedAt' | 'documentAddress.name' | 'documentAddress.title' | 'documentAddress.contactPerson' | 'documentAddress.department' | 'documentAddress.subDepartment' | 'documentAddress.addressSupplement' | 'documentAddress.street' | 'documentAddress.zipCode' | 'documentAddress.city' | 'documentAddress.state' | 'documentAddress.country' | 'documentAddress.gln' | 'documentAddress.email' | 'documentAddress.phone' | 'documentAddress.fax' | 'status' | 'sales.id' | 'customerOrderNumber' | 'preferredWarehouse.id' | 'shippingMethod.id' | 'salesOrder.id' | 'invoice.id' | 'creditNote.id' | 'customerNumber' | 'useAlternativeDocumentTitle' | 'isReturnOrderToSupplier' | 'progress'
  - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'lessThan' | 'lessThanOrEquals' | 'greaterThan' | 'greaterThanOrEquals' | 'isNull' | 'isNotNull' — operator
  - `value` union — The property value.
    - string
    - string[]
- `sort` string[]
- `search` string
- `include` string[]
- `perPage` integer
- `page` integer
- `cursor` string

## Headers

- `x-pagination` 'simple' | 'table' | 'cursor'

## Response `200`

Paginated list of return orders.

- union
  - object
    - `data` object[]
      - `id` string — ID of the document
      - `documentNumber` string — Document number. For drafts, this will be null.
      - `documentDate` string, date — Main date of the document.
      - `writeProtection` boolean — Indicates if the document is write protected.
      - `customerNumber` string — Customer number of the document.
      - `address` union — Address entity of the document. By default, only the ID is returned. To get the full Address object, use the `include` parameter.
        - object
          - `id` string, required
          - `isDeleted` boolean — Flagged if the entry was deleted.
          - `createdAt` string, date-time, required — Creation timestamp
          - `updatedAt` string, date-time, required — Last update timestamp
        - object
          - `id` string
      - `project` union — Project entity of the document. By default, only the ID is returned. To get the full Project object, use the `include` parameter.
        - object
          - `id` string, required
          - `name` string, required
          - `abbreviation` string, required
        - object
          - `id` string
      - `tags` object[] — Tags assigned to the document. This property is only returned if the `tags` include is used.
        - `id` string — ID of the tag
        - `title` string — Title of the tag
      - `documentAddress` object — The recipients postal address of the document. This is is usually the postal address of the document's address entitiy, (e.g. customer), or is populated based on the preceding document. As this address is persisted on the document level, it can however be modified independently, and does not reflect changes that occurred since the document was created.
        - `name` string, required — Represents an address consisting of a physical address and contact information. It is used in various documents, such as invoices, delivery notes, etc.
        - `type` 'mrs' | 'mr' | 'company' | 'other'
        - `title` string
        - `contactPerson` string
        - `department` string
        - `subDepartment` string
        - `addressSupplement` string
        - `street` string
        - `zipCode` string
        - `city` string
        - `state` string
        - `country` string
        - `salutation` string
        - `gln` string
        - `email` string
        - `phone` string
        - `fax` string
        - `mobile` string
      - `internalDesignation` string — Internal designation, might be displayed in the letterhead.
      - `isDocumentSent` boolean — Indicates if the document has been sent to the recipient.
      - `language` string — ISO 639-1 Language of the document.
      - `bodyIntroduction` string — Text displayed on the document before the line items.
      - `bodyOutroduction` string — Text displayed on the document after the line items.
      - `vatId` string — VAT ID of the document.
      - `deliveryTerms` string — Delivery terms of the document.
      - `internalComment` string — Internal comment, does not show up on the document. Intended to be used for company-internal notes.
      - `editor` object
        - `id` string — ID of the user who is responsible for the document.
      - `printSettings` object
        - `withoutLetterhead` boolean — For PDFs or physical documents, hide the letterhead
        - `withoutProductText` boolean — For PDFs or physical documents, hide the product text
      - `activity` object[] — Activity log entries associated with the document. To get activity object, use the `include` parameter.
        - `message` string, required
        - `causer` string, required
        - `causedAt` string, date-time, required
      - `customFields` object[] — Custom fields with their values and metadata
        - `key` string
        - `value` string
        - `label` string
      - `updatedAt` string, date-time
      - `createdAt` string, date-time
      - `salesOrder` object — Sales order reference.
        - `id` string — ID of the sales order
      - `invoice` object — invoice reference.
        - `id` string — ID of the invoice
      - `preferredWarehouse` object — Preferred warehouse for the document.
        - `id` string — ID of the preferred warehouse
      - `sales` object — Sales person responsible for the document.
        - `id` string
      - `status` 'draft' | 'released' | 'completed' | 'cancelled' — Status of the document.
      - `customerOrderNumber` string — Customer order number of the return order, e.g. the customer's order number.
      - `creditNote` object — Credit note connected to the return order.
        - `id` string
      - `deliveryNote` object — Delivery note connected to the return order.
        - `id` string
      - `replacementSalesOrder` object — Replacement sales order connected to the return order.
        - `id` string
      - `progress` 'announced' | 'received' | 'checked' | 'done' — Progress of the return order.
      - `useAlternativeDocumentTitle` boolean — Indicates if the alternative document title should be used. The alternative document title can be configured per document type in the system settings.
      - `isReturnOrderToSupplier` boolean — Indicates whether this is a return order to a supplier.
      - `supplierNumber` string — Supplier number of the supplier return order.
      - `lineItems` union[]
        - union
          - object
            - `type` 'product'
            - `id` string — ID of the line item.
            - `number` string — The Number of the line item. Usually the product SKU, but can be adjusted if required.
            - `name` string — The name of the line item. Usually the product name, but can be adjusted if required.
            - `description` string — The description of the line item. Usually the product description, but can be adjusted if required.
            - `quantity` number, float — The quantity of the line item.
            - `product` union — The product of the line item.
              - …
            - `countryOfOrigin` unknown
            - `hsCode` unknown
            - `customFields` object[] — Custom fields with their values and metadata.
              - …
            - `unit` string — The unit of the line item.
            - `deliveryDate` string, date — The delivery date of the line item.
            - `deliveryDateAsCalendarWeek` boolean — Whether to show the delivery date as calendar week or explicit.
            - `packagingUnit` string — The unit of packaging for the line item.
            - `internalComment` string — Internal comment, does not show up on the document. Intended to be used for company-internal notes.
            - `customerProductNumber` string — Customer product number for the line item.
            - `order` integer — The ordering sequence of the line item.
            - `updatedAt` string, date-time — The date and time when the line item was last updated.
            - `createdAt` string, date-time — The date and time when the line item was created.
            - `salesOrderLineItem` object — sales order line item reference.
              - …
            - `deliveredQuantity` unknown
            - `reimbursementQuantity` number, float — The quantity of the product that has been credited on the credit note.
            - `receivedQuantity` number, float — The quantity of the product that has been received back into inventory.
            - `returnReason` object — The reason for returning the product.
              - …
            - `parentLineItem` object — If this line item is a child line item, this will contain the parent line item ID.
              - …
            - `deliveryNoteLineItem` object — The delivery note line item this return order line item references.
              - …
            - `defaultStorageLocation` object — The default storage location for returned goods.
              - …
            - `printSettings` object — Print settings for this line item.
              - …
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'heading', required
            - `name` string
            - `description` string
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'subtotal', required
            - `name` string
            - `description` string
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'group_total', required
            - `name` string
            - `description` string
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'image', required
            - `name` string
            - `description` string
            - `image` object
              - …
            - `imageHeight` unknown
            - `imageWidth` unknown
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'page_break', required
      - `shippingMethod` object — Shipping method of the return order.
        - `id` string
      - `effectiveAddresses` object — Effective addresses of the return order. These (read-only) postal addresses will always be set, regardless of whether a deviating return-to address is set or not. Use these fields if you need to easily determine the return-to of the return order. For updating, use the `documentAddress` fields.
        - `soldTo` object — Represents a postal address with contact information.
          - `name` string, required — Represents an address consisting of a physical address and contact information. It is used in various documents, such as invoices, delivery notes, etc.
          - `type` 'mrs' | 'mr' | 'company' | 'other'
          - `title` string
          - `contactPerson` string
          - `department` string
          - `subDepartment` string
          - `addressSupplement` string
          - `street` string
          - `zipCode` string
          - `city` string
          - `state` string
          - `country` string
          - `salutation` string
          - `gln` string
          - `email` string
          - `phone` string
          - `fax` string
          - `mobile` string
        - `returnTo` object — Represents a postal address with contact information.
          - `name` string, required — Represents an address consisting of a physical address and contact information. It is used in various documents, such as invoices, delivery notes, etc.
          - `type` 'mrs' | 'mr' | 'company' | 'other'
          - `title` string
          - `contactPerson` string
          - `department` string
          - `subDepartment` string
          - `addressSupplement` string
          - `street` string
          - `zipCode` string
          - `city` string
          - `state` string
          - `country` string
          - `salutation` string
          - `gln` string
          - `email` string
          - `phone` string
          - `fax` string
          - `mobile` string
    - `meta` object — Pagination meta data
      - `currentPage` integer — The current page number
      - `from` integer, nullable — The first item being returned in the current page
      - `path` string — The base path for the paginated results
      - `perPage` integer — The number of items shown per page
      - `to` integer, nullable — The last item being returned in the current page
    - `links` object — Pagination links
      - `first` string, nullable — URL to the first page
      - `last` string, nullable — URL to the last page
      - `prev` string, nullable — URL to the previous page
      - `next` string, nullable — URL to the next page
  - object
    - `data` object[]
      - `id` string — ID of the document
      - `documentNumber` string — Document number. For drafts, this will be null.
      - `documentDate` string, date — Main date of the document.
      - `writeProtection` boolean — Indicates if the document is write protected.
      - `customerNumber` string — Customer number of the document.
      - `address` union — Address entity of the document. By default, only the ID is returned. To get the full Address object, use the `include` parameter.
        - object
          - `id` string, required
          - `isDeleted` boolean — Flagged if the entry was deleted.
          - `createdAt` string, date-time, required — Creation timestamp
          - `updatedAt` string, date-time, required — Last update timestamp
        - object
          - `id` string
      - `project` union — Project entity of the document. By default, only the ID is returned. To get the full Project object, use the `include` parameter.
        - object
          - `id` string, required
          - `name` string, required
          - `abbreviation` string, required
        - object
          - `id` string
      - `tags` object[] — Tags assigned to the document. This property is only returned if the `tags` include is used.
        - `id` string — ID of the tag
        - `title` string — Title of the tag
      - `documentAddress` object — The recipients postal address of the document. This is is usually the postal address of the document's address entitiy, (e.g. customer), or is populated based on the preceding document. As this address is persisted on the document level, it can however be modified independently, and does not reflect changes that occurred since the document was created.
        - `name` string, required — Represents an address consisting of a physical address and contact information. It is used in various documents, such as invoices, delivery notes, etc.
        - `type` 'mrs' | 'mr' | 'company' | 'other'
        - `title` string
        - `contactPerson` string
        - `department` string
        - `subDepartment` string
        - `addressSupplement` string
        - `street` string
        - `zipCode` string
        - `city` string
        - `state` string
        - `country` string
        - `salutation` string
        - `gln` string
        - `email` string
        - `phone` string
        - `fax` string
        - `mobile` string
      - `internalDesignation` string — Internal designation, might be displayed in the letterhead.
      - `isDocumentSent` boolean — Indicates if the document has been sent to the recipient.
      - `language` string — ISO 639-1 Language of the document.
      - `bodyIntroduction` string — Text displayed on the document before the line items.
      - `bodyOutroduction` string — Text displayed on the document after the line items.
      - `vatId` string — VAT ID of the document.
      - `deliveryTerms` string — Delivery terms of the document.
      - `internalComment` string — Internal comment, does not show up on the document. Intended to be used for company-internal notes.
      - `editor` object
        - `id` string — ID of the user who is responsible for the document.
      - `printSettings` object
        - `withoutLetterhead` boolean — For PDFs or physical documents, hide the letterhead
        - `withoutProductText` boolean — For PDFs or physical documents, hide the product text
      - `activity` object[] — Activity log entries associated with the document. To get activity object, use the `include` parameter.
        - `message` string, required
        - `causer` string, required
        - `causedAt` string, date-time, required
      - `customFields` object[] — Custom fields with their values and metadata
        - `key` string
        - `value` string
        - `label` string
      - `updatedAt` string, date-time
      - `createdAt` string, date-time
      - `salesOrder` object — Sales order reference.
        - `id` string — ID of the sales order
      - `invoice` object — invoice reference.
        - `id` string — ID of the invoice
      - `preferredWarehouse` object — Preferred warehouse for the document.
        - `id` string — ID of the preferred warehouse
      - `sales` object — Sales person responsible for the document.
        - `id` string
      - `status` 'draft' | 'released' | 'completed' | 'cancelled' — Status of the document.
      - `customerOrderNumber` string — Customer order number of the return order, e.g. the customer's order number.
      - `creditNote` object — Credit note connected to the return order.
        - `id` string
      - `deliveryNote` object — Delivery note connected to the return order.
        - `id` string
      - `replacementSalesOrder` object — Replacement sales order connected to the return order.
        - `id` string
      - `progress` 'announced' | 'received' | 'checked' | 'done' — Progress of the return order.
      - `useAlternativeDocumentTitle` boolean — Indicates if the alternative document title should be used. The alternative document title can be configured per document type in the system settings.
      - `isReturnOrderToSupplier` boolean — Indicates whether this is a return order to a supplier.
      - `supplierNumber` string — Supplier number of the supplier return order.
      - `lineItems` union[]
        - union
          - object
            - `type` 'product'
            - `id` string — ID of the line item.
            - `number` string — The Number of the line item. Usually the product SKU, but can be adjusted if required.
            - `name` string — The name of the line item. Usually the product name, but can be adjusted if required.
            - `description` string — The description of the line item. Usually the product description, but can be adjusted if required.
            - `quantity` number, float — The quantity of the line item.
            - `product` union — The product of the line item.
              - …
            - `countryOfOrigin` unknown
            - `hsCode` unknown
            - `customFields` object[] — Custom fields with their values and metadata.
              - …
            - `unit` string — The unit of the line item.
            - `deliveryDate` string, date — The delivery date of the line item.
            - `deliveryDateAsCalendarWeek` boolean — Whether to show the delivery date as calendar week or explicit.
            - `packagingUnit` string — The unit of packaging for the line item.
            - `internalComment` string — Internal comment, does not show up on the document. Intended to be used for company-internal notes.
            - `customerProductNumber` string — Customer product number for the line item.
            - `order` integer — The ordering sequence of the line item.
            - `updatedAt` string, date-time — The date and time when the line item was last updated.
            - `createdAt` string, date-time — The date and time when the line item was created.
            - `salesOrderLineItem` object — sales order line item reference.
              - …
            - `deliveredQuantity` unknown
            - `reimbursementQuantity` number, float — The quantity of the product that has been credited on the credit note.
            - `receivedQuantity` number, float — The quantity of the product that has been received back into inventory.
            - `returnReason` object — The reason for returning the product.
              - …
            - `parentLineItem` object — If this line item is a child line item, this will contain the parent line item ID.
              - …
            - `deliveryNoteLineItem` object — The delivery note line item this return order line item references.
              - …
            - `defaultStorageLocation` object — The default storage location for returned goods.
              - …
            - `printSettings` object — Print settings for this line item.
              - …
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'heading', required
            - `name` string
            - `description` string
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'subtotal', required
            - `name` string
            - `description` string
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'group_total', required
            - `name` string
            - `description` string
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'image', required
            - `name` string
            - `description` string
            - `image` object
              - …
            - `imageHeight` unknown
            - `imageWidth` unknown
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'page_break', required
      - `shippingMethod` object — Shipping method of the return order.
        - `id` string
      - `effectiveAddresses` object — Effective addresses of the return order. These (read-only) postal addresses will always be set, regardless of whether a deviating return-to address is set or not. Use these fields if you need to easily determine the return-to of the return order. For updating, use the `documentAddress` fields.
        - `soldTo` object — Represents a postal address with contact information.
          - `name` string, required — Represents an address consisting of a physical address and contact information. It is used in various documents, such as invoices, delivery notes, etc.
          - `type` 'mrs' | 'mr' | 'company' | 'other'
          - `title` string
          - `contactPerson` string
          - `department` string
          - `subDepartment` string
          - `addressSupplement` string
          - `street` string
          - `zipCode` string
          - `city` string
          - `state` string
          - `country` string
          - `salutation` string
          - `gln` string
          - `email` string
          - `phone` string
          - `fax` string
          - `mobile` string
        - `returnTo` object — Represents a postal address with contact information.
          - `name` string, required — Represents an address consisting of a physical address and contact information. It is used in various documents, such as invoices, delivery notes, etc.
          - `type` 'mrs' | 'mr' | 'company' | 'other'
          - `title` string
          - `contactPerson` string
          - `department` string
          - `subDepartment` string
          - `addressSupplement` string
          - `street` string
          - `zipCode` string
          - `city` string
          - `state` string
          - `country` string
          - `salutation` string
          - `gln` string
          - `email` string
          - `phone` string
          - `fax` string
          - `mobile` string
    - `links` object
      - `first` string, nullable — URL to the first page
      - `last` string, nullable — URL to the last page
      - `prev` string, nullable — URL to the previous page
      - `next` string, nullable — URL to the next page
    - `meta` object
      - `currentPage` integer — The current page number
      - `from` integer, nullable — The first item being returned in the current page
      - `lastPage` integer — The last page number
      - `path` string — The base path for the paginated results
      - `perPage` integer — The number of items shown per page
      - `to` integer, nullable — The last item being returned in the current page
      - `total` integer — The total number of items
  - object
    - `data` object[]
      - `id` string — ID of the document
      - `documentNumber` string — Document number. For drafts, this will be null.
      - `documentDate` string, date — Main date of the document.
      - `writeProtection` boolean — Indicates if the document is write protected.
      - `customerNumber` string — Customer number of the document.
      - `address` union — Address entity of the document. By default, only the ID is returned. To get the full Address object, use the `include` parameter.
        - object
          - `id` string, required
          - `isDeleted` boolean — Flagged if the entry was deleted.
          - `createdAt` string, date-time, required — Creation timestamp
          - `updatedAt` string, date-time, required — Last update timestamp
        - object
          - `id` string
      - `project` union — Project entity of the document. By default, only the ID is returned. To get the full Project object, use the `include` parameter.
        - object
          - `id` string, required
          - `name` string, required
          - `abbreviation` string, required
        - object
          - `id` string
      - `tags` object[] — Tags assigned to the document. This property is only returned if the `tags` include is used.
        - `id` string — ID of the tag
        - `title` string — Title of the tag
      - `documentAddress` object — The recipients postal address of the document. This is is usually the postal address of the document's address entitiy, (e.g. customer), or is populated based on the preceding document. As this address is persisted on the document level, it can however be modified independently, and does not reflect changes that occurred since the document was created.
        - `name` string, required — Represents an address consisting of a physical address and contact information. It is used in various documents, such as invoices, delivery notes, etc.
        - `type` 'mrs' | 'mr' | 'company' | 'other'
        - `title` string
        - `contactPerson` string
        - `department` string
        - `subDepartment` string
        - `addressSupplement` string
        - `street` string
        - `zipCode` string
        - `city` string
        - `state` string
        - `country` string
        - `salutation` string
        - `gln` string
        - `email` string
        - `phone` string
        - `fax` string
        - `mobile` string
      - `internalDesignation` string — Internal designation, might be displayed in the letterhead.
      - `isDocumentSent` boolean — Indicates if the document has been sent to the recipient.
      - `language` string — ISO 639-1 Language of the document.
      - `bodyIntroduction` string — Text displayed on the document before the line items.
      - `bodyOutroduction` string — Text displayed on the document after the line items.
      - `vatId` string — VAT ID of the document.
      - `deliveryTerms` string — Delivery terms of the document.
      - `internalComment` string — Internal comment, does not show up on the document. Intended to be used for company-internal notes.
      - `editor` object
        - `id` string — ID of the user who is responsible for the document.
      - `printSettings` object
        - `withoutLetterhead` boolean — For PDFs or physical documents, hide the letterhead
        - `withoutProductText` boolean — For PDFs or physical documents, hide the product text
      - `activity` object[] — Activity log entries associated with the document. To get activity object, use the `include` parameter.
        - `message` string, required
        - `causer` string, required
        - `causedAt` string, date-time, required
      - `customFields` object[] — Custom fields with their values and metadata
        - `key` string
        - `value` string
        - `label` string
      - `updatedAt` string, date-time
      - `createdAt` string, date-time
      - `salesOrder` object — Sales order reference.
        - `id` string — ID of the sales order
      - `invoice` object — invoice reference.
        - `id` string — ID of the invoice
      - `preferredWarehouse` object — Preferred warehouse for the document.
        - `id` string — ID of the preferred warehouse
      - `sales` object — Sales person responsible for the document.
        - `id` string
      - `status` 'draft' | 'released' | 'completed' | 'cancelled' — Status of the document.
      - `customerOrderNumber` string — Customer order number of the return order, e.g. the customer's order number.
      - `creditNote` object — Credit note connected to the return order.
        - `id` string
      - `deliveryNote` object — Delivery note connected to the return order.
        - `id` string
      - `replacementSalesOrder` object — Replacement sales order connected to the return order.
        - `id` string
      - `progress` 'announced' | 'received' | 'checked' | 'done' — Progress of the return order.
      - `useAlternativeDocumentTitle` boolean — Indicates if the alternative document title should be used. The alternative document title can be configured per document type in the system settings.
      - `isReturnOrderToSupplier` boolean — Indicates whether this is a return order to a supplier.
      - `supplierNumber` string — Supplier number of the supplier return order.
      - `lineItems` union[]
        - union
          - object
            - `type` 'product'
            - `id` string — ID of the line item.
            - `number` string — The Number of the line item. Usually the product SKU, but can be adjusted if required.
            - `name` string — The name of the line item. Usually the product name, but can be adjusted if required.
            - `description` string — The description of the line item. Usually the product description, but can be adjusted if required.
            - `quantity` number, float — The quantity of the line item.
            - `product` union — The product of the line item.
              - …
            - `countryOfOrigin` unknown
            - `hsCode` unknown
            - `customFields` object[] — Custom fields with their values and metadata.
              - …
            - `unit` string — The unit of the line item.
            - `deliveryDate` string, date — The delivery date of the line item.
            - `deliveryDateAsCalendarWeek` boolean — Whether to show the delivery date as calendar week or explicit.
            - `packagingUnit` string — The unit of packaging for the line item.
            - `internalComment` string — Internal comment, does not show up on the document. Intended to be used for company-internal notes.
            - `customerProductNumber` string — Customer product number for the line item.
            - `order` integer — The ordering sequence of the line item.
            - `updatedAt` string, date-time — The date and time when the line item was last updated.
            - `createdAt` string, date-time — The date and time when the line item was created.
            - `salesOrderLineItem` object — sales order line item reference.
              - …
            - `deliveredQuantity` unknown
            - `reimbursementQuantity` number, float — The quantity of the product that has been credited on the credit note.
            - `receivedQuantity` number, float — The quantity of the product that has been received back into inventory.
            - `returnReason` object — The reason for returning the product.
              - …
            - `parentLineItem` object — If this line item is a child line item, this will contain the parent line item ID.
              - …
            - `deliveryNoteLineItem` object — The delivery note line item this return order line item references.
              - …
            - `defaultStorageLocation` object — The default storage location for returned goods.
              - …
            - `printSettings` object — Print settings for this line item.
              - …
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'heading', required
            - `name` string
            - `description` string
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'subtotal', required
            - `name` string
            - `description` string
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'group_total', required
            - `name` string
            - `description` string
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'image', required
            - `name` string
            - `description` string
            - `image` object
              - …
            - `imageHeight` unknown
            - `imageWidth` unknown
          - object
            - `id` string, required
            - `order` integer — The ordering sequence of the line item
            - `type` 'page_break', required
      - `shippingMethod` object — Shipping method of the return order.
        - `id` string
      - `effectiveAddresses` object — Effective addresses of the return order. These (read-only) postal addresses will always be set, regardless of whether a deviating return-to address is set or not. Use these fields if you need to easily determine the return-to of the return order. For updating, use the `documentAddress` fields.
        - `soldTo` object — Represents a postal address with contact information.
          - `name` string, required — Represents an address consisting of a physical address and contact information. It is used in various documents, such as invoices, delivery notes, etc.
          - `type` 'mrs' | 'mr' | 'company' | 'other'
          - `title` string
          - `contactPerson` string
          - `department` string
          - `subDepartment` string
          - `addressSupplement` string
          - `street` string
          - `zipCode` string
          - `city` string
          - `state` string
          - `country` string
          - `salutation` string
          - `gln` string
          - `email` string
          - `phone` string
          - `fax` string
          - `mobile` string
        - `returnTo` object — Represents a postal address with contact information.
          - `name` string, required — Represents an address consisting of a physical address and contact information. It is used in various documents, such as invoices, delivery notes, etc.
          - `type` 'mrs' | 'mr' | 'company' | 'other'
          - `title` string
          - `contactPerson` string
          - `department` string
          - `subDepartment` string
          - `addressSupplement` string
          - `street` string
          - `zipCode` string
          - `city` string
          - `state` string
          - `country` string
          - `salutation` string
          - `gln` string
          - `email` string
          - `phone` string
          - `fax` string
          - `mobile` string
    - `links` object — Pagination links
      - `first` string, nullable — URL to the first page
      - `last` string, nullable — URL to the last page
      - `prev` string, nullable — URL to the previous page
      - `next` string, nullable — URL to the next page
    - `meta` object — Pagination meta data
      - `path` string — The base path for the paginated results
      - `perPage` integer — The number of items shown per page
      - `nextCursor` string, nullable — Cursor for the next page
      - `prevCursor` string, nullable — Cursor for the previous page

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests

---

[API](https://skmtc.dev/xentral/apis/xentral-api.md) · [All operations](https://skmtc.dev/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)
