Update Return Line Item
curl --request PATCH \
--url https://api.jtl-cloud.com/erp/v2/returns/{returnId}/line-items/{lineItemId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-tenant-id: <x-tenant-id>' \
--data '
{
"stateId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"quantity": 123,
"returnReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"returnReasonComment": "<string>",
"conditionId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"conditionComment": "<string>",
"credit": true
}
'import requests
url = "https://api.jtl-cloud.com/erp/v2/returns/{returnId}/line-items/{lineItemId}"
payload = {
"stateId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"quantity": 123,
"returnReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"returnReasonComment": "<string>",
"conditionId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"conditionComment": "<string>",
"credit": True
}
headers = {
"x-tenant-id": "<x-tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-tenant-id': '<x-tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
stateId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
quantity: 123,
returnReasonId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
returnReasonComment: '<string>',
conditionId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
conditionComment: '<string>',
credit: true
})
};
fetch('https://api.jtl-cloud.com/erp/v2/returns/{returnId}/line-items/{lineItemId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.jtl-cloud.com/erp/v2/returns/{returnId}/line-items/{lineItemId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'stateId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'quantity' => 123,
'returnReasonId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'returnReasonComment' => '<string>',
'conditionId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'conditionComment' => '<string>',
'credit' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-tenant-id: <x-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.jtl-cloud.com/erp/v2/returns/{returnId}/line-items/{lineItemId}"
payload := strings.NewReader("{\n \"stateId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"quantity\": 123,\n \"returnReasonId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"returnReasonComment\": \"<string>\",\n \"conditionId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"conditionComment\": \"<string>\",\n \"credit\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-tenant-id", "<x-tenant-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.jtl-cloud.com/erp/v2/returns/{returnId}/line-items/{lineItemId}")
.header("x-tenant-id", "<x-tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"stateId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"quantity\": 123,\n \"returnReasonId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"returnReasonComment\": \"<string>\",\n \"conditionId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"conditionComment\": \"<string>\",\n \"credit\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.jtl-cloud.com/erp/v2/returns/{returnId}/line-items/{lineItemId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"stateId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"quantity\": 123,\n \"returnReasonId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"returnReasonComment\": \"<string>\",\n \"conditionId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"conditionComment\": \"<string>\",\n \"credit\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"returnId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"stateId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"name": "<string>",
"itemNumber": "<string>",
"quantity": 123,
"returnReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"returnReasonComment": "<string>",
"conditionId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"conditionComment": "<string>",
"credit": true,
"salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"salesOrderLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"deliveryNoteLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}Return
Update Return Line Item
Updates a specific line item of an existing return - state, quantity, return reason and its comment, condition and its comment, and the credit flag. The state of the return is inferred from the states of its line items.
PATCH
/
v2
/
returns
/
{returnId}
/
line-items
/
{lineItemId}
Update Return Line Item
curl --request PATCH \
--url https://api.jtl-cloud.com/erp/v2/returns/{returnId}/line-items/{lineItemId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-tenant-id: <x-tenant-id>' \
--data '
{
"stateId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"quantity": 123,
"returnReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"returnReasonComment": "<string>",
"conditionId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"conditionComment": "<string>",
"credit": true
}
'import requests
url = "https://api.jtl-cloud.com/erp/v2/returns/{returnId}/line-items/{lineItemId}"
payload = {
"stateId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"quantity": 123,
"returnReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"returnReasonComment": "<string>",
"conditionId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"conditionComment": "<string>",
"credit": True
}
headers = {
"x-tenant-id": "<x-tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-tenant-id': '<x-tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
stateId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
quantity: 123,
returnReasonId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
returnReasonComment: '<string>',
conditionId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
conditionComment: '<string>',
credit: true
})
};
fetch('https://api.jtl-cloud.com/erp/v2/returns/{returnId}/line-items/{lineItemId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.jtl-cloud.com/erp/v2/returns/{returnId}/line-items/{lineItemId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'stateId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'quantity' => 123,
'returnReasonId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'returnReasonComment' => '<string>',
'conditionId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
'conditionComment' => '<string>',
'credit' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-tenant-id: <x-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.jtl-cloud.com/erp/v2/returns/{returnId}/line-items/{lineItemId}"
payload := strings.NewReader("{\n \"stateId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"quantity\": 123,\n \"returnReasonId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"returnReasonComment\": \"<string>\",\n \"conditionId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"conditionComment\": \"<string>\",\n \"credit\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-tenant-id", "<x-tenant-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.jtl-cloud.com/erp/v2/returns/{returnId}/line-items/{lineItemId}")
.header("x-tenant-id", "<x-tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"stateId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"quantity\": 123,\n \"returnReasonId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"returnReasonComment\": \"<string>\",\n \"conditionId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"conditionComment\": \"<string>\",\n \"credit\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.jtl-cloud.com/erp/v2/returns/{returnId}/line-items/{lineItemId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"stateId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"quantity\": 123,\n \"returnReasonId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"returnReasonComment\": \"<string>\",\n \"conditionId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n \"conditionComment\": \"<string>\",\n \"credit\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"returnId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"stateId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"name": "<string>",
"itemNumber": "<string>",
"quantity": 123,
"returnReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"returnReasonComment": "<string>",
"conditionId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"conditionComment": "<string>",
"credit": true,
"salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"salesOrderLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"deliveryNoteLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}Authorizations
oauth2-authorization-codeoauth2-client-credentials
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
The Company-Id (int or uuid) of the company on whose behalf the request is executed.
Optional, client-generated key for deduplicating repeated write requests. A repeated request with the same key returns the originally recorded result instead of executing the effect again.
Required string length:
1 - 255The tenant ID for the target ERP instance.
Path Parameters
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
Body
application/json
Request parameters
Updates a specific line item of an existing return - state, quantity, return reason and its comment, condition and its comment, and the credit flag. The state of the return is inferred from the states of its line items. - Request
The new state of the line item.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
The new quantity of the line item.
The return reason of the line item.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
The comment for the return reason.
The item condition after inspection.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
The comment for the item condition.
Indicates whether the line item should be credited.
Response
The updated line item.
Model Class: ReturnLineItem
Unique ID to identify a return line item.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
Unique ID to identify a return.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
The ID of the return line item state.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
Unique ID to identify an item.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
Name of the position.
The item number of the line item.
The quantity of the line item.
Unique ID to identify a return reason.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
The comment corresponding to the return line item reason.
Unique ID to identify a condition.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
The comment corresponding to the return line item condition.
Indicates whether this return line item should be credited.
Unique ID to identify a sales order.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
Unique ID to identify a sales order item.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
Unique ID to identify a delivery note item.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
Was this page helpful?