---
title: "Create Return"
method: POST
path: "/v2/returns"
tags: ["return"]
---

# Create Return

`POST /v2/returns`

Create a new return with associated items and packages.

## Headers

- `x-tenant-id` string, uuid, required
- `x-runas` string
- `x-companyid` string

## Request body

- JTLWawiRestContractsModelsV1ReturnCreateReturn — Model Class: CreateReturn
  - `returnDate` string, date-time — The date when the return was created.
  - `externalNumber` string — An arbitrary external reference number for identifying the return, provided only during creation and cannot be changed afterward.
  - `companyId` string, uuid — Represents a key for identifying a firm within the application.
  - `salesOrderId` string, uuid
  - `warehouseId` string, uuid
  - `externalComment` string — The external comment of the sales order.
  - `internalComment` string — The internal comment of the sales order.
  - `contact` string — The contact of the return.
  - `items` JTLWawiRestContractsModelsV1ReturnCreateReturnLineItem[] — List of items included in the return.
    - `quantity` number — The quantity of the line item.
    - `returnReasonId` string, uuid
    - `returnReasonComment` string — The comment corresponding to the return line item reason.
    - `credit` boolean — Indicates whether this return line item should be credited. If omitted on creation, defaults to false.
    - `salesOrderLineItemId` string, uuid
    - `deliveryNoteLineItemId` string, uuid
  - `packages` JTLWawiRestContractsModelsV1ReturnCreateReturnPackage[] — List of packages included in the return.
    - `trackingID` string — The tracking Id of the package.
    - `shippingMethodId` string, uuid
    - `shippingMethodCustom` string — The custom shipping method name used for the return. This value may only be set if ShippingMethodId is not provided.
  - `transmitToSalesChannel` boolean — Indicates whether the return should be transmitted to the sales channel (e.g. SCX or Amazon).

## Response `201`

The created return.

- JTLWawiRestContractsModelsV1ReturnReturn — Model Class: Return
  - `id` string, uuid
  - `number` string — The number of the return.
  - `returnDate` string, date-time — The date when the return was created.
  - `customerId` string, uuid — Represents a unique key for identifying a customer in the JTL system.
  - `externalNumber` string — An arbitrary external reference number for identifying the return, provided only during creation and cannot be changed afterward.
  - `origin` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 — 0 = None, 1 = Email, 2 = Manual, 3 = Phone, 4 = Fax, 5 = FFN, 6 = SCX, 7 = RestAPI
  - `companyId` string, uuid — Represents a key for identifying a firm within the application.
  - `salesOrderId` string, uuid
  - `stateId` string, uuid
  - `warehouseId` string, uuid
  - `externalComment` string — The external comment of the sales order.
  - `internalComment` string — The internal comment of the sales order.
  - `contact` string — The contact of the return.
  - `transmitToSalesChannel` boolean — Indicates whether the return should be transmitted to the sales channel (e.g. SCX or Amazon).

## Other responses

- `400` — The sent data is invalid.
- `401`
- `402` — No licence available or the app has not been authorised by JTL.
- `500` — An error occurred while processing the request.

---

[API](https://skmtc.net/jtl-software/apis/scx-authentication-api.md) · [All operations](https://skmtc.net/jtl-software/apis/scx-authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jtl-software/scx-authentication-api/versions/f979b1ea6951/schema)