Skip to main content
PATCH
/
api
/
rest
/
shipment_line_items
/
{id}
Update One Shipment Line Item
curl --request PATCH \
  --url https://api.upwell.com/api/rest/shipment_line_items/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "input": {
    "commodityDescription": "<string>",
    "createdAt": "<unknown>",
    "deletedAt": "<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>"
  }
}
'
import requests

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

payload = {
    "id": "<string>",
    "input": {
        "commodityDescription": "<string>",
        "createdAt": "<unknown>",
        "deletedAt": "<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>"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    input: {
      commodityDescription: '<string>',
      createdAt: '<unknown>',
      deletedAt: '<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>'
    }
  })
};

fetch('https://api.upwell.com/api/rest/shipment_line_items/{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/shipment_line_items/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'input' => [
        'commodityDescription' => '<string>',
        'createdAt' => '<unknown>',
        'deletedAt' => '<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>'
    ]
  ]),
  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/shipment_line_items/{id}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"commodityDescription\": \"<string>\",\n    \"createdAt\": \"<unknown>\",\n    \"deletedAt\": \"<unknown>\",\n    \"deliveryLocationName\": \"<string>\",\n    \"dimensionUnit\": \"<string>\",\n    \"freightClass\": \"<string>\",\n    \"handlingUnit\": \"<string>\",\n    \"handlingUnitQty\": \"<unknown>\",\n    \"hazmatFlag\": true,\n    \"height\": \"<unknown>\",\n    \"id\": \"<string>\",\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    \"updatedAt\": \"<unknown>\",\n    \"weight\": \"<unknown>\",\n    \"weightUnit\": \"<string>\",\n    \"width\": \"<unknown>\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.upwell.com/api/rest/shipment_line_items/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"commodityDescription\": \"<string>\",\n    \"createdAt\": \"<unknown>\",\n    \"deletedAt\": \"<unknown>\",\n    \"deliveryLocationName\": \"<string>\",\n    \"dimensionUnit\": \"<string>\",\n    \"freightClass\": \"<string>\",\n    \"handlingUnit\": \"<string>\",\n    \"handlingUnitQty\": \"<unknown>\",\n    \"hazmatFlag\": true,\n    \"height\": \"<unknown>\",\n    \"id\": \"<string>\",\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    \"updatedAt\": \"<unknown>\",\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/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"commodityDescription\": \"<string>\",\n    \"createdAt\": \"<unknown>\",\n    \"deletedAt\": \"<unknown>\",\n    \"deliveryLocationName\": \"<string>\",\n    \"dimensionUnit\": \"<string>\",\n    \"freightClass\": \"<string>\",\n    \"handlingUnit\": \"<string>\",\n    \"handlingUnitQty\": \"<unknown>\",\n    \"hazmatFlag\": true,\n    \"height\": \"<unknown>\",\n    \"id\": \"<string>\",\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    \"updatedAt\": \"<unknown>\",\n    \"weight\": \"<unknown>\",\n    \"weightUnit\": \"<string>\",\n    \"width\": \"<unknown>\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "updateShipmentLineItem": {
    "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>"
  }
}

Headers

ā€‹
authorization
string

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

Path Parameters

ā€‹
id
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

ā€‹
id
string
ā€‹
input
ShipmentLineItemsSetInput Ā· object

input type for updating data in table "shipment_line_items"

Response

200 - application/json

Responses for PATCH /api/rest/shipment_line_items/{id}

ā€‹
updateShipmentLineItem
ShipmentLineItems Ā· object | null

Shipment Line Items