curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"source_order_id": 123,
"source_product_id": 123,
"source_purchase_order_id": 123,
"source_supplier_purchase_order_shipment_id": 123,
"mapping_config": [
{}
],
"is_active": true,
"restored_from_version_id": 123
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"source_order_id": 123,
"source_product_id": 123,
"source_purchase_order_id": 123,
"source_supplier_purchase_order_shipment_id": 123,
"mapping_config": [{}],
"is_active": True,
"restored_from_version_id": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
source_order_id: 123,
source_product_id: 123,
source_purchase_order_id: 123,
source_supplier_purchase_order_shipment_id: 123,
mapping_config: [{}],
is_active: true,
restored_from_version_id: 123
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}', 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://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'source_order_id' => 123,
'source_product_id' => 123,
'source_purchase_order_id' => 123,
'source_supplier_purchase_order_shipment_id' => 123,
'mapping_config' => [
[
]
],
'is_active' => true,
'restored_from_version_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"source_order_id\": 123,\n \"source_product_id\": 123,\n \"source_purchase_order_id\": 123,\n \"source_supplier_purchase_order_shipment_id\": 123,\n \"mapping_config\": [\n {}\n ],\n \"is_active\": true,\n \"restored_from_version_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"source_order_id\": 123,\n \"source_product_id\": 123,\n \"source_purchase_order_id\": 123,\n \"source_supplier_purchase_order_shipment_id\": 123,\n \"mapping_config\": [\n {}\n ],\n \"is_active\": true,\n \"restored_from_version_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"source_order_id\": 123,\n \"source_product_id\": 123,\n \"source_purchase_order_id\": 123,\n \"source_supplier_purchase_order_shipment_id\": 123,\n \"mapping_config\": [\n {}\n ],\n \"is_active\": true,\n \"restored_from_version_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Update an integration mapping
Update an existing integration mapping by ID.
When changing mapping_config, see the Integration Mapping Guide
for the rule structure, field-path syntax, the full transformation catalogue, and
fallback behavior.
At most one of source_order_id, source_product_id, or source_purchase_order_id
may be set on a single request. source_supplier_purchase_order_shipment_id links the
mapping to an inbound purchase-order shipment (for PUSH_INBOUND_SHIPMENT mappings).
On these inbound-shipment mappings, updating source_supplier_purchase_order_shipment_id
alone re-infers source_purchase_order_id from the shipment’s linked purchase-order
items (the majority PO); the request is rejected if the shipment has none.
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"source_order_id": 123,
"source_product_id": 123,
"source_purchase_order_id": 123,
"source_supplier_purchase_order_shipment_id": 123,
"mapping_config": [
{}
],
"is_active": true,
"restored_from_version_id": 123
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"source_order_id": 123,
"source_product_id": 123,
"source_purchase_order_id": 123,
"source_supplier_purchase_order_shipment_id": 123,
"mapping_config": [{}],
"is_active": True,
"restored_from_version_id": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
source_order_id: 123,
source_product_id: 123,
source_purchase_order_id: 123,
source_supplier_purchase_order_shipment_id: 123,
mapping_config: [{}],
is_active: true,
restored_from_version_id: 123
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}', 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://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'source_order_id' => 123,
'source_product_id' => 123,
'source_purchase_order_id' => 123,
'source_supplier_purchase_order_shipment_id' => 123,
'mapping_config' => [
[
]
],
'is_active' => true,
'restored_from_version_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"source_order_id\": 123,\n \"source_product_id\": 123,\n \"source_purchase_order_id\": 123,\n \"source_supplier_purchase_order_shipment_id\": 123,\n \"mapping_config\": [\n {}\n ],\n \"is_active\": true,\n \"restored_from_version_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"source_order_id\": 123,\n \"source_product_id\": 123,\n \"source_purchase_order_id\": 123,\n \"source_supplier_purchase_order_shipment_id\": 123,\n \"mapping_config\": [\n {}\n ],\n \"is_active\": true,\n \"restored_from_version_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"source_order_id\": 123,\n \"source_product_id\": 123,\n \"source_purchase_order_id\": 123,\n \"source_supplier_purchase_order_shipment_id\": 123,\n \"mapping_config\": [\n {}\n ],\n \"is_active\": true,\n \"restored_from_version_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
Integration mapping ID
Body
255Source fulfillment order. Mutually exclusive with the other two source_* order fields.
Source product. Mutually exclusive with the other two source_* order fields.
Source purchase order. Mutually exclusive with the other two source_* order fields.
Inbound purchase-order shipment the mapping is sourced from (for PUSH_INBOUND_SHIPMENT mappings). Setting this without source_purchase_order_id infers the purchase order from the shipment's linked purchase-order items; the request is rejected if the shipment has none.
When this save restores an earlier version, set this to that version's id (from GET /integration-mappings/{id}/versions) to tag the recorded snapshot as a restore. Leave unset for normal edits.
Response
Successful response
Updated integration mapping record (same shape as GET /integration-mappings/{id}).