curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"mapping_config": [
{
"pushField": "<string>",
"lumField": "<string>",
"transformation": "<string>",
"transformationConfig": {}
}
],
"fulfillment_order_id": 123
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/preview"
payload = {
"mapping_config": [
{
"pushField": "<string>",
"lumField": "<string>",
"transformation": "<string>",
"transformationConfig": {}
}
],
"fulfillment_order_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({
mapping_config: [
{
pushField: '<string>',
lumField: '<string>',
transformation: '<string>',
transformationConfig: {}
}
],
fulfillment_order_id: 123
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/preview', 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}/preview",
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([
'mapping_config' => [
[
'pushField' => '<string>',
'lumField' => '<string>',
'transformation' => '<string>',
'transformationConfig' => [
]
]
],
'fulfillment_order_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}/preview"
payload := strings.NewReader("{\n \"mapping_config\": [\n {\n \"pushField\": \"<string>\",\n \"lumField\": \"<string>\",\n \"transformation\": \"<string>\",\n \"transformationConfig\": {}\n }\n ],\n \"fulfillment_order_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}/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mapping_config\": [\n {\n \"pushField\": \"<string>\",\n \"lumField\": \"<string>\",\n \"transformation\": \"<string>\",\n \"transformationConfig\": {}\n }\n ],\n \"fulfillment_order_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/preview")
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 \"mapping_config\": [\n {\n \"pushField\": \"<string>\",\n \"lumField\": \"<string>\",\n \"transformation\": \"<string>\",\n \"transformationConfig\": {}\n }\n ],\n \"fulfillment_order_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"output": {},
"rows": [
{
"index": 123,
"lumField": "<string>",
"pushField": "<string>",
"status": "ok",
"message": "<string>",
"resolvedValue": "<unknown>"
}
],
"summary": {
"total": 123,
"ok": 123,
"empty": 123,
"error": 123
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Preview a mapping (dry run)
Run the mapping’s stored source sample (source_order_json) through the same
transformation engine the push path uses, and return what the destination would
receive. This makes no OMS call and writes nothing — it is how a mapping gets
tested without pushing a real order.
Pass mapping_config to preview unsaved edits from the mapping editor; omit it to
preview the stored config. Pass fulfillment_order_id to dry-run against a live
fulfillment order sample instead of the stored source_order_json — that sample is
not persisted on the mapping.
The returned output omits nulls and empty strings, matching what the push path sends.
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"mapping_config": [
{
"pushField": "<string>",
"lumField": "<string>",
"transformation": "<string>",
"transformationConfig": {}
}
],
"fulfillment_order_id": 123
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/preview"
payload = {
"mapping_config": [
{
"pushField": "<string>",
"lumField": "<string>",
"transformation": "<string>",
"transformationConfig": {}
}
],
"fulfillment_order_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({
mapping_config: [
{
pushField: '<string>',
lumField: '<string>',
transformation: '<string>',
transformationConfig: {}
}
],
fulfillment_order_id: 123
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/preview', 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}/preview",
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([
'mapping_config' => [
[
'pushField' => '<string>',
'lumField' => '<string>',
'transformation' => '<string>',
'transformationConfig' => [
]
]
],
'fulfillment_order_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}/preview"
payload := strings.NewReader("{\n \"mapping_config\": [\n {\n \"pushField\": \"<string>\",\n \"lumField\": \"<string>\",\n \"transformation\": \"<string>\",\n \"transformationConfig\": {}\n }\n ],\n \"fulfillment_order_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}/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mapping_config\": [\n {\n \"pushField\": \"<string>\",\n \"lumField\": \"<string>\",\n \"transformation\": \"<string>\",\n \"transformationConfig\": {}\n }\n ],\n \"fulfillment_order_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/preview")
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 \"mapping_config\": [\n {\n \"pushField\": \"<string>\",\n \"lumField\": \"<string>\",\n \"transformation\": \"<string>\",\n \"transformationConfig\": {}\n }\n ],\n \"fulfillment_order_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"output": {},
"rows": [
{
"index": 123,
"lumField": "<string>",
"pushField": "<string>",
"status": "ok",
"message": "<string>",
"resolvedValue": "<unknown>"
}
],
"summary": {
"total": 123,
"ok": 123,
"empty": 123,
"error": 123
}
}
}{
"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
Config to preview. Omit to preview the stored config. Each row requires a pushField.
Show child attributes
Show child attributes
Fulfillment order ID (sales_orders_shipments.id) to extract a live source sample from. Omit to use the mapping's stored source_order_json. Does not write to the mapping.
Response
Successful response
Show child attributes
Show child attributes