Create One Carrier
curl --request POST \
--url https://api.upwell.com/api/rest/carriers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"address": {},
"addressId": "<string>",
"addressesLastUpdatedAt": "2023-11-07T05:31:56Z",
"aljexId": "<string>",
"billingAddressId": "<string>",
"cargoInsuranceExpireDate": "<string>",
"dotNumber": "<string>",
"email": "<string>",
"freezePay": true,
"generalLiabilityInsuranceExpireDate": "<string>",
"isOwnerOperator": true,
"isQuickpay": true,
"liabilityInsuranceExpireDate": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"payToAddress": {},
"phone": "<string>",
"scacNumber": "<string>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"terms": 123
}
}
'import requests
url = "https://api.upwell.com/api/rest/carriers"
payload = { "input": {
"address": {},
"addressId": "<string>",
"addressesLastUpdatedAt": "2023-11-07T05:31:56Z",
"aljexId": "<string>",
"billingAddressId": "<string>",
"cargoInsuranceExpireDate": "<string>",
"dotNumber": "<string>",
"email": "<string>",
"freezePay": True,
"generalLiabilityInsuranceExpireDate": "<string>",
"isOwnerOperator": True,
"isQuickpay": True,
"liabilityInsuranceExpireDate": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"payToAddress": {},
"phone": "<string>",
"scacNumber": "<string>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"terms": 123
} }
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: {
address: {},
addressId: '<string>',
addressesLastUpdatedAt: '2023-11-07T05:31:56Z',
aljexId: '<string>',
billingAddressId: '<string>',
cargoInsuranceExpireDate: '<string>',
dotNumber: '<string>',
email: '<string>',
freezePay: true,
generalLiabilityInsuranceExpireDate: '<string>',
isOwnerOperator: true,
isQuickpay: true,
liabilityInsuranceExpireDate: '<string>',
mcNumber: '<string>',
name: '<string>',
payToAddress: {},
phone: '<string>',
scacNumber: '<string>',
shipmentId: '<string>',
sourceSystem: '<string>',
sourceSystemId: '<string>',
terms: 123
}
})
};
fetch('https://api.upwell.com/api/rest/carriers', 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/carriers",
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' => [
'address' => [
],
'addressId' => '<string>',
'addressesLastUpdatedAt' => '2023-11-07T05:31:56Z',
'aljexId' => '<string>',
'billingAddressId' => '<string>',
'cargoInsuranceExpireDate' => '<string>',
'dotNumber' => '<string>',
'email' => '<string>',
'freezePay' => true,
'generalLiabilityInsuranceExpireDate' => '<string>',
'isOwnerOperator' => true,
'isQuickpay' => true,
'liabilityInsuranceExpireDate' => '<string>',
'mcNumber' => '<string>',
'name' => '<string>',
'payToAddress' => [
],
'phone' => '<string>',
'scacNumber' => '<string>',
'shipmentId' => '<string>',
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'terms' => 123
]
]),
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/carriers"
payload := strings.NewReader("{\n \"input\": {\n \"address\": {},\n \"addressId\": \"<string>\",\n \"addressesLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"aljexId\": \"<string>\",\n \"billingAddressId\": \"<string>\",\n \"cargoInsuranceExpireDate\": \"<string>\",\n \"dotNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"freezePay\": true,\n \"generalLiabilityInsuranceExpireDate\": \"<string>\",\n \"isOwnerOperator\": true,\n \"isQuickpay\": true,\n \"liabilityInsuranceExpireDate\": \"<string>\",\n \"mcNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"payToAddress\": {},\n \"phone\": \"<string>\",\n \"scacNumber\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"terms\": 123\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/carriers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"input\": {\n \"address\": {},\n \"addressId\": \"<string>\",\n \"addressesLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"aljexId\": \"<string>\",\n \"billingAddressId\": \"<string>\",\n \"cargoInsuranceExpireDate\": \"<string>\",\n \"dotNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"freezePay\": true,\n \"generalLiabilityInsuranceExpireDate\": \"<string>\",\n \"isOwnerOperator\": true,\n \"isQuickpay\": true,\n \"liabilityInsuranceExpireDate\": \"<string>\",\n \"mcNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"payToAddress\": {},\n \"phone\": \"<string>\",\n \"scacNumber\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"terms\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/carriers")
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 \"address\": {},\n \"addressId\": \"<string>\",\n \"addressesLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"aljexId\": \"<string>\",\n \"billingAddressId\": \"<string>\",\n \"cargoInsuranceExpireDate\": \"<string>\",\n \"dotNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"freezePay\": true,\n \"generalLiabilityInsuranceExpireDate\": \"<string>\",\n \"isOwnerOperator\": true,\n \"isQuickpay\": true,\n \"liabilityInsuranceExpireDate\": \"<string>\",\n \"mcNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"payToAddress\": {},\n \"phone\": \"<string>\",\n \"scacNumber\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"terms\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"createCarrier": {
"addressId": "<string>",
"billingAddressId": "<string>",
"cargoInsuranceExpireDate": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"dotNumber": "<string>",
"email": "<string>",
"generalLiabilityInsuranceExpireDate": "<string>",
"id": "<string>",
"liabilityInsuranceExpireDate": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"phone": "<string>",
"scacNumber": "<string>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"terms": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}Carriers
Create One Carrier
Create a new carrier
POST
/
api
/
rest
/
carriers
Create One Carrier
curl --request POST \
--url https://api.upwell.com/api/rest/carriers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"address": {},
"addressId": "<string>",
"addressesLastUpdatedAt": "2023-11-07T05:31:56Z",
"aljexId": "<string>",
"billingAddressId": "<string>",
"cargoInsuranceExpireDate": "<string>",
"dotNumber": "<string>",
"email": "<string>",
"freezePay": true,
"generalLiabilityInsuranceExpireDate": "<string>",
"isOwnerOperator": true,
"isQuickpay": true,
"liabilityInsuranceExpireDate": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"payToAddress": {},
"phone": "<string>",
"scacNumber": "<string>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"terms": 123
}
}
'import requests
url = "https://api.upwell.com/api/rest/carriers"
payload = { "input": {
"address": {},
"addressId": "<string>",
"addressesLastUpdatedAt": "2023-11-07T05:31:56Z",
"aljexId": "<string>",
"billingAddressId": "<string>",
"cargoInsuranceExpireDate": "<string>",
"dotNumber": "<string>",
"email": "<string>",
"freezePay": True,
"generalLiabilityInsuranceExpireDate": "<string>",
"isOwnerOperator": True,
"isQuickpay": True,
"liabilityInsuranceExpireDate": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"payToAddress": {},
"phone": "<string>",
"scacNumber": "<string>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"terms": 123
} }
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: {
address: {},
addressId: '<string>',
addressesLastUpdatedAt: '2023-11-07T05:31:56Z',
aljexId: '<string>',
billingAddressId: '<string>',
cargoInsuranceExpireDate: '<string>',
dotNumber: '<string>',
email: '<string>',
freezePay: true,
generalLiabilityInsuranceExpireDate: '<string>',
isOwnerOperator: true,
isQuickpay: true,
liabilityInsuranceExpireDate: '<string>',
mcNumber: '<string>',
name: '<string>',
payToAddress: {},
phone: '<string>',
scacNumber: '<string>',
shipmentId: '<string>',
sourceSystem: '<string>',
sourceSystemId: '<string>',
terms: 123
}
})
};
fetch('https://api.upwell.com/api/rest/carriers', 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/carriers",
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' => [
'address' => [
],
'addressId' => '<string>',
'addressesLastUpdatedAt' => '2023-11-07T05:31:56Z',
'aljexId' => '<string>',
'billingAddressId' => '<string>',
'cargoInsuranceExpireDate' => '<string>',
'dotNumber' => '<string>',
'email' => '<string>',
'freezePay' => true,
'generalLiabilityInsuranceExpireDate' => '<string>',
'isOwnerOperator' => true,
'isQuickpay' => true,
'liabilityInsuranceExpireDate' => '<string>',
'mcNumber' => '<string>',
'name' => '<string>',
'payToAddress' => [
],
'phone' => '<string>',
'scacNumber' => '<string>',
'shipmentId' => '<string>',
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'terms' => 123
]
]),
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/carriers"
payload := strings.NewReader("{\n \"input\": {\n \"address\": {},\n \"addressId\": \"<string>\",\n \"addressesLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"aljexId\": \"<string>\",\n \"billingAddressId\": \"<string>\",\n \"cargoInsuranceExpireDate\": \"<string>\",\n \"dotNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"freezePay\": true,\n \"generalLiabilityInsuranceExpireDate\": \"<string>\",\n \"isOwnerOperator\": true,\n \"isQuickpay\": true,\n \"liabilityInsuranceExpireDate\": \"<string>\",\n \"mcNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"payToAddress\": {},\n \"phone\": \"<string>\",\n \"scacNumber\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"terms\": 123\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/carriers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"input\": {\n \"address\": {},\n \"addressId\": \"<string>\",\n \"addressesLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"aljexId\": \"<string>\",\n \"billingAddressId\": \"<string>\",\n \"cargoInsuranceExpireDate\": \"<string>\",\n \"dotNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"freezePay\": true,\n \"generalLiabilityInsuranceExpireDate\": \"<string>\",\n \"isOwnerOperator\": true,\n \"isQuickpay\": true,\n \"liabilityInsuranceExpireDate\": \"<string>\",\n \"mcNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"payToAddress\": {},\n \"phone\": \"<string>\",\n \"scacNumber\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"terms\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/carriers")
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 \"address\": {},\n \"addressId\": \"<string>\",\n \"addressesLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"aljexId\": \"<string>\",\n \"billingAddressId\": \"<string>\",\n \"cargoInsuranceExpireDate\": \"<string>\",\n \"dotNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"freezePay\": true,\n \"generalLiabilityInsuranceExpireDate\": \"<string>\",\n \"isOwnerOperator\": true,\n \"isQuickpay\": true,\n \"liabilityInsuranceExpireDate\": \"<string>\",\n \"mcNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"payToAddress\": {},\n \"phone\": \"<string>\",\n \"scacNumber\": \"<string>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"terms\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"createCarrier": {
"addressId": "<string>",
"billingAddressId": "<string>",
"cargoInsuranceExpireDate": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"dotNumber": "<string>",
"email": "<string>",
"generalLiabilityInsuranceExpireDate": "<string>",
"id": "<string>",
"liabilityInsuranceExpireDate": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"phone": "<string>",
"scacNumber": "<string>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"terms": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}A duplicate
(sourceSystem, sourceSystemId) silently no-ops — it does not update any field you send. To change an existing carrier, use PUT. See Idempotency & retries.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 "carriers"
Show child attributes
Show child attributes
Response
Responses for POST /api/rest/carriers
columns and relationships of "carriers"
Show child attributes
Show child attributes
⌘I