Repair address and push fulfillment order
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/repair-and-push \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ship_to": {
"postal_code": "<string>",
"state": "<string>",
"city": "<string>",
"country": "<string>",
"street1": "<string>",
"street2": "<string>"
},
"sync_ship_to_to_sales_order": false,
"debug": false
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/repair-and-push"
payload = {
"ship_to": {
"postal_code": "<string>",
"state": "<string>",
"city": "<string>",
"country": "<string>",
"street1": "<string>",
"street2": "<string>"
},
"sync_ship_to_to_sales_order": False,
"debug": False
}
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({
ship_to: {
postal_code: '<string>',
state: '<string>',
city: '<string>',
country: '<string>',
street1: '<string>',
street2: '<string>'
},
sync_ship_to_to_sales_order: false,
debug: false
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/repair-and-push', 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/fulfillment-orders/{fulfillmentOrderId}/repair-and-push",
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([
'ship_to' => [
'postal_code' => '<string>',
'state' => '<string>',
'city' => '<string>',
'country' => '<string>',
'street1' => '<string>',
'street2' => '<string>'
],
'sync_ship_to_to_sales_order' => false,
'debug' => false
]),
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/fulfillment-orders/{fulfillmentOrderId}/repair-and-push"
payload := strings.NewReader("{\n \"ship_to\": {\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\"\n },\n \"sync_ship_to_to_sales_order\": false,\n \"debug\": false\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/fulfillment-orders/{fulfillmentOrderId}/repair-and-push")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ship_to\": {\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\"\n },\n \"sync_ship_to_to_sales_order\": false,\n \"debug\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/repair-and-push")
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 \"ship_to\": {\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\"\n },\n \"sync_ship_to_to_sales_order\": false,\n \"debug\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"success": true,
"message": "Repair and push completed.",
"repaired_fields": {},
"push": {
"success": true,
"message": "<string>",
"data": {}
},
"debug": {}
}
}{
"message": "<string>"
}{
"data": {
"success": false,
"message": "<string>",
"repaired_fields": {}
}
}Fulfillment Orders
Repair address and push fulfillment order
Harness-safe recovery action for a fulfillment order that failed to push because of
address gaps (e.g. a UAE/Israel-style order missing postal_code or state). In one
call it will:
- Apply the supplied
ship_tofields to the fulfillment order (merged onto the existing address), optionally mirroring them to the sales order. - Clear the
error_messageand reset anErrorstatus back toplanned. - Unpush the order first if it was already pushed (
pushed_atset). - Push the order to its destination OMS.
Cannot repair a fulfillment order in a terminal status, or one that already has a picklist.
POST
/
fulfillment-orders
/
{fulfillmentOrderId}
/
repair-and-push
Repair address and push fulfillment order
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/repair-and-push \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ship_to": {
"postal_code": "<string>",
"state": "<string>",
"city": "<string>",
"country": "<string>",
"street1": "<string>",
"street2": "<string>"
},
"sync_ship_to_to_sales_order": false,
"debug": false
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/repair-and-push"
payload = {
"ship_to": {
"postal_code": "<string>",
"state": "<string>",
"city": "<string>",
"country": "<string>",
"street1": "<string>",
"street2": "<string>"
},
"sync_ship_to_to_sales_order": False,
"debug": False
}
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({
ship_to: {
postal_code: '<string>',
state: '<string>',
city: '<string>',
country: '<string>',
street1: '<string>',
street2: '<string>'
},
sync_ship_to_to_sales_order: false,
debug: false
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/repair-and-push', 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/fulfillment-orders/{fulfillmentOrderId}/repair-and-push",
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([
'ship_to' => [
'postal_code' => '<string>',
'state' => '<string>',
'city' => '<string>',
'country' => '<string>',
'street1' => '<string>',
'street2' => '<string>'
],
'sync_ship_to_to_sales_order' => false,
'debug' => false
]),
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/fulfillment-orders/{fulfillmentOrderId}/repair-and-push"
payload := strings.NewReader("{\n \"ship_to\": {\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\"\n },\n \"sync_ship_to_to_sales_order\": false,\n \"debug\": false\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/fulfillment-orders/{fulfillmentOrderId}/repair-and-push")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ship_to\": {\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\"\n },\n \"sync_ship_to_to_sales_order\": false,\n \"debug\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/repair-and-push")
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 \"ship_to\": {\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\"\n },\n \"sync_ship_to_to_sales_order\": false,\n \"debug\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"success": true,
"message": "Repair and push completed.",
"repaired_fields": {},
"push": {
"success": true,
"message": "<string>",
"data": {}
},
"debug": {}
}
}{
"message": "<string>"
}{
"data": {
"success": false,
"message": "<string>",
"repaired_fields": {}
}
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
ID of the fulfillment order
Body
application/json
Address fields to apply (snake_case). Omitted fields are left unchanged.
Show child attributes
Show child attributes
When true, also write the repaired ship_to to the sales order.
When true, capture and return outbound OMS HTTP traffic in data.debug.
Response
Repair and push completed
Show child attributes
Show child attributes