Update Return

Update Return

curl --request PATCH \
  --url https://api.jtl-cloud.com/erp/v2/returns/{returnId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "externalComment": "<string>",
  "internalComment": "<string>",
  "contact": "<string>",
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "transmitToSalesChannel": true,
  "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}
'

import requests

url = "https://api.jtl-cloud.com/erp/v2/returns/{returnId}"

payload = {
    "externalComment": "<string>",
    "internalComment": "<string>",
    "contact": "<string>",
    "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "transmitToSalesChannel": True,
    "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}
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({
    externalComment: '<string>',
    internalComment: '<string>',
    contact: '<string>',
    companyId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
    transmitToSalesChannel: true,
    warehouseId: 'b45f6432-2462-4c6f-b00f-1d9d01000000'
  })
};

fetch('https://api.jtl-cloud.com/erp/v2/returns/{returnId}', 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}",
  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([
    'externalComment' => '<string>',
    'internalComment' => '<string>',
    'contact' => '<string>',
    'companyId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
    'transmitToSalesChannel' => true,
    'warehouseId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000'
  ]),
  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}"

	payload := strings.NewReader("{\n  \"externalComment\": \"<string>\",\n  \"internalComment\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n  \"transmitToSalesChannel\": true,\n  \"warehouseId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\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}")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalComment\": \"<string>\",\n  \"internalComment\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n  \"transmitToSalesChannel\": true,\n  \"warehouseId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/returns/{returnId}")

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  \"externalComment\": \"<string>\",\n  \"internalComment\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n  \"transmitToSalesChannel\": true,\n  \"warehouseId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "returnNumber": "<string>",
  "returnDate": "2023-11-07T05:31:56Z",
  "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "externalNumber": "<string>",
  "origin": 0,
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "stateId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "externalComment": "<string>",
  "internalComment": "<string>",
  "contact": "<string>",
  "transmitToSalesChannel": true
}

PATCH

returns

{returnId}

Update Return

curl --request PATCH \
  --url https://api.jtl-cloud.com/erp/v2/returns/{returnId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "externalComment": "<string>",
  "internalComment": "<string>",
  "contact": "<string>",
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "transmitToSalesChannel": true,
  "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}
'

import requests

url = "https://api.jtl-cloud.com/erp/v2/returns/{returnId}"

payload = {
    "externalComment": "<string>",
    "internalComment": "<string>",
    "contact": "<string>",
    "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "transmitToSalesChannel": True,
    "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}
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({
    externalComment: '<string>',
    internalComment: '<string>',
    contact: '<string>',
    companyId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
    transmitToSalesChannel: true,
    warehouseId: 'b45f6432-2462-4c6f-b00f-1d9d01000000'
  })
};

fetch('https://api.jtl-cloud.com/erp/v2/returns/{returnId}', 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}",
  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([
    'externalComment' => '<string>',
    'internalComment' => '<string>',
    'contact' => '<string>',
    'companyId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
    'transmitToSalesChannel' => true,
    'warehouseId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000'
  ]),
  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}"

	payload := strings.NewReader("{\n  \"externalComment\": \"<string>\",\n  \"internalComment\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n  \"transmitToSalesChannel\": true,\n  \"warehouseId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\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}")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalComment\": \"<string>\",\n  \"internalComment\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n  \"transmitToSalesChannel\": true,\n  \"warehouseId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/returns/{returnId}")

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  \"externalComment\": \"<string>\",\n  \"internalComment\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n  \"transmitToSalesChannel\": true,\n  \"warehouseId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "returnNumber": "<string>",
  "returnDate": "2023-11-07T05:31:56Z",
  "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "externalNumber": "<string>",
  "origin": 0,
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "stateId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "externalComment": "<string>",
  "internalComment": "<string>",
  "contact": "<string>",
  "transmitToSalesChannel": true
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-companyid

string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Idempotency-Key

string

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 - 255

x-tenant-id

string<uuid>

required

The tenant ID for the target ERP instance.

Path Parameters

returnId

string<uuid>

required

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Body

application/json

Request parameters

Updates the header data of an existing return - external and internal comment, contact, company, warehouse and sales channel transmission. Line items are updated via the line item endpoint. The state of the return is inferred from its line items and cannot be set directly. - Request

externalComment

string

The external comment of the return.

internalComment

string

The internal comment of the return.

contact

string

The contact person of the return.

companyId

string<uuid>

The company of the return.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

transmitToSalesChannel

boolean

Indicates whether the return should be transmitted to the sales channel.

warehouseId

string<uuid>

The warehouse of the return.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Response

The updated return.

Model Class: Return

string<uuid>

required

Unique ID to identify a return.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

returnNumber

string

required

The number of the return.

returnDate

string<date-time>

required

The date when the return was created.

customerId

string<uuid>

required

The customer ID.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

externalNumber

string

required

An arbitrary external reference number for identifying the return.

origin

enum<integer>

required

Indicates the origin of the return, specifying where or how the return was initiated.

Available options:

0,

1,

2,

3,

4,

5,

6,

7

companyId

string<uuid>

required

The company of the corresponding sales order.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

salesOrderId

string<uuid>

required

The ID of the sales order if the return has exactly one corresponding sales order.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

stateId

string<uuid>

required

The ID of the return state.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

warehouseId

string<uuid>

required

The ID of the warehouse.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

externalComment

string

required

The external comment of the return.

internalComment

string

required

The internal comment of the return.

contact

string

required

The contact of the return.

transmitToSalesChannel

boolean

required

Indicates whether the return should be transmitted to the sales channel.

⌘I

Overview

GraphQL

REST API

Authorizations

Headers

Path Parameters

Body

Response