Update One Shipment

curl --request PUT \
  --url https://api.upwell.com/api/rest/shipments/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "input": {
    "billOfLadingNumber": "<string>",
    "billedDate": "2023-12-25",
    "billedMiles": "<unknown>",
    "carrierId": "<string>",
    "carrierProNumber": "<string>",
    "companyId": "<string>",
    "coveredDate": "2023-12-25",
    "createdFromEmailMessageId": "<string>",
    "customerId": "<string>",
    "customerPoNumber": "<string>",
    "customerReferenceNumber": "<string>",
    "deliveredAt": "<unknown>",
    "dispatchedDate": "2023-12-25",
    "dispatcherEmail": "<string>",
    "dispatcherName": "<string>",
    "dispatcherPhone": "<string>",
    "equipment": "<string>",
    "holdReason": "<string>",
    "invoiceId": "<string>",
    "loadDescription": "<string>",
    "loadedDate": "2023-12-25",
    "movementType": "<string>",
    "onHold": true,
    "pickupAt": "<unknown>",
    "releaseDate": "2023-12-25",
    "serviceLevel": "<string>",
    "shipmentId": "<string>",
    "signedBy": "<string>",
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>",
    "sourceSystemMeta": "<unknown>",
    "status": "<string>",
    "terminal": "<string>",
    "trailerNumber": "<string>",
    "volume": "<unknown>",
    "volumeUnit": "<string>",
    "weight": "<unknown>",
    "weightUnit": "<string>"
  }
}
'

import requests

url = "https://api.upwell.com/api/rest/shipments/{id}"

payload = {
    "id": "<string>",
    "input": {
        "billOfLadingNumber": "<string>",
        "billedDate": "2023-12-25",
        "billedMiles": "<unknown>",
        "carrierId": "<string>",
        "carrierProNumber": "<string>",
        "companyId": "<string>",
        "coveredDate": "2023-12-25",
        "createdFromEmailMessageId": "<string>",
        "customerId": "<string>",
        "customerPoNumber": "<string>",
        "customerReferenceNumber": "<string>",
        "deliveredAt": "<unknown>",
        "dispatchedDate": "2023-12-25",
        "dispatcherEmail": "<string>",
        "dispatcherName": "<string>",
        "dispatcherPhone": "<string>",
        "equipment": "<string>",
        "holdReason": "<string>",
        "invoiceId": "<string>",
        "loadDescription": "<string>",
        "loadedDate": "2023-12-25",
        "movementType": "<string>",
        "onHold": True,
        "pickupAt": "<unknown>",
        "releaseDate": "2023-12-25",
        "serviceLevel": "<string>",
        "shipmentId": "<string>",
        "signedBy": "<string>",
        "sourceSystem": "<string>",
        "sourceSystemId": "<string>",
        "sourceSystemMeta": "<unknown>",
        "status": "<string>",
        "terminal": "<string>",
        "trailerNumber": "<string>",
        "volume": "<unknown>",
        "volumeUnit": "<string>",
        "weight": "<unknown>",
        "weightUnit": "<string>"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    input: {
      billOfLadingNumber: '<string>',
      billedDate: '2023-12-25',
      billedMiles: '<unknown>',
      carrierId: '<string>',
      carrierProNumber: '<string>',
      companyId: '<string>',
      coveredDate: '2023-12-25',
      createdFromEmailMessageId: '<string>',
      customerId: '<string>',
      customerPoNumber: '<string>',
      customerReferenceNumber: '<string>',
      deliveredAt: '<unknown>',
      dispatchedDate: '2023-12-25',
      dispatcherEmail: '<string>',
      dispatcherName: '<string>',
      dispatcherPhone: '<string>',
      equipment: '<string>',
      holdReason: '<string>',
      invoiceId: '<string>',
      loadDescription: '<string>',
      loadedDate: '2023-12-25',
      movementType: '<string>',
      onHold: true,
      pickupAt: '<unknown>',
      releaseDate: '2023-12-25',
      serviceLevel: '<string>',
      shipmentId: '<string>',
      signedBy: '<string>',
      sourceSystem: '<string>',
      sourceSystemId: '<string>',
      sourceSystemMeta: '<unknown>',
      status: '<string>',
      terminal: '<string>',
      trailerNumber: '<string>',
      volume: '<unknown>',
      volumeUnit: '<string>',
      weight: '<unknown>',
      weightUnit: '<string>'
    }
  })
};

fetch('https://api.upwell.com/api/rest/shipments/{id}', 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/{id}",
  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([
    'id' => '<string>',
    'input' => [
        'billOfLadingNumber' => '<string>',
        'billedDate' => '2023-12-25',
        'billedMiles' => '<unknown>',
        'carrierId' => '<string>',
        'carrierProNumber' => '<string>',
        'companyId' => '<string>',
        'coveredDate' => '2023-12-25',
        'createdFromEmailMessageId' => '<string>',
        'customerId' => '<string>',
        'customerPoNumber' => '<string>',
        'customerReferenceNumber' => '<string>',
        'deliveredAt' => '<unknown>',
        'dispatchedDate' => '2023-12-25',
        'dispatcherEmail' => '<string>',
        'dispatcherName' => '<string>',
        'dispatcherPhone' => '<string>',
        'equipment' => '<string>',
        'holdReason' => '<string>',
        'invoiceId' => '<string>',
        'loadDescription' => '<string>',
        'loadedDate' => '2023-12-25',
        'movementType' => '<string>',
        'onHold' => true,
        'pickupAt' => '<unknown>',
        'releaseDate' => '2023-12-25',
        'serviceLevel' => '<string>',
        'shipmentId' => '<string>',
        'signedBy' => '<string>',
        'sourceSystem' => '<string>',
        'sourceSystemId' => '<string>',
        'sourceSystemMeta' => '<unknown>',
        'status' => '<string>',
        'terminal' => '<string>',
        'trailerNumber' => '<string>',
        '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/{id}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"billOfLadingNumber\": \"<string>\",\n    \"billedDate\": \"2023-12-25\",\n    \"billedMiles\": \"<unknown>\",\n    \"carrierId\": \"<string>\",\n    \"carrierProNumber\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"coveredDate\": \"2023-12-25\",\n    \"createdFromEmailMessageId\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"customerPoNumber\": \"<string>\",\n    \"customerReferenceNumber\": \"<string>\",\n    \"deliveredAt\": \"<unknown>\",\n    \"dispatchedDate\": \"2023-12-25\",\n    \"dispatcherEmail\": \"<string>\",\n    \"dispatcherName\": \"<string>\",\n    \"dispatcherPhone\": \"<string>\",\n    \"equipment\": \"<string>\",\n    \"holdReason\": \"<string>\",\n    \"invoiceId\": \"<string>\",\n    \"loadDescription\": \"<string>\",\n    \"loadedDate\": \"2023-12-25\",\n    \"movementType\": \"<string>\",\n    \"onHold\": true,\n    \"pickupAt\": \"<unknown>\",\n    \"releaseDate\": \"2023-12-25\",\n    \"serviceLevel\": \"<string>\",\n    \"shipmentId\": \"<string>\",\n    \"signedBy\": \"<string>\",\n    \"sourceSystem\": \"<string>\",\n    \"sourceSystemId\": \"<string>\",\n    \"sourceSystemMeta\": \"<unknown>\",\n    \"status\": \"<string>\",\n    \"terminal\": \"<string>\",\n    \"trailerNumber\": \"<string>\",\n    \"volume\": \"<unknown>\",\n    \"volumeUnit\": \"<string>\",\n    \"weight\": \"<unknown>\",\n    \"weightUnit\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.upwell.com/api/rest/shipments/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"billOfLadingNumber\": \"<string>\",\n    \"billedDate\": \"2023-12-25\",\n    \"billedMiles\": \"<unknown>\",\n    \"carrierId\": \"<string>\",\n    \"carrierProNumber\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"coveredDate\": \"2023-12-25\",\n    \"createdFromEmailMessageId\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"customerPoNumber\": \"<string>\",\n    \"customerReferenceNumber\": \"<string>\",\n    \"deliveredAt\": \"<unknown>\",\n    \"dispatchedDate\": \"2023-12-25\",\n    \"dispatcherEmail\": \"<string>\",\n    \"dispatcherName\": \"<string>\",\n    \"dispatcherPhone\": \"<string>\",\n    \"equipment\": \"<string>\",\n    \"holdReason\": \"<string>\",\n    \"invoiceId\": \"<string>\",\n    \"loadDescription\": \"<string>\",\n    \"loadedDate\": \"2023-12-25\",\n    \"movementType\": \"<string>\",\n    \"onHold\": true,\n    \"pickupAt\": \"<unknown>\",\n    \"releaseDate\": \"2023-12-25\",\n    \"serviceLevel\": \"<string>\",\n    \"shipmentId\": \"<string>\",\n    \"signedBy\": \"<string>\",\n    \"sourceSystem\": \"<string>\",\n    \"sourceSystemId\": \"<string>\",\n    \"sourceSystemMeta\": \"<unknown>\",\n    \"status\": \"<string>\",\n    \"terminal\": \"<string>\",\n    \"trailerNumber\": \"<string>\",\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/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"billOfLadingNumber\": \"<string>\",\n    \"billedDate\": \"2023-12-25\",\n    \"billedMiles\": \"<unknown>\",\n    \"carrierId\": \"<string>\",\n    \"carrierProNumber\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"coveredDate\": \"2023-12-25\",\n    \"createdFromEmailMessageId\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"customerPoNumber\": \"<string>\",\n    \"customerReferenceNumber\": \"<string>\",\n    \"deliveredAt\": \"<unknown>\",\n    \"dispatchedDate\": \"2023-12-25\",\n    \"dispatcherEmail\": \"<string>\",\n    \"dispatcherName\": \"<string>\",\n    \"dispatcherPhone\": \"<string>\",\n    \"equipment\": \"<string>\",\n    \"holdReason\": \"<string>\",\n    \"invoiceId\": \"<string>\",\n    \"loadDescription\": \"<string>\",\n    \"loadedDate\": \"2023-12-25\",\n    \"movementType\": \"<string>\",\n    \"onHold\": true,\n    \"pickupAt\": \"<unknown>\",\n    \"releaseDate\": \"2023-12-25\",\n    \"serviceLevel\": \"<string>\",\n    \"shipmentId\": \"<string>\",\n    \"signedBy\": \"<string>\",\n    \"sourceSystem\": \"<string>\",\n    \"sourceSystemId\": \"<string>\",\n    \"sourceSystemMeta\": \"<unknown>\",\n    \"status\": \"<string>\",\n    \"terminal\": \"<string>\",\n    \"trailerNumber\": \"<string>\",\n    \"volume\": \"<unknown>\",\n    \"volumeUnit\": \"<string>\",\n    \"weight\": \"<unknown>\",\n    \"weightUnit\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "updateShipment": {
    "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>"
  }
}

PUT

api

rest

shipments

{id}

Update One Shipment

curl --request PUT \
  --url https://api.upwell.com/api/rest/shipments/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "input": {
    "billOfLadingNumber": "<string>",
    "billedDate": "2023-12-25",
    "billedMiles": "<unknown>",
    "carrierId": "<string>",
    "carrierProNumber": "<string>",
    "companyId": "<string>",
    "coveredDate": "2023-12-25",
    "createdFromEmailMessageId": "<string>",
    "customerId": "<string>",
    "customerPoNumber": "<string>",
    "customerReferenceNumber": "<string>",
    "deliveredAt": "<unknown>",
    "dispatchedDate": "2023-12-25",
    "dispatcherEmail": "<string>",
    "dispatcherName": "<string>",
    "dispatcherPhone": "<string>",
    "equipment": "<string>",
    "holdReason": "<string>",
    "invoiceId": "<string>",
    "loadDescription": "<string>",
    "loadedDate": "2023-12-25",
    "movementType": "<string>",
    "onHold": true,
    "pickupAt": "<unknown>",
    "releaseDate": "2023-12-25",
    "serviceLevel": "<string>",
    "shipmentId": "<string>",
    "signedBy": "<string>",
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>",
    "sourceSystemMeta": "<unknown>",
    "status": "<string>",
    "terminal": "<string>",
    "trailerNumber": "<string>",
    "volume": "<unknown>",
    "volumeUnit": "<string>",
    "weight": "<unknown>",
    "weightUnit": "<string>"
  }
}
'

import requests

url = "https://api.upwell.com/api/rest/shipments/{id}"

payload = {
    "id": "<string>",
    "input": {
        "billOfLadingNumber": "<string>",
        "billedDate": "2023-12-25",
        "billedMiles": "<unknown>",
        "carrierId": "<string>",
        "carrierProNumber": "<string>",
        "companyId": "<string>",
        "coveredDate": "2023-12-25",
        "createdFromEmailMessageId": "<string>",
        "customerId": "<string>",
        "customerPoNumber": "<string>",
        "customerReferenceNumber": "<string>",
        "deliveredAt": "<unknown>",
        "dispatchedDate": "2023-12-25",
        "dispatcherEmail": "<string>",
        "dispatcherName": "<string>",
        "dispatcherPhone": "<string>",
        "equipment": "<string>",
        "holdReason": "<string>",
        "invoiceId": "<string>",
        "loadDescription": "<string>",
        "loadedDate": "2023-12-25",
        "movementType": "<string>",
        "onHold": True,
        "pickupAt": "<unknown>",
        "releaseDate": "2023-12-25",
        "serviceLevel": "<string>",
        "shipmentId": "<string>",
        "signedBy": "<string>",
        "sourceSystem": "<string>",
        "sourceSystemId": "<string>",
        "sourceSystemMeta": "<unknown>",
        "status": "<string>",
        "terminal": "<string>",
        "trailerNumber": "<string>",
        "volume": "<unknown>",
        "volumeUnit": "<string>",
        "weight": "<unknown>",
        "weightUnit": "<string>"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    input: {
      billOfLadingNumber: '<string>',
      billedDate: '2023-12-25',
      billedMiles: '<unknown>',
      carrierId: '<string>',
      carrierProNumber: '<string>',
      companyId: '<string>',
      coveredDate: '2023-12-25',
      createdFromEmailMessageId: '<string>',
      customerId: '<string>',
      customerPoNumber: '<string>',
      customerReferenceNumber: '<string>',
      deliveredAt: '<unknown>',
      dispatchedDate: '2023-12-25',
      dispatcherEmail: '<string>',
      dispatcherName: '<string>',
      dispatcherPhone: '<string>',
      equipment: '<string>',
      holdReason: '<string>',
      invoiceId: '<string>',
      loadDescription: '<string>',
      loadedDate: '2023-12-25',
      movementType: '<string>',
      onHold: true,
      pickupAt: '<unknown>',
      releaseDate: '2023-12-25',
      serviceLevel: '<string>',
      shipmentId: '<string>',
      signedBy: '<string>',
      sourceSystem: '<string>',
      sourceSystemId: '<string>',
      sourceSystemMeta: '<unknown>',
      status: '<string>',
      terminal: '<string>',
      trailerNumber: '<string>',
      volume: '<unknown>',
      volumeUnit: '<string>',
      weight: '<unknown>',
      weightUnit: '<string>'
    }
  })
};

fetch('https://api.upwell.com/api/rest/shipments/{id}', 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/{id}",
  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([
    'id' => '<string>',
    'input' => [
        'billOfLadingNumber' => '<string>',
        'billedDate' => '2023-12-25',
        'billedMiles' => '<unknown>',
        'carrierId' => '<string>',
        'carrierProNumber' => '<string>',
        'companyId' => '<string>',
        'coveredDate' => '2023-12-25',
        'createdFromEmailMessageId' => '<string>',
        'customerId' => '<string>',
        'customerPoNumber' => '<string>',
        'customerReferenceNumber' => '<string>',
        'deliveredAt' => '<unknown>',
        'dispatchedDate' => '2023-12-25',
        'dispatcherEmail' => '<string>',
        'dispatcherName' => '<string>',
        'dispatcherPhone' => '<string>',
        'equipment' => '<string>',
        'holdReason' => '<string>',
        'invoiceId' => '<string>',
        'loadDescription' => '<string>',
        'loadedDate' => '2023-12-25',
        'movementType' => '<string>',
        'onHold' => true,
        'pickupAt' => '<unknown>',
        'releaseDate' => '2023-12-25',
        'serviceLevel' => '<string>',
        'shipmentId' => '<string>',
        'signedBy' => '<string>',
        'sourceSystem' => '<string>',
        'sourceSystemId' => '<string>',
        'sourceSystemMeta' => '<unknown>',
        'status' => '<string>',
        'terminal' => '<string>',
        'trailerNumber' => '<string>',
        '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/{id}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"billOfLadingNumber\": \"<string>\",\n    \"billedDate\": \"2023-12-25\",\n    \"billedMiles\": \"<unknown>\",\n    \"carrierId\": \"<string>\",\n    \"carrierProNumber\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"coveredDate\": \"2023-12-25\",\n    \"createdFromEmailMessageId\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"customerPoNumber\": \"<string>\",\n    \"customerReferenceNumber\": \"<string>\",\n    \"deliveredAt\": \"<unknown>\",\n    \"dispatchedDate\": \"2023-12-25\",\n    \"dispatcherEmail\": \"<string>\",\n    \"dispatcherName\": \"<string>\",\n    \"dispatcherPhone\": \"<string>\",\n    \"equipment\": \"<string>\",\n    \"holdReason\": \"<string>\",\n    \"invoiceId\": \"<string>\",\n    \"loadDescription\": \"<string>\",\n    \"loadedDate\": \"2023-12-25\",\n    \"movementType\": \"<string>\",\n    \"onHold\": true,\n    \"pickupAt\": \"<unknown>\",\n    \"releaseDate\": \"2023-12-25\",\n    \"serviceLevel\": \"<string>\",\n    \"shipmentId\": \"<string>\",\n    \"signedBy\": \"<string>\",\n    \"sourceSystem\": \"<string>\",\n    \"sourceSystemId\": \"<string>\",\n    \"sourceSystemMeta\": \"<unknown>\",\n    \"status\": \"<string>\",\n    \"terminal\": \"<string>\",\n    \"trailerNumber\": \"<string>\",\n    \"volume\": \"<unknown>\",\n    \"volumeUnit\": \"<string>\",\n    \"weight\": \"<unknown>\",\n    \"weightUnit\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.upwell.com/api/rest/shipments/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"billOfLadingNumber\": \"<string>\",\n    \"billedDate\": \"2023-12-25\",\n    \"billedMiles\": \"<unknown>\",\n    \"carrierId\": \"<string>\",\n    \"carrierProNumber\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"coveredDate\": \"2023-12-25\",\n    \"createdFromEmailMessageId\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"customerPoNumber\": \"<string>\",\n    \"customerReferenceNumber\": \"<string>\",\n    \"deliveredAt\": \"<unknown>\",\n    \"dispatchedDate\": \"2023-12-25\",\n    \"dispatcherEmail\": \"<string>\",\n    \"dispatcherName\": \"<string>\",\n    \"dispatcherPhone\": \"<string>\",\n    \"equipment\": \"<string>\",\n    \"holdReason\": \"<string>\",\n    \"invoiceId\": \"<string>\",\n    \"loadDescription\": \"<string>\",\n    \"loadedDate\": \"2023-12-25\",\n    \"movementType\": \"<string>\",\n    \"onHold\": true,\n    \"pickupAt\": \"<unknown>\",\n    \"releaseDate\": \"2023-12-25\",\n    \"serviceLevel\": \"<string>\",\n    \"shipmentId\": \"<string>\",\n    \"signedBy\": \"<string>\",\n    \"sourceSystem\": \"<string>\",\n    \"sourceSystemId\": \"<string>\",\n    \"sourceSystemMeta\": \"<unknown>\",\n    \"status\": \"<string>\",\n    \"terminal\": \"<string>\",\n    \"trailerNumber\": \"<string>\",\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/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"billOfLadingNumber\": \"<string>\",\n    \"billedDate\": \"2023-12-25\",\n    \"billedMiles\": \"<unknown>\",\n    \"carrierId\": \"<string>\",\n    \"carrierProNumber\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"coveredDate\": \"2023-12-25\",\n    \"createdFromEmailMessageId\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"customerPoNumber\": \"<string>\",\n    \"customerReferenceNumber\": \"<string>\",\n    \"deliveredAt\": \"<unknown>\",\n    \"dispatchedDate\": \"2023-12-25\",\n    \"dispatcherEmail\": \"<string>\",\n    \"dispatcherName\": \"<string>\",\n    \"dispatcherPhone\": \"<string>\",\n    \"equipment\": \"<string>\",\n    \"holdReason\": \"<string>\",\n    \"invoiceId\": \"<string>\",\n    \"loadDescription\": \"<string>\",\n    \"loadedDate\": \"2023-12-25\",\n    \"movementType\": \"<string>\",\n    \"onHold\": true,\n    \"pickupAt\": \"<unknown>\",\n    \"releaseDate\": \"2023-12-25\",\n    \"serviceLevel\": \"<string>\",\n    \"shipmentId\": \"<string>\",\n    \"signedBy\": \"<string>\",\n    \"sourceSystem\": \"<string>\",\n    \"sourceSystemId\": \"<string>\",\n    \"sourceSystemMeta\": \"<unknown>\",\n    \"status\": \"<string>\",\n    \"terminal\": \"<string>\",\n    \"trailerNumber\": \"<string>\",\n    \"volume\": \"<unknown>\",\n    \"volumeUnit\": \"<string>\",\n    \"weight\": \"<unknown>\",\n    \"weightUnit\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "updateShipment": {
    "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

authorization

string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Path Parameters

string

required

"id" is required (enter it either in parameters or request body)

Body

application/json

Query parameters can also be provided in the request body as a JSON object

string

input

ShipmentsSetInput · object

input type for updating data in table "shipments"

Show child attributes

Response

200 - application/json

Responses for PUT /api/rest/shipments/{id}

updateShipment

Shipments · object | null

columns and relationships of "shipments"

Show child attributes

⌘I