--- title: "๐Ÿ”’ Update return order V3" method: PATCH path: "/api/v3/returnOrders/{id}" tags: ["ReturnOrder"] --- # ๐Ÿ”’ Update return order V3 `PATCH /api/v3/returnOrders/{id}` This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `return:update`. Update a return order. ## Path parameters - `id` string, required ## Request body - object - `documentDate` string, date โ€” Date of the document - `documentAddress` object โ€” The recipients postal address of the document - `type` 'mrs' | 'mr' | 'company' | 'other' โ€” Type of the recipient - `name` string โ€” Name of the recipient - `title` string โ€” Title of the recipient - `contactPerson` string โ€” Contact person - `department` string โ€” Department - `subDepartment` string โ€” Sub-department - `addressSupplement` string โ€” Address supplement - `street` string โ€” Street address - `zipCode` string โ€” ZIP Code - `city` string โ€” City - `state` string โ€” State - `country` string โ€” Country - `gln` string โ€” Global Location Number - `salutation` string โ€” Salutation - `email` string โ€” Email address - `phone` string โ€” Phone number - `fax` string โ€” Fax number - `mobile` string โ€” Mobile number - `project` object โ€” The project associated with the document. Set to null to remove project association. - `id` string, required โ€” ID of the project - `internalDesignation` string โ€” Internal designation, might be displayed in the letterhead - `bodyIntroduction` string โ€” Introduction text for the body of the document - `bodyOutroduction` string โ€” Outroduction text for the body of the document - `vatId` string โ€” VAT ID of the business partner - `deliveryTerms` string โ€” Delivery terms for the document - `internalComment` string โ€” Internal comment for the document - `language` string โ€” Language of the document in an ISO-639-1 format. - `printSettings` object โ€” Print settings for the document - `withoutLetterhead` boolean โ€” If true, the document will be printed without letterhead - `withoutProductText` boolean โ€” If true, the document will be printed without product text - `editor` object โ€” Editor information - `id` string โ€” Editor address ID - `tags` object[] โ€” List of tags associated with the document. The passed list replaces the currently associated tags. - `title` string, required โ€” Title of the Tag - `sales` object โ€” Sales information - `id` string โ€” Sales address ID - `salesOrder` object โ€” Linked sales order to the return order - `id` string, required โ€” ID of the sales order - `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 - `customerOrderNumber` string โ€” Customer order number associated with the return order - `useAlternativeDocumentTitle` boolean โ€” Indicates if an alternative document title should be used - `progress` 'announced' | 'received' | 'checked' | 'done' โ€” Progress status of the return order ## Response `200` Update a return order. - 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. - object - โ€ฆ - object - โ€ฆ - `countryOfOrigin` unknown - `hsCode` unknown - `customFields` object[] โ€” Custom fields with their values and metadata. - `key` string - `value` string - `label` string - `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. - `id` string โ€” ID of the line item - `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. - `id` string โ€” The unique identifier of the return reason. - `parentLineItem` object โ€” If this line item is a child line item, this will contain the parent line item ID. - `id` string - `deliveryNoteLineItem` object โ€” The delivery note line item this return order line item references. - `id` string - `defaultStorageLocation` object โ€” The default storage location for returned goods. - `id` string - `printSettings` object โ€” Print settings for this line item. - `hidden` boolean โ€” Hide this line item when printing. - 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 - `id` string - `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 ## Other responses - `400` โ€” Failed validation - `401` โ€” Unauthorized - `403` โ€” Forbidden - `404` โ€” Not Found - `409` โ€” Problem occurred - `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)