Create One Shipment
curl --request POST \
--url https://api.upwell.com/api/rest/shipments \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"billOfLadingNumber": "<string>",
"billedDate": "2023-12-25",
"billedMiles": "<unknown>",
"carrierDocumentRequests": {},
"carrierId": "<string>",
"carrierInvoices": {},
"carrierProNumber": "<string>",
"carrierTotalRate": 123,
"company": {},
"companyId": "<string>",
"consigneeAddress": {},
"consigneeAddressId": "<string>",
"coveredDate": "2023-12-25",
"createdFromEmailMessageId": "<string>",
"currencyCode": {},
"customerId": "<string>",
"customerMiles": "<unknown>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"customerTotalRate": 123,
"declaredValue": 123,
"deliveredAt": "<unknown>",
"dispatchedDate": "2023-12-25",
"dispatcherEmail": "<string>",
"dispatcherName": "<string>",
"dispatcherPhone": "<string>",
"equipment": "<string>",
"fileAssociations": {},
"freightChargeTermInfo": {},
"freightClass": "<string>",
"holdReason": "<string>",
"invoiceId": "<string>",
"lengthInFeet": 123,
"loadDescription": "<string>",
"loadedDate": "2023-12-25",
"mode": "<string>",
"movementType": "<string>",
"notes": {},
"onHold": true,
"pickupAddress": {},
"pickupAt": "<unknown>",
"readyDate": "2023-12-25",
"referenceNumbers": "<unknown>",
"releaseDate": "2023-12-25",
"serviceLevel": "<string>",
"shipmentId": "<string>",
"shipmentLineItems": {},
"signedBy": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"specialInstructions": "<string>",
"status": "<string>",
"stops": {},
"terminal": "<string>",
"trailerNumber": "<string>",
"truckMiles": "<unknown>",
"volume": "<unknown>",
"volumeUnit": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
}
}
'import requests
url = "https://api.upwell.com/api/rest/shipments"
payload = { "input": {
"billOfLadingNumber": "<string>",
"billedDate": "2023-12-25",
"billedMiles": "<unknown>",
"carrierDocumentRequests": {},
"carrierId": "<string>",
"carrierInvoices": {},
"carrierProNumber": "<string>",
"carrierTotalRate": 123,
"company": {},
"companyId": "<string>",
"consigneeAddress": {},
"consigneeAddressId": "<string>",
"coveredDate": "2023-12-25",
"createdFromEmailMessageId": "<string>",
"currencyCode": {},
"customerId": "<string>",
"customerMiles": "<unknown>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"customerTotalRate": 123,
"declaredValue": 123,
"deliveredAt": "<unknown>",
"dispatchedDate": "2023-12-25",
"dispatcherEmail": "<string>",
"dispatcherName": "<string>",
"dispatcherPhone": "<string>",
"equipment": "<string>",
"fileAssociations": {},
"freightChargeTermInfo": {},
"freightClass": "<string>",
"holdReason": "<string>",
"invoiceId": "<string>",
"lengthInFeet": 123,
"loadDescription": "<string>",
"loadedDate": "2023-12-25",
"mode": "<string>",
"movementType": "<string>",
"notes": {},
"onHold": True,
"pickupAddress": {},
"pickupAt": "<unknown>",
"readyDate": "2023-12-25",
"referenceNumbers": "<unknown>",
"releaseDate": "2023-12-25",
"serviceLevel": "<string>",
"shipmentId": "<string>",
"shipmentLineItems": {},
"signedBy": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"specialInstructions": "<string>",
"status": "<string>",
"stops": {},
"terminal": "<string>",
"trailerNumber": "<string>",
"truckMiles": "<unknown>",
"volume": "<unknown>",
"volumeUnit": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
input: {
billOfLadingNumber: '<string>',
billedDate: '2023-12-25',
billedMiles: '<unknown>',
carrierDocumentRequests: {},
carrierId: '<string>',
carrierInvoices: {},
carrierProNumber: '<string>',
carrierTotalRate: 123,
company: {},
companyId: '<string>',
consigneeAddress: {},
consigneeAddressId: '<string>',
coveredDate: '2023-12-25',
createdFromEmailMessageId: '<string>',
currencyCode: {},
customerId: '<string>',
customerMiles: '<unknown>',
customerPoNumber: '<string>',
customerReferenceNumber: '<string>',
customerTotalRate: 123,
declaredValue: 123,
deliveredAt: '<unknown>',
dispatchedDate: '2023-12-25',
dispatcherEmail: '<string>',
dispatcherName: '<string>',
dispatcherPhone: '<string>',
equipment: '<string>',
fileAssociations: {},
freightChargeTermInfo: {},
freightClass: '<string>',
holdReason: '<string>',
invoiceId: '<string>',
lengthInFeet: 123,
loadDescription: '<string>',
loadedDate: '2023-12-25',
mode: '<string>',
movementType: '<string>',
notes: {},
onHold: true,
pickupAddress: {},
pickupAt: '<unknown>',
readyDate: '2023-12-25',
referenceNumbers: '<unknown>',
releaseDate: '2023-12-25',
serviceLevel: '<string>',
shipmentId: '<string>',
shipmentLineItems: {},
signedBy: '<string>',
sourceSystem: '<string>',
sourceSystemId: '<string>',
sourceSystemMeta: '<unknown>',
specialInstructions: '<string>',
status: '<string>',
stops: {},
terminal: '<string>',
trailerNumber: '<string>',
truckMiles: '<unknown>',
volume: '<unknown>',
volumeUnit: '<string>',
weight: '<unknown>',
weightUnit: '<string>'
}
})
};
fetch('https://api.upwell.com/api/rest/shipments', 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/shipments",
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' => [
'billOfLadingNumber' => '<string>',
'billedDate' => '2023-12-25',
'billedMiles' => '<unknown>',
'carrierDocumentRequests' => [
],
'carrierId' => '<string>',
'carrierInvoices' => [
],
'carrierProNumber' => '<string>',
'carrierTotalRate' => 123,
'company' => [
],
'companyId' => '<string>',
'consigneeAddress' => [
],
'consigneeAddressId' => '<string>',
'coveredDate' => '2023-12-25',
'createdFromEmailMessageId' => '<string>',
'currencyCode' => [
],
'customerId' => '<string>',
'customerMiles' => '<unknown>',
'customerPoNumber' => '<string>',
'customerReferenceNumber' => '<string>',
'customerTotalRate' => 123,
'declaredValue' => 123,
'deliveredAt' => '<unknown>',
'dispatchedDate' => '2023-12-25',
'dispatcherEmail' => '<string>',
'dispatcherName' => '<string>',
'dispatcherPhone' => '<string>',
'equipment' => '<string>',
'fileAssociations' => [
],
'freightChargeTermInfo' => [
],
'freightClass' => '<string>',
'holdReason' => '<string>',
'invoiceId' => '<string>',
'lengthInFeet' => 123,
'loadDescription' => '<string>',
'loadedDate' => '2023-12-25',
'mode' => '<string>',
'movementType' => '<string>',
'notes' => [
],
'onHold' => true,
'pickupAddress' => [
],
'pickupAt' => '<unknown>',
'readyDate' => '2023-12-25',
'referenceNumbers' => '<unknown>',
'releaseDate' => '2023-12-25',
'serviceLevel' => '<string>',
'shipmentId' => '<string>',
'shipmentLineItems' => [
],
'signedBy' => '<string>',
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'sourceSystemMeta' => '<unknown>',
'specialInstructions' => '<string>',
'status' => '<string>',
'stops' => [
],
'terminal' => '<string>',
'trailerNumber' => '<string>',
'truckMiles' => '<unknown>',
'volume' => '<unknown>',
'volumeUnit' => '<string>',
'weight' => '<unknown>',
'weightUnit' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"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/shipments"
payload := strings.NewReader("{\n \"input\": {\n \"billOfLadingNumber\": \"<string>\",\n \"billedDate\": \"2023-12-25\",\n \"billedMiles\": \"<unknown>\",\n \"carrierDocumentRequests\": {},\n \"carrierId\": \"<string>\",\n \"carrierInvoices\": {},\n \"carrierProNumber\": \"<string>\",\n \"carrierTotalRate\": 123,\n \"company\": {},\n \"companyId\": \"<string>\",\n \"consigneeAddress\": {},\n \"consigneeAddressId\": \"<string>\",\n \"coveredDate\": \"2023-12-25\",\n \"createdFromEmailMessageId\": \"<string>\",\n \"currencyCode\": {},\n \"customerId\": \"<string>\",\n \"customerMiles\": \"<unknown>\",\n \"customerPoNumber\": \"<string>\",\n \"customerReferenceNumber\": \"<string>\",\n \"customerTotalRate\": 123,\n \"declaredValue\": 123,\n \"deliveredAt\": \"<unknown>\",\n \"dispatchedDate\": \"2023-12-25\",\n \"dispatcherEmail\": \"<string>\",\n \"dispatcherName\": \"<string>\",\n \"dispatcherPhone\": \"<string>\",\n \"equipment\": \"<string>\",\n \"fileAssociations\": {},\n \"freightChargeTermInfo\": {},\n \"freightClass\": \"<string>\",\n \"holdReason\": \"<string>\",\n \"invoiceId\": \"<string>\",\n \"lengthInFeet\": 123,\n \"loadDescription\": \"<string>\",\n \"loadedDate\": \"2023-12-25\",\n \"mode\": \"<string>\",\n \"movementType\": \"<string>\",\n \"notes\": {},\n \"onHold\": true,\n \"pickupAddress\": {},\n \"pickupAt\": \"<unknown>\",\n \"readyDate\": \"2023-12-25\",\n \"referenceNumbers\": \"<unknown>\",\n \"releaseDate\": \"2023-12-25\",\n \"serviceLevel\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"shipmentLineItems\": {},\n \"signedBy\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"specialInstructions\": \"<string>\",\n \"status\": \"<string>\",\n \"stops\": {},\n \"terminal\": \"<string>\",\n \"trailerNumber\": \"<string>\",\n \"truckMiles\": \"<unknown>\",\n \"volume\": \"<unknown>\",\n \"volumeUnit\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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/shipments")
.header("Content-Type", "application/json")
.body("{\n \"input\": {\n \"billOfLadingNumber\": \"<string>\",\n \"billedDate\": \"2023-12-25\",\n \"billedMiles\": \"<unknown>\",\n \"carrierDocumentRequests\": {},\n \"carrierId\": \"<string>\",\n \"carrierInvoices\": {},\n \"carrierProNumber\": \"<string>\",\n \"carrierTotalRate\": 123,\n \"company\": {},\n \"companyId\": \"<string>\",\n \"consigneeAddress\": {},\n \"consigneeAddressId\": \"<string>\",\n \"coveredDate\": \"2023-12-25\",\n \"createdFromEmailMessageId\": \"<string>\",\n \"currencyCode\": {},\n \"customerId\": \"<string>\",\n \"customerMiles\": \"<unknown>\",\n \"customerPoNumber\": \"<string>\",\n \"customerReferenceNumber\": \"<string>\",\n \"customerTotalRate\": 123,\n \"declaredValue\": 123,\n \"deliveredAt\": \"<unknown>\",\n \"dispatchedDate\": \"2023-12-25\",\n \"dispatcherEmail\": \"<string>\",\n \"dispatcherName\": \"<string>\",\n \"dispatcherPhone\": \"<string>\",\n \"equipment\": \"<string>\",\n \"fileAssociations\": {},\n \"freightChargeTermInfo\": {},\n \"freightClass\": \"<string>\",\n \"holdReason\": \"<string>\",\n \"invoiceId\": \"<string>\",\n \"lengthInFeet\": 123,\n \"loadDescription\": \"<string>\",\n \"loadedDate\": \"2023-12-25\",\n \"mode\": \"<string>\",\n \"movementType\": \"<string>\",\n \"notes\": {},\n \"onHold\": true,\n \"pickupAddress\": {},\n \"pickupAt\": \"<unknown>\",\n \"readyDate\": \"2023-12-25\",\n \"referenceNumbers\": \"<unknown>\",\n \"releaseDate\": \"2023-12-25\",\n \"serviceLevel\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"shipmentLineItems\": {},\n \"signedBy\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"specialInstructions\": \"<string>\",\n \"status\": \"<string>\",\n \"stops\": {},\n \"terminal\": \"<string>\",\n \"trailerNumber\": \"<string>\",\n \"truckMiles\": \"<unknown>\",\n \"volume\": \"<unknown>\",\n \"volumeUnit\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"input\": {\n \"billOfLadingNumber\": \"<string>\",\n \"billedDate\": \"2023-12-25\",\n \"billedMiles\": \"<unknown>\",\n \"carrierDocumentRequests\": {},\n \"carrierId\": \"<string>\",\n \"carrierInvoices\": {},\n \"carrierProNumber\": \"<string>\",\n \"carrierTotalRate\": 123,\n \"company\": {},\n \"companyId\": \"<string>\",\n \"consigneeAddress\": {},\n \"consigneeAddressId\": \"<string>\",\n \"coveredDate\": \"2023-12-25\",\n \"createdFromEmailMessageId\": \"<string>\",\n \"currencyCode\": {},\n \"customerId\": \"<string>\",\n \"customerMiles\": \"<unknown>\",\n \"customerPoNumber\": \"<string>\",\n \"customerReferenceNumber\": \"<string>\",\n \"customerTotalRate\": 123,\n \"declaredValue\": 123,\n \"deliveredAt\": \"<unknown>\",\n \"dispatchedDate\": \"2023-12-25\",\n \"dispatcherEmail\": \"<string>\",\n \"dispatcherName\": \"<string>\",\n \"dispatcherPhone\": \"<string>\",\n \"equipment\": \"<string>\",\n \"fileAssociations\": {},\n \"freightChargeTermInfo\": {},\n \"freightClass\": \"<string>\",\n \"holdReason\": \"<string>\",\n \"invoiceId\": \"<string>\",\n \"lengthInFeet\": 123,\n \"loadDescription\": \"<string>\",\n \"loadedDate\": \"2023-12-25\",\n \"mode\": \"<string>\",\n \"movementType\": \"<string>\",\n \"notes\": {},\n \"onHold\": true,\n \"pickupAddress\": {},\n \"pickupAt\": \"<unknown>\",\n \"readyDate\": \"2023-12-25\",\n \"referenceNumbers\": \"<unknown>\",\n \"releaseDate\": \"2023-12-25\",\n \"serviceLevel\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"shipmentLineItems\": {},\n \"signedBy\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"specialInstructions\": \"<string>\",\n \"status\": \"<string>\",\n \"stops\": {},\n \"terminal\": \"<string>\",\n \"trailerNumber\": \"<string>\",\n \"truckMiles\": \"<unknown>\",\n \"volume\": \"<unknown>\",\n \"volumeUnit\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"createShipment": {
"billOfLadingNumber": "<string>",
"billedDate": "2023-12-25",
"carrierId": "<string>",
"carrierProNumber": "<string>",
"carrierTotalRate": 123,
"company": {
"dunsNumber": "<string>",
"id": "<string>",
"logoUrl": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"primaryEmailAddress": "<string>",
"primaryPhone": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"termsOfService": "<string>",
"website": "<string>"
},
"companyId": "<string>",
"consigneeAddress": {
"city": "<string>",
"companyName": "<string>",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"zipOrPostalCode": "<string>"
},
"coveredDate": "2023-12-25",
"createdAt": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"customerTotalRate": 123,
"deliveredAt": "<unknown>",
"dispatchedDate": "2023-12-25",
"dispatcherEmail": "<string>",
"dispatcherName": "<string>",
"dispatcherPhone": "<string>",
"equipment": "<string>",
"id": "<string>",
"invoiceId": "<string>",
"loadDescription": "<string>",
"loadedDate": "2023-12-25",
"pickupAddress": {
"city": "<string>",
"companyName": "<string>",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"zipOrPostalCode": "<string>"
},
"pickupAt": "<unknown>",
"releaseDate": "2023-12-25",
"serviceLevel": "<string>",
"shipmentId": "<string>",
"shipmentInvoices": [
{
"invoice": {
"id": "<string>",
"number": "<string>"
},
"invoiceId": "<string>",
"shipmentId": "<string>"
}
],
"shipmentLineItems": [
{
"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>"
}
],
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"status": "<string>",
"stops": [
{
"address": {
"city": "<string>",
"companyName": "<string>",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"zipOrPostalCode": "<string>"
},
"id": "<string>",
"metadata": "<string>",
"pieceCount": 123,
"sequenceNumber": 123,
"stopType": "<string>",
"weightAmount": "<unknown>",
"weightUnit": "<string>"
}
],
"terminal": "<string>",
"trailerNumber": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"volume": "<unknown>",
"volumeUnit": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
}
}Shipments
Create One Shipment
Create a new shipment.
Integration notes:
POSTerrors with400 Uniqueness violationon duplicate(sourceSystem, sourceSystemId). UsePUTfor updates.shipmentIdisNOT NULLwith no server-side default — you must provide a unique string.customerTotalRateandcarrierTotalRateare integer cents, not float dollars.
See Integration patterns.
POST
/
api
/
rest
/
shipments
Create One Shipment
curl --request POST \
--url https://api.upwell.com/api/rest/shipments \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"billOfLadingNumber": "<string>",
"billedDate": "2023-12-25",
"billedMiles": "<unknown>",
"carrierDocumentRequests": {},
"carrierId": "<string>",
"carrierInvoices": {},
"carrierProNumber": "<string>",
"carrierTotalRate": 123,
"company": {},
"companyId": "<string>",
"consigneeAddress": {},
"consigneeAddressId": "<string>",
"coveredDate": "2023-12-25",
"createdFromEmailMessageId": "<string>",
"currencyCode": {},
"customerId": "<string>",
"customerMiles": "<unknown>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"customerTotalRate": 123,
"declaredValue": 123,
"deliveredAt": "<unknown>",
"dispatchedDate": "2023-12-25",
"dispatcherEmail": "<string>",
"dispatcherName": "<string>",
"dispatcherPhone": "<string>",
"equipment": "<string>",
"fileAssociations": {},
"freightChargeTermInfo": {},
"freightClass": "<string>",
"holdReason": "<string>",
"invoiceId": "<string>",
"lengthInFeet": 123,
"loadDescription": "<string>",
"loadedDate": "2023-12-25",
"mode": "<string>",
"movementType": "<string>",
"notes": {},
"onHold": true,
"pickupAddress": {},
"pickupAt": "<unknown>",
"readyDate": "2023-12-25",
"referenceNumbers": "<unknown>",
"releaseDate": "2023-12-25",
"serviceLevel": "<string>",
"shipmentId": "<string>",
"shipmentLineItems": {},
"signedBy": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"specialInstructions": "<string>",
"status": "<string>",
"stops": {},
"terminal": "<string>",
"trailerNumber": "<string>",
"truckMiles": "<unknown>",
"volume": "<unknown>",
"volumeUnit": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
}
}
'import requests
url = "https://api.upwell.com/api/rest/shipments"
payload = { "input": {
"billOfLadingNumber": "<string>",
"billedDate": "2023-12-25",
"billedMiles": "<unknown>",
"carrierDocumentRequests": {},
"carrierId": "<string>",
"carrierInvoices": {},
"carrierProNumber": "<string>",
"carrierTotalRate": 123,
"company": {},
"companyId": "<string>",
"consigneeAddress": {},
"consigneeAddressId": "<string>",
"coveredDate": "2023-12-25",
"createdFromEmailMessageId": "<string>",
"currencyCode": {},
"customerId": "<string>",
"customerMiles": "<unknown>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"customerTotalRate": 123,
"declaredValue": 123,
"deliveredAt": "<unknown>",
"dispatchedDate": "2023-12-25",
"dispatcherEmail": "<string>",
"dispatcherName": "<string>",
"dispatcherPhone": "<string>",
"equipment": "<string>",
"fileAssociations": {},
"freightChargeTermInfo": {},
"freightClass": "<string>",
"holdReason": "<string>",
"invoiceId": "<string>",
"lengthInFeet": 123,
"loadDescription": "<string>",
"loadedDate": "2023-12-25",
"mode": "<string>",
"movementType": "<string>",
"notes": {},
"onHold": True,
"pickupAddress": {},
"pickupAt": "<unknown>",
"readyDate": "2023-12-25",
"referenceNumbers": "<unknown>",
"releaseDate": "2023-12-25",
"serviceLevel": "<string>",
"shipmentId": "<string>",
"shipmentLineItems": {},
"signedBy": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"specialInstructions": "<string>",
"status": "<string>",
"stops": {},
"terminal": "<string>",
"trailerNumber": "<string>",
"truckMiles": "<unknown>",
"volume": "<unknown>",
"volumeUnit": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
input: {
billOfLadingNumber: '<string>',
billedDate: '2023-12-25',
billedMiles: '<unknown>',
carrierDocumentRequests: {},
carrierId: '<string>',
carrierInvoices: {},
carrierProNumber: '<string>',
carrierTotalRate: 123,
company: {},
companyId: '<string>',
consigneeAddress: {},
consigneeAddressId: '<string>',
coveredDate: '2023-12-25',
createdFromEmailMessageId: '<string>',
currencyCode: {},
customerId: '<string>',
customerMiles: '<unknown>',
customerPoNumber: '<string>',
customerReferenceNumber: '<string>',
customerTotalRate: 123,
declaredValue: 123,
deliveredAt: '<unknown>',
dispatchedDate: '2023-12-25',
dispatcherEmail: '<string>',
dispatcherName: '<string>',
dispatcherPhone: '<string>',
equipment: '<string>',
fileAssociations: {},
freightChargeTermInfo: {},
freightClass: '<string>',
holdReason: '<string>',
invoiceId: '<string>',
lengthInFeet: 123,
loadDescription: '<string>',
loadedDate: '2023-12-25',
mode: '<string>',
movementType: '<string>',
notes: {},
onHold: true,
pickupAddress: {},
pickupAt: '<unknown>',
readyDate: '2023-12-25',
referenceNumbers: '<unknown>',
releaseDate: '2023-12-25',
serviceLevel: '<string>',
shipmentId: '<string>',
shipmentLineItems: {},
signedBy: '<string>',
sourceSystem: '<string>',
sourceSystemId: '<string>',
sourceSystemMeta: '<unknown>',
specialInstructions: '<string>',
status: '<string>',
stops: {},
terminal: '<string>',
trailerNumber: '<string>',
truckMiles: '<unknown>',
volume: '<unknown>',
volumeUnit: '<string>',
weight: '<unknown>',
weightUnit: '<string>'
}
})
};
fetch('https://api.upwell.com/api/rest/shipments', 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/shipments",
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' => [
'billOfLadingNumber' => '<string>',
'billedDate' => '2023-12-25',
'billedMiles' => '<unknown>',
'carrierDocumentRequests' => [
],
'carrierId' => '<string>',
'carrierInvoices' => [
],
'carrierProNumber' => '<string>',
'carrierTotalRate' => 123,
'company' => [
],
'companyId' => '<string>',
'consigneeAddress' => [
],
'consigneeAddressId' => '<string>',
'coveredDate' => '2023-12-25',
'createdFromEmailMessageId' => '<string>',
'currencyCode' => [
],
'customerId' => '<string>',
'customerMiles' => '<unknown>',
'customerPoNumber' => '<string>',
'customerReferenceNumber' => '<string>',
'customerTotalRate' => 123,
'declaredValue' => 123,
'deliveredAt' => '<unknown>',
'dispatchedDate' => '2023-12-25',
'dispatcherEmail' => '<string>',
'dispatcherName' => '<string>',
'dispatcherPhone' => '<string>',
'equipment' => '<string>',
'fileAssociations' => [
],
'freightChargeTermInfo' => [
],
'freightClass' => '<string>',
'holdReason' => '<string>',
'invoiceId' => '<string>',
'lengthInFeet' => 123,
'loadDescription' => '<string>',
'loadedDate' => '2023-12-25',
'mode' => '<string>',
'movementType' => '<string>',
'notes' => [
],
'onHold' => true,
'pickupAddress' => [
],
'pickupAt' => '<unknown>',
'readyDate' => '2023-12-25',
'referenceNumbers' => '<unknown>',
'releaseDate' => '2023-12-25',
'serviceLevel' => '<string>',
'shipmentId' => '<string>',
'shipmentLineItems' => [
],
'signedBy' => '<string>',
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'sourceSystemMeta' => '<unknown>',
'specialInstructions' => '<string>',
'status' => '<string>',
'stops' => [
],
'terminal' => '<string>',
'trailerNumber' => '<string>',
'truckMiles' => '<unknown>',
'volume' => '<unknown>',
'volumeUnit' => '<string>',
'weight' => '<unknown>',
'weightUnit' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"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/shipments"
payload := strings.NewReader("{\n \"input\": {\n \"billOfLadingNumber\": \"<string>\",\n \"billedDate\": \"2023-12-25\",\n \"billedMiles\": \"<unknown>\",\n \"carrierDocumentRequests\": {},\n \"carrierId\": \"<string>\",\n \"carrierInvoices\": {},\n \"carrierProNumber\": \"<string>\",\n \"carrierTotalRate\": 123,\n \"company\": {},\n \"companyId\": \"<string>\",\n \"consigneeAddress\": {},\n \"consigneeAddressId\": \"<string>\",\n \"coveredDate\": \"2023-12-25\",\n \"createdFromEmailMessageId\": \"<string>\",\n \"currencyCode\": {},\n \"customerId\": \"<string>\",\n \"customerMiles\": \"<unknown>\",\n \"customerPoNumber\": \"<string>\",\n \"customerReferenceNumber\": \"<string>\",\n \"customerTotalRate\": 123,\n \"declaredValue\": 123,\n \"deliveredAt\": \"<unknown>\",\n \"dispatchedDate\": \"2023-12-25\",\n \"dispatcherEmail\": \"<string>\",\n \"dispatcherName\": \"<string>\",\n \"dispatcherPhone\": \"<string>\",\n \"equipment\": \"<string>\",\n \"fileAssociations\": {},\n \"freightChargeTermInfo\": {},\n \"freightClass\": \"<string>\",\n \"holdReason\": \"<string>\",\n \"invoiceId\": \"<string>\",\n \"lengthInFeet\": 123,\n \"loadDescription\": \"<string>\",\n \"loadedDate\": \"2023-12-25\",\n \"mode\": \"<string>\",\n \"movementType\": \"<string>\",\n \"notes\": {},\n \"onHold\": true,\n \"pickupAddress\": {},\n \"pickupAt\": \"<unknown>\",\n \"readyDate\": \"2023-12-25\",\n \"referenceNumbers\": \"<unknown>\",\n \"releaseDate\": \"2023-12-25\",\n \"serviceLevel\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"shipmentLineItems\": {},\n \"signedBy\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"specialInstructions\": \"<string>\",\n \"status\": \"<string>\",\n \"stops\": {},\n \"terminal\": \"<string>\",\n \"trailerNumber\": \"<string>\",\n \"truckMiles\": \"<unknown>\",\n \"volume\": \"<unknown>\",\n \"volumeUnit\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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/shipments")
.header("Content-Type", "application/json")
.body("{\n \"input\": {\n \"billOfLadingNumber\": \"<string>\",\n \"billedDate\": \"2023-12-25\",\n \"billedMiles\": \"<unknown>\",\n \"carrierDocumentRequests\": {},\n \"carrierId\": \"<string>\",\n \"carrierInvoices\": {},\n \"carrierProNumber\": \"<string>\",\n \"carrierTotalRate\": 123,\n \"company\": {},\n \"companyId\": \"<string>\",\n \"consigneeAddress\": {},\n \"consigneeAddressId\": \"<string>\",\n \"coveredDate\": \"2023-12-25\",\n \"createdFromEmailMessageId\": \"<string>\",\n \"currencyCode\": {},\n \"customerId\": \"<string>\",\n \"customerMiles\": \"<unknown>\",\n \"customerPoNumber\": \"<string>\",\n \"customerReferenceNumber\": \"<string>\",\n \"customerTotalRate\": 123,\n \"declaredValue\": 123,\n \"deliveredAt\": \"<unknown>\",\n \"dispatchedDate\": \"2023-12-25\",\n \"dispatcherEmail\": \"<string>\",\n \"dispatcherName\": \"<string>\",\n \"dispatcherPhone\": \"<string>\",\n \"equipment\": \"<string>\",\n \"fileAssociations\": {},\n \"freightChargeTermInfo\": {},\n \"freightClass\": \"<string>\",\n \"holdReason\": \"<string>\",\n \"invoiceId\": \"<string>\",\n \"lengthInFeet\": 123,\n \"loadDescription\": \"<string>\",\n \"loadedDate\": \"2023-12-25\",\n \"mode\": \"<string>\",\n \"movementType\": \"<string>\",\n \"notes\": {},\n \"onHold\": true,\n \"pickupAddress\": {},\n \"pickupAt\": \"<unknown>\",\n \"readyDate\": \"2023-12-25\",\n \"referenceNumbers\": \"<unknown>\",\n \"releaseDate\": \"2023-12-25\",\n \"serviceLevel\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"shipmentLineItems\": {},\n \"signedBy\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"specialInstructions\": \"<string>\",\n \"status\": \"<string>\",\n \"stops\": {},\n \"terminal\": \"<string>\",\n \"trailerNumber\": \"<string>\",\n \"truckMiles\": \"<unknown>\",\n \"volume\": \"<unknown>\",\n \"volumeUnit\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"input\": {\n \"billOfLadingNumber\": \"<string>\",\n \"billedDate\": \"2023-12-25\",\n \"billedMiles\": \"<unknown>\",\n \"carrierDocumentRequests\": {},\n \"carrierId\": \"<string>\",\n \"carrierInvoices\": {},\n \"carrierProNumber\": \"<string>\",\n \"carrierTotalRate\": 123,\n \"company\": {},\n \"companyId\": \"<string>\",\n \"consigneeAddress\": {},\n \"consigneeAddressId\": \"<string>\",\n \"coveredDate\": \"2023-12-25\",\n \"createdFromEmailMessageId\": \"<string>\",\n \"currencyCode\": {},\n \"customerId\": \"<string>\",\n \"customerMiles\": \"<unknown>\",\n \"customerPoNumber\": \"<string>\",\n \"customerReferenceNumber\": \"<string>\",\n \"customerTotalRate\": 123,\n \"declaredValue\": 123,\n \"deliveredAt\": \"<unknown>\",\n \"dispatchedDate\": \"2023-12-25\",\n \"dispatcherEmail\": \"<string>\",\n \"dispatcherName\": \"<string>\",\n \"dispatcherPhone\": \"<string>\",\n \"equipment\": \"<string>\",\n \"fileAssociations\": {},\n \"freightChargeTermInfo\": {},\n \"freightClass\": \"<string>\",\n \"holdReason\": \"<string>\",\n \"invoiceId\": \"<string>\",\n \"lengthInFeet\": 123,\n \"loadDescription\": \"<string>\",\n \"loadedDate\": \"2023-12-25\",\n \"mode\": \"<string>\",\n \"movementType\": \"<string>\",\n \"notes\": {},\n \"onHold\": true,\n \"pickupAddress\": {},\n \"pickupAt\": \"<unknown>\",\n \"readyDate\": \"2023-12-25\",\n \"referenceNumbers\": \"<unknown>\",\n \"releaseDate\": \"2023-12-25\",\n \"serviceLevel\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"shipmentLineItems\": {},\n \"signedBy\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"specialInstructions\": \"<string>\",\n \"status\": \"<string>\",\n \"stops\": {},\n \"terminal\": \"<string>\",\n \"trailerNumber\": \"<string>\",\n \"truckMiles\": \"<unknown>\",\n \"volume\": \"<unknown>\",\n \"volumeUnit\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"createShipment": {
"billOfLadingNumber": "<string>",
"billedDate": "2023-12-25",
"carrierId": "<string>",
"carrierProNumber": "<string>",
"carrierTotalRate": 123,
"company": {
"dunsNumber": "<string>",
"id": "<string>",
"logoUrl": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"primaryEmailAddress": "<string>",
"primaryPhone": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"termsOfService": "<string>",
"website": "<string>"
},
"companyId": "<string>",
"consigneeAddress": {
"city": "<string>",
"companyName": "<string>",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"zipOrPostalCode": "<string>"
},
"coveredDate": "2023-12-25",
"createdAt": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"customerTotalRate": 123,
"deliveredAt": "<unknown>",
"dispatchedDate": "2023-12-25",
"dispatcherEmail": "<string>",
"dispatcherName": "<string>",
"dispatcherPhone": "<string>",
"equipment": "<string>",
"id": "<string>",
"invoiceId": "<string>",
"loadDescription": "<string>",
"loadedDate": "2023-12-25",
"pickupAddress": {
"city": "<string>",
"companyName": "<string>",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"zipOrPostalCode": "<string>"
},
"pickupAt": "<unknown>",
"releaseDate": "2023-12-25",
"serviceLevel": "<string>",
"shipmentId": "<string>",
"shipmentInvoices": [
{
"invoice": {
"id": "<string>",
"number": "<string>"
},
"invoiceId": "<string>",
"shipmentId": "<string>"
}
],
"shipmentLineItems": [
{
"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>"
}
],
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"status": "<string>",
"stops": [
{
"address": {
"city": "<string>",
"companyName": "<string>",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"zipOrPostalCode": "<string>"
},
"id": "<string>",
"metadata": "<string>",
"pieceCount": 123,
"sequenceNumber": 123,
"stopType": "<string>",
"weightAmount": "<unknown>",
"weightUnit": "<string>"
}
],
"terminal": "<string>",
"trailerNumber": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"volume": "<unknown>",
"volumeUnit": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
}
}Headers
Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY
Body
application/json
Query parameters can also be provided in the request body as a JSON object
input type for inserting data into table "shipments"
Show child attributes
Show child attributes
Response
200 - application/json
Responses for POST /api/rest/shipments
columns and relationships of "shipments"
Show child attributes
Show child attributes
⌘I