Create a shipment line item
curl --request POST \
--url https://api.upwell.com/api/rest/shipment_line_items \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"commodityDescription": "<string>",
"deliveryLocationName": "<string>",
"dimensionUnit": "<string>",
"freightClass": "<string>",
"handlingUnit": "<string>",
"handlingUnitQty": "<unknown>",
"hazmatFlag": true,
"height": "<unknown>",
"length": "<unknown>",
"lineNumber": 123,
"nmfcClass": "<string>",
"nmfcNumber": "<string>",
"packageQty": "<unknown>",
"packageUnit": "<string>",
"pickupLocationName": "<string>",
"referenceNumber": "<string>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>",
"width": "<unknown>"
}
}
'import requests
url = "https://api.upwell.com/api/rest/shipment_line_items"
payload = { "input": {
"commodityDescription": "<string>",
"deliveryLocationName": "<string>",
"dimensionUnit": "<string>",
"freightClass": "<string>",
"handlingUnit": "<string>",
"handlingUnitQty": "<unknown>",
"hazmatFlag": True,
"height": "<unknown>",
"length": "<unknown>",
"lineNumber": 123,
"nmfcClass": "<string>",
"nmfcNumber": "<string>",
"packageQty": "<unknown>",
"packageUnit": "<string>",
"pickupLocationName": "<string>",
"referenceNumber": "<string>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>",
"width": "<unknown>"
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
input: {
commodityDescription: '<string>',
deliveryLocationName: '<string>',
dimensionUnit: '<string>',
freightClass: '<string>',
handlingUnit: '<string>',
handlingUnitQty: '<unknown>',
hazmatFlag: true,
height: '<unknown>',
length: '<unknown>',
lineNumber: 123,
nmfcClass: '<string>',
nmfcNumber: '<string>',
packageQty: '<unknown>',
packageUnit: '<string>',
pickupLocationName: '<string>',
referenceNumber: '<string>',
shipmentId: '<string>',
sourceSystem: '<string>',
sourceSystemId: '<string>',
weight: '<unknown>',
weightUnit: '<string>',
width: '<unknown>'
}
})
};
fetch('https://api.upwell.com/api/rest/shipment_line_items', 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.upwell.com/api/rest/shipment_line_items",
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([
'input' => [
'commodityDescription' => '<string>',
'deliveryLocationName' => '<string>',
'dimensionUnit' => '<string>',
'freightClass' => '<string>',
'handlingUnit' => '<string>',
'handlingUnitQty' => '<unknown>',
'hazmatFlag' => true,
'height' => '<unknown>',
'length' => '<unknown>',
'lineNumber' => 123,
'nmfcClass' => '<string>',
'nmfcNumber' => '<string>',
'packageQty' => '<unknown>',
'packageUnit' => '<string>',
'pickupLocationName' => '<string>',
'referenceNumber' => '<string>',
'shipmentId' => '<string>',
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'weight' => '<unknown>',
'weightUnit' => '<string>',
'width' => '<unknown>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.upwell.com/api/rest/shipment_line_items"
payload := strings.NewReader("{\n \"input\": {\n \"commodityDescription\": \"<string>\",\n \"deliveryLocationName\": \"<string>\",\n \"dimensionUnit\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"handlingUnit\": \"<string>\",\n \"handlingUnitQty\": \"<unknown>\",\n \"hazmatFlag\": true,\n \"height\": \"<unknown>\",\n \"length\": \"<unknown>\",\n \"lineNumber\": 123,\n \"nmfcClass\": \"<string>\",\n \"nmfcNumber\": \"<string>\",\n \"packageQty\": \"<unknown>\",\n \"packageUnit\": \"<string>\",\n \"pickupLocationName\": \"<string>\",\n \"referenceNumber\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\",\n \"width\": \"<unknown>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://api.upwell.com/api/rest/shipment_line_items")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"input\": {\n \"commodityDescription\": \"<string>\",\n \"deliveryLocationName\": \"<string>\",\n \"dimensionUnit\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"handlingUnit\": \"<string>\",\n \"handlingUnitQty\": \"<unknown>\",\n \"hazmatFlag\": true,\n \"height\": \"<unknown>\",\n \"length\": \"<unknown>\",\n \"lineNumber\": 123,\n \"nmfcClass\": \"<string>\",\n \"nmfcNumber\": \"<string>\",\n \"packageQty\": \"<unknown>\",\n \"packageUnit\": \"<string>\",\n \"pickupLocationName\": \"<string>\",\n \"referenceNumber\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\",\n \"width\": \"<unknown>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/shipment_line_items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"input\": {\n \"commodityDescription\": \"<string>\",\n \"deliveryLocationName\": \"<string>\",\n \"dimensionUnit\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"handlingUnit\": \"<string>\",\n \"handlingUnitQty\": \"<unknown>\",\n \"hazmatFlag\": true,\n \"height\": \"<unknown>\",\n \"length\": \"<unknown>\",\n \"lineNumber\": 123,\n \"nmfcClass\": \"<string>\",\n \"nmfcNumber\": \"<string>\",\n \"packageQty\": \"<unknown>\",\n \"packageUnit\": \"<string>\",\n \"pickupLocationName\": \"<string>\",\n \"referenceNumber\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\",\n \"width\": \"<unknown>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"createShipmentLineItem": {
"commodityDescription": "<string>",
"createdAt": "<unknown>",
"deliveryLocationName": "<string>",
"dimensionUnit": "<string>",
"freightClass": "<string>",
"handlingUnit": "<string>",
"handlingUnitQty": "<unknown>",
"hazmatFlag": true,
"height": "<unknown>",
"id": "<string>",
"length": "<unknown>",
"lineNumber": 123,
"nmfcClass": "<string>",
"nmfcNumber": "<string>",
"packageQty": "<unknown>",
"packageUnit": "<string>",
"pickupLocationName": "<string>",
"referenceNumber": "<string>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"updatedAt": "<unknown>",
"weight": "<unknown>",
"weightUnit": "<string>",
"width": "<unknown>"
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}API Reference
Create a shipment line item
Add a commodity line to a shipment. Each line carries the freight detail for one commodity: description, packaging and handling units, weight, dimensions, NMFC number and class, and the hazmat flag. shipmentId is required and must reference a shipment in your organization.
POST
/
api
/
rest
/
shipment_line_items
Create a shipment line item
curl --request POST \
--url https://api.upwell.com/api/rest/shipment_line_items \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"commodityDescription": "<string>",
"deliveryLocationName": "<string>",
"dimensionUnit": "<string>",
"freightClass": "<string>",
"handlingUnit": "<string>",
"handlingUnitQty": "<unknown>",
"hazmatFlag": true,
"height": "<unknown>",
"length": "<unknown>",
"lineNumber": 123,
"nmfcClass": "<string>",
"nmfcNumber": "<string>",
"packageQty": "<unknown>",
"packageUnit": "<string>",
"pickupLocationName": "<string>",
"referenceNumber": "<string>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>",
"width": "<unknown>"
}
}
'import requests
url = "https://api.upwell.com/api/rest/shipment_line_items"
payload = { "input": {
"commodityDescription": "<string>",
"deliveryLocationName": "<string>",
"dimensionUnit": "<string>",
"freightClass": "<string>",
"handlingUnit": "<string>",
"handlingUnitQty": "<unknown>",
"hazmatFlag": True,
"height": "<unknown>",
"length": "<unknown>",
"lineNumber": 123,
"nmfcClass": "<string>",
"nmfcNumber": "<string>",
"packageQty": "<unknown>",
"packageUnit": "<string>",
"pickupLocationName": "<string>",
"referenceNumber": "<string>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>",
"width": "<unknown>"
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
input: {
commodityDescription: '<string>',
deliveryLocationName: '<string>',
dimensionUnit: '<string>',
freightClass: '<string>',
handlingUnit: '<string>',
handlingUnitQty: '<unknown>',
hazmatFlag: true,
height: '<unknown>',
length: '<unknown>',
lineNumber: 123,
nmfcClass: '<string>',
nmfcNumber: '<string>',
packageQty: '<unknown>',
packageUnit: '<string>',
pickupLocationName: '<string>',
referenceNumber: '<string>',
shipmentId: '<string>',
sourceSystem: '<string>',
sourceSystemId: '<string>',
weight: '<unknown>',
weightUnit: '<string>',
width: '<unknown>'
}
})
};
fetch('https://api.upwell.com/api/rest/shipment_line_items', 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.upwell.com/api/rest/shipment_line_items",
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([
'input' => [
'commodityDescription' => '<string>',
'deliveryLocationName' => '<string>',
'dimensionUnit' => '<string>',
'freightClass' => '<string>',
'handlingUnit' => '<string>',
'handlingUnitQty' => '<unknown>',
'hazmatFlag' => true,
'height' => '<unknown>',
'length' => '<unknown>',
'lineNumber' => 123,
'nmfcClass' => '<string>',
'nmfcNumber' => '<string>',
'packageQty' => '<unknown>',
'packageUnit' => '<string>',
'pickupLocationName' => '<string>',
'referenceNumber' => '<string>',
'shipmentId' => '<string>',
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'weight' => '<unknown>',
'weightUnit' => '<string>',
'width' => '<unknown>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.upwell.com/api/rest/shipment_line_items"
payload := strings.NewReader("{\n \"input\": {\n \"commodityDescription\": \"<string>\",\n \"deliveryLocationName\": \"<string>\",\n \"dimensionUnit\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"handlingUnit\": \"<string>\",\n \"handlingUnitQty\": \"<unknown>\",\n \"hazmatFlag\": true,\n \"height\": \"<unknown>\",\n \"length\": \"<unknown>\",\n \"lineNumber\": 123,\n \"nmfcClass\": \"<string>\",\n \"nmfcNumber\": \"<string>\",\n \"packageQty\": \"<unknown>\",\n \"packageUnit\": \"<string>\",\n \"pickupLocationName\": \"<string>\",\n \"referenceNumber\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\",\n \"width\": \"<unknown>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://api.upwell.com/api/rest/shipment_line_items")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"input\": {\n \"commodityDescription\": \"<string>\",\n \"deliveryLocationName\": \"<string>\",\n \"dimensionUnit\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"handlingUnit\": \"<string>\",\n \"handlingUnitQty\": \"<unknown>\",\n \"hazmatFlag\": true,\n \"height\": \"<unknown>\",\n \"length\": \"<unknown>\",\n \"lineNumber\": 123,\n \"nmfcClass\": \"<string>\",\n \"nmfcNumber\": \"<string>\",\n \"packageQty\": \"<unknown>\",\n \"packageUnit\": \"<string>\",\n \"pickupLocationName\": \"<string>\",\n \"referenceNumber\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\",\n \"width\": \"<unknown>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/shipment_line_items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"input\": {\n \"commodityDescription\": \"<string>\",\n \"deliveryLocationName\": \"<string>\",\n \"dimensionUnit\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"handlingUnit\": \"<string>\",\n \"handlingUnitQty\": \"<unknown>\",\n \"hazmatFlag\": true,\n \"height\": \"<unknown>\",\n \"length\": \"<unknown>\",\n \"lineNumber\": 123,\n \"nmfcClass\": \"<string>\",\n \"nmfcNumber\": \"<string>\",\n \"packageQty\": \"<unknown>\",\n \"packageUnit\": \"<string>\",\n \"pickupLocationName\": \"<string>\",\n \"referenceNumber\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\",\n \"width\": \"<unknown>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"createShipmentLineItem": {
"commodityDescription": "<string>",
"createdAt": "<unknown>",
"deliveryLocationName": "<string>",
"dimensionUnit": "<string>",
"freightClass": "<string>",
"handlingUnit": "<string>",
"handlingUnitQty": "<unknown>",
"hazmatFlag": true,
"height": "<unknown>",
"id": "<string>",
"length": "<unknown>",
"lineNumber": 123,
"nmfcClass": "<string>",
"nmfcNumber": "<string>",
"packageQty": "<unknown>",
"packageUnit": "<string>",
"pickupLocationName": "<string>",
"referenceNumber": "<string>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"updatedAt": "<unknown>",
"weight": "<unknown>",
"weightUnit": "<string>",
"width": "<unknown>"
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}Authorizations
Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.
Body
application/json
Query parameters can also be provided in the request body as a JSON object
input type for inserting data into table "shipment_line_items"
Show child attributes
Show child attributes
Response
Responses for POST /api/rest/shipment_line_items
Shipment Line Items
Show child attributes
Show child attributes
⌘I