Replace purchase order shipment cartons
curl --request PUT \
--url https://{companyName}.api.joinluminous.com/external/api/v1/purchase-order-shipments/{id}/packages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"packages": [
{
"number_of_identical_packages": 2,
"items": [
{
"supplier_purchase_order_shipment_item_id": 123,
"quantity_per_package": 1
}
],
"length": 1,
"width": 1,
"height": 1,
"dimension_unit": "in",
"weight": 1,
"weight_unit": "lb",
"package_type": "carton",
"carton_template_id": 123,
"sscc": "<string>",
"tracking_number": "<string>"
}
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/purchase-order-shipments/{id}/packages"
payload = { "packages": [
{
"number_of_identical_packages": 2,
"items": [
{
"supplier_purchase_order_shipment_item_id": 123,
"quantity_per_package": 1
}
],
"length": 1,
"width": 1,
"height": 1,
"dimension_unit": "in",
"weight": 1,
"weight_unit": "lb",
"package_type": "carton",
"carton_template_id": 123,
"sscc": "<string>",
"tracking_number": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
packages: [
{
number_of_identical_packages: 2,
items: [{supplier_purchase_order_shipment_item_id: 123, quantity_per_package: 1}],
length: 1,
width: 1,
height: 1,
dimension_unit: 'in',
weight: 1,
weight_unit: 'lb',
package_type: 'carton',
carton_template_id: 123,
sscc: '<string>',
tracking_number: '<string>'
}
]
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/purchase-order-shipments/{id}/packages', 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/purchase-order-shipments/{id}/packages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'packages' => [
[
'number_of_identical_packages' => 2,
'items' => [
[
'supplier_purchase_order_shipment_item_id' => 123,
'quantity_per_package' => 1
]
],
'length' => 1,
'width' => 1,
'height' => 1,
'dimension_unit' => 'in',
'weight' => 1,
'weight_unit' => 'lb',
'package_type' => 'carton',
'carton_template_id' => 123,
'sscc' => '<string>',
'tracking_number' => '<string>'
]
]
]),
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/purchase-order-shipments/{id}/packages"
payload := strings.NewReader("{\n \"packages\": [\n {\n \"number_of_identical_packages\": 2,\n \"items\": [\n {\n \"supplier_purchase_order_shipment_item_id\": 123,\n \"quantity_per_package\": 1\n }\n ],\n \"length\": 1,\n \"width\": 1,\n \"height\": 1,\n \"dimension_unit\": \"in\",\n \"weight\": 1,\n \"weight_unit\": \"lb\",\n \"package_type\": \"carton\",\n \"carton_template_id\": 123,\n \"sscc\": \"<string>\",\n \"tracking_number\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://{companyName}.api.joinluminous.com/external/api/v1/purchase-order-shipments/{id}/packages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"packages\": [\n {\n \"number_of_identical_packages\": 2,\n \"items\": [\n {\n \"supplier_purchase_order_shipment_item_id\": 123,\n \"quantity_per_package\": 1\n }\n ],\n \"length\": 1,\n \"width\": 1,\n \"height\": 1,\n \"dimension_unit\": \"in\",\n \"weight\": 1,\n \"weight_unit\": \"lb\",\n \"package_type\": \"carton\",\n \"carton_template_id\": 123,\n \"sscc\": \"<string>\",\n \"tracking_number\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/purchase-order-shipments/{id}/packages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"packages\": [\n {\n \"number_of_identical_packages\": 2,\n \"items\": [\n {\n \"supplier_purchase_order_shipment_item_id\": 123,\n \"quantity_per_package\": 1\n }\n ],\n \"length\": 1,\n \"width\": 1,\n \"height\": 1,\n \"dimension_unit\": \"in\",\n \"weight\": 1,\n \"weight_unit\": \"lb\",\n \"package_type\": \"carton\",\n \"carton_template_id\": 123,\n \"sscc\": \"<string>\",\n \"tracking_number\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"is_saved": true,
"packages": [
{
"id": 123,
"number_of_identical_packages": 123,
"length": 123,
"width": 123,
"height": 123,
"dimension_unit": "in",
"weight": 123,
"weight_unit": "lb",
"package_type": "carton",
"carton_template_id": 123,
"sscc": "<string>",
"tracking_number": "<string>",
"source": "auto",
"items": [
{
"supplier_purchase_order_shipment_item_id": 123,
"quantity_per_package": 123
}
]
}
],
"coverage": [
{
"supplier_purchase_order_shipment_item_id": 123,
"sku": "<string>",
"quantity": 123,
"packed": 123,
"matches": true
}
],
"box_labels_available": true
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Purchase Order Shipments
Replace purchase order shipment cartons
Replace every carton on the shipment with the given list. Send an empty packages array to remove the saved
cartons, so the shipment goes back to the suggested structure. Saved cartons are sent to the warehouse when the
shipment is pushed as an inbound shipment (for mappings that use cartons).
Returns the shipment’s cartons after the save, in the same shape as the GET.
PUT
/
purchase-order-shipments
/
{id}
/
packages
Replace purchase order shipment cartons
curl --request PUT \
--url https://{companyName}.api.joinluminous.com/external/api/v1/purchase-order-shipments/{id}/packages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"packages": [
{
"number_of_identical_packages": 2,
"items": [
{
"supplier_purchase_order_shipment_item_id": 123,
"quantity_per_package": 1
}
],
"length": 1,
"width": 1,
"height": 1,
"dimension_unit": "in",
"weight": 1,
"weight_unit": "lb",
"package_type": "carton",
"carton_template_id": 123,
"sscc": "<string>",
"tracking_number": "<string>"
}
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/purchase-order-shipments/{id}/packages"
payload = { "packages": [
{
"number_of_identical_packages": 2,
"items": [
{
"supplier_purchase_order_shipment_item_id": 123,
"quantity_per_package": 1
}
],
"length": 1,
"width": 1,
"height": 1,
"dimension_unit": "in",
"weight": 1,
"weight_unit": "lb",
"package_type": "carton",
"carton_template_id": 123,
"sscc": "<string>",
"tracking_number": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
packages: [
{
number_of_identical_packages: 2,
items: [{supplier_purchase_order_shipment_item_id: 123, quantity_per_package: 1}],
length: 1,
width: 1,
height: 1,
dimension_unit: 'in',
weight: 1,
weight_unit: 'lb',
package_type: 'carton',
carton_template_id: 123,
sscc: '<string>',
tracking_number: '<string>'
}
]
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/purchase-order-shipments/{id}/packages', 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/purchase-order-shipments/{id}/packages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'packages' => [
[
'number_of_identical_packages' => 2,
'items' => [
[
'supplier_purchase_order_shipment_item_id' => 123,
'quantity_per_package' => 1
]
],
'length' => 1,
'width' => 1,
'height' => 1,
'dimension_unit' => 'in',
'weight' => 1,
'weight_unit' => 'lb',
'package_type' => 'carton',
'carton_template_id' => 123,
'sscc' => '<string>',
'tracking_number' => '<string>'
]
]
]),
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/purchase-order-shipments/{id}/packages"
payload := strings.NewReader("{\n \"packages\": [\n {\n \"number_of_identical_packages\": 2,\n \"items\": [\n {\n \"supplier_purchase_order_shipment_item_id\": 123,\n \"quantity_per_package\": 1\n }\n ],\n \"length\": 1,\n \"width\": 1,\n \"height\": 1,\n \"dimension_unit\": \"in\",\n \"weight\": 1,\n \"weight_unit\": \"lb\",\n \"package_type\": \"carton\",\n \"carton_template_id\": 123,\n \"sscc\": \"<string>\",\n \"tracking_number\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://{companyName}.api.joinluminous.com/external/api/v1/purchase-order-shipments/{id}/packages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"packages\": [\n {\n \"number_of_identical_packages\": 2,\n \"items\": [\n {\n \"supplier_purchase_order_shipment_item_id\": 123,\n \"quantity_per_package\": 1\n }\n ],\n \"length\": 1,\n \"width\": 1,\n \"height\": 1,\n \"dimension_unit\": \"in\",\n \"weight\": 1,\n \"weight_unit\": \"lb\",\n \"package_type\": \"carton\",\n \"carton_template_id\": 123,\n \"sscc\": \"<string>\",\n \"tracking_number\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/purchase-order-shipments/{id}/packages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"packages\": [\n {\n \"number_of_identical_packages\": 2,\n \"items\": [\n {\n \"supplier_purchase_order_shipment_item_id\": 123,\n \"quantity_per_package\": 1\n }\n ],\n \"length\": 1,\n \"width\": 1,\n \"height\": 1,\n \"dimension_unit\": \"in\",\n \"weight\": 1,\n \"weight_unit\": \"lb\",\n \"package_type\": \"carton\",\n \"carton_template_id\": 123,\n \"sscc\": \"<string>\",\n \"tracking_number\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"is_saved": true,
"packages": [
{
"id": 123,
"number_of_identical_packages": 123,
"length": 123,
"width": 123,
"height": 123,
"dimension_unit": "in",
"weight": 123,
"weight_unit": "lb",
"package_type": "carton",
"carton_template_id": 123,
"sscc": "<string>",
"tracking_number": "<string>",
"source": "auto",
"items": [
{
"supplier_purchase_order_shipment_item_id": 123,
"quantity_per_package": 123
}
]
}
],
"coverage": [
{
"supplier_purchase_order_shipment_item_id": 123,
"sku": "<string>",
"quantity": 123,
"packed": 123,
"matches": true
}
],
"box_labels_available": true
}
}{
"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
Purchase order shipment ID
Body
application/json
The full carton list. May be empty.
Show child attributes
Show child attributes
Response
Cartons replaced
Carton structure of a purchase order shipment. Each entry in packages is one carton configuration:
number_of_identical_packages identical cartons, each holding the listed line quantities.
Show child attributes
Show child attributes