Update One Purchase Order
curl --request PATCH \
--url https://api.upwell.com/api/rest/purchase-orders/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"input": {
"buyerContactName": "<string>",
"buyerEmail": "<string>",
"buyerName": "<string>",
"buyerPhone": "<string>",
"cancelAfterDate": "2023-12-25",
"confirmToEmail": "<string>",
"contractNumber": "<string>",
"customerAccountNumber": "<string>",
"department": "<string>",
"fobPoint": "<string>",
"freightTerms": "<string>",
"incoterms": "<string>",
"legibilityReasoning": "<string>",
"legibilityScore": "<unknown>",
"miscChargeAmount": 123,
"notes": "<string>",
"paymentTermsDescription": "<string>",
"paymentTermsDiscountDays": 123,
"paymentTermsDiscountPercent": "<unknown>",
"paymentTermsNetDays": 123,
"pickupDate": "2023-12-25",
"poDate": "2023-12-25",
"poNumber": "<string>",
"poType": "<string>",
"projectNumber": "<string>",
"referenceNumbers": "<unknown>",
"releaseNumber": "<string>",
"requestedDeliveryDate": "2023-12-25",
"requestedShipDate": "2023-12-25",
"requesterName": "<string>",
"requisitionNumber": "<string>",
"revisionDate": "2023-12-25",
"revisionNumber": "<string>",
"shipToCode": "<string>",
"shipVia": "<string>",
"specialInstructions": "<string>",
"subtotalAmount": 123,
"taxAmount": 123,
"totalAmount": 123,
"totalQuantity": "<unknown>",
"totalVolume": "<unknown>",
"totalWeight": "<unknown>",
"vendorInstructions": "<string>",
"vendorNumber": "<string>",
"weightUnit": "<string>"
}
}
'import requests
url = "https://api.upwell.com/api/rest/purchase-orders/{id}"
payload = {
"id": "<string>",
"input": {
"buyerContactName": "<string>",
"buyerEmail": "<string>",
"buyerName": "<string>",
"buyerPhone": "<string>",
"cancelAfterDate": "2023-12-25",
"confirmToEmail": "<string>",
"contractNumber": "<string>",
"customerAccountNumber": "<string>",
"department": "<string>",
"fobPoint": "<string>",
"freightTerms": "<string>",
"incoterms": "<string>",
"legibilityReasoning": "<string>",
"legibilityScore": "<unknown>",
"miscChargeAmount": 123,
"notes": "<string>",
"paymentTermsDescription": "<string>",
"paymentTermsDiscountDays": 123,
"paymentTermsDiscountPercent": "<unknown>",
"paymentTermsNetDays": 123,
"pickupDate": "2023-12-25",
"poDate": "2023-12-25",
"poNumber": "<string>",
"poType": "<string>",
"projectNumber": "<string>",
"referenceNumbers": "<unknown>",
"releaseNumber": "<string>",
"requestedDeliveryDate": "2023-12-25",
"requestedShipDate": "2023-12-25",
"requesterName": "<string>",
"requisitionNumber": "<string>",
"revisionDate": "2023-12-25",
"revisionNumber": "<string>",
"shipToCode": "<string>",
"shipVia": "<string>",
"specialInstructions": "<string>",
"subtotalAmount": 123,
"taxAmount": 123,
"totalAmount": 123,
"totalQuantity": "<unknown>",
"totalVolume": "<unknown>",
"totalWeight": "<unknown>",
"vendorInstructions": "<string>",
"vendorNumber": "<string>",
"weightUnit": "<string>"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
input: {
buyerContactName: '<string>',
buyerEmail: '<string>',
buyerName: '<string>',
buyerPhone: '<string>',
cancelAfterDate: '2023-12-25',
confirmToEmail: '<string>',
contractNumber: '<string>',
customerAccountNumber: '<string>',
department: '<string>',
fobPoint: '<string>',
freightTerms: '<string>',
incoterms: '<string>',
legibilityReasoning: '<string>',
legibilityScore: '<unknown>',
miscChargeAmount: 123,
notes: '<string>',
paymentTermsDescription: '<string>',
paymentTermsDiscountDays: 123,
paymentTermsDiscountPercent: '<unknown>',
paymentTermsNetDays: 123,
pickupDate: '2023-12-25',
poDate: '2023-12-25',
poNumber: '<string>',
poType: '<string>',
projectNumber: '<string>',
referenceNumbers: '<unknown>',
releaseNumber: '<string>',
requestedDeliveryDate: '2023-12-25',
requestedShipDate: '2023-12-25',
requesterName: '<string>',
requisitionNumber: '<string>',
revisionDate: '2023-12-25',
revisionNumber: '<string>',
shipToCode: '<string>',
shipVia: '<string>',
specialInstructions: '<string>',
subtotalAmount: 123,
taxAmount: 123,
totalAmount: 123,
totalQuantity: '<unknown>',
totalVolume: '<unknown>',
totalWeight: '<unknown>',
vendorInstructions: '<string>',
vendorNumber: '<string>',
weightUnit: '<string>'
}
})
};
fetch('https://api.upwell.com/api/rest/purchase-orders/{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/purchase-orders/{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' => [
'buyerContactName' => '<string>',
'buyerEmail' => '<string>',
'buyerName' => '<string>',
'buyerPhone' => '<string>',
'cancelAfterDate' => '2023-12-25',
'confirmToEmail' => '<string>',
'contractNumber' => '<string>',
'customerAccountNumber' => '<string>',
'department' => '<string>',
'fobPoint' => '<string>',
'freightTerms' => '<string>',
'incoterms' => '<string>',
'legibilityReasoning' => '<string>',
'legibilityScore' => '<unknown>',
'miscChargeAmount' => 123,
'notes' => '<string>',
'paymentTermsDescription' => '<string>',
'paymentTermsDiscountDays' => 123,
'paymentTermsDiscountPercent' => '<unknown>',
'paymentTermsNetDays' => 123,
'pickupDate' => '2023-12-25',
'poDate' => '2023-12-25',
'poNumber' => '<string>',
'poType' => '<string>',
'projectNumber' => '<string>',
'referenceNumbers' => '<unknown>',
'releaseNumber' => '<string>',
'requestedDeliveryDate' => '2023-12-25',
'requestedShipDate' => '2023-12-25',
'requesterName' => '<string>',
'requisitionNumber' => '<string>',
'revisionDate' => '2023-12-25',
'revisionNumber' => '<string>',
'shipToCode' => '<string>',
'shipVia' => '<string>',
'specialInstructions' => '<string>',
'subtotalAmount' => 123,
'taxAmount' => 123,
'totalAmount' => 123,
'totalQuantity' => '<unknown>',
'totalVolume' => '<unknown>',
'totalWeight' => '<unknown>',
'vendorInstructions' => '<string>',
'vendorNumber' => '<string>',
'weightUnit' => '<string>'
]
]),
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/purchase-orders/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"input\": {\n \"buyerContactName\": \"<string>\",\n \"buyerEmail\": \"<string>\",\n \"buyerName\": \"<string>\",\n \"buyerPhone\": \"<string>\",\n \"cancelAfterDate\": \"2023-12-25\",\n \"confirmToEmail\": \"<string>\",\n \"contractNumber\": \"<string>\",\n \"customerAccountNumber\": \"<string>\",\n \"department\": \"<string>\",\n \"fobPoint\": \"<string>\",\n \"freightTerms\": \"<string>\",\n \"incoterms\": \"<string>\",\n \"legibilityReasoning\": \"<string>\",\n \"legibilityScore\": \"<unknown>\",\n \"miscChargeAmount\": 123,\n \"notes\": \"<string>\",\n \"paymentTermsDescription\": \"<string>\",\n \"paymentTermsDiscountDays\": 123,\n \"paymentTermsDiscountPercent\": \"<unknown>\",\n \"paymentTermsNetDays\": 123,\n \"pickupDate\": \"2023-12-25\",\n \"poDate\": \"2023-12-25\",\n \"poNumber\": \"<string>\",\n \"poType\": \"<string>\",\n \"projectNumber\": \"<string>\",\n \"referenceNumbers\": \"<unknown>\",\n \"releaseNumber\": \"<string>\",\n \"requestedDeliveryDate\": \"2023-12-25\",\n \"requestedShipDate\": \"2023-12-25\",\n \"requesterName\": \"<string>\",\n \"requisitionNumber\": \"<string>\",\n \"revisionDate\": \"2023-12-25\",\n \"revisionNumber\": \"<string>\",\n \"shipToCode\": \"<string>\",\n \"shipVia\": \"<string>\",\n \"specialInstructions\": \"<string>\",\n \"subtotalAmount\": 123,\n \"taxAmount\": 123,\n \"totalAmount\": 123,\n \"totalQuantity\": \"<unknown>\",\n \"totalVolume\": \"<unknown>\",\n \"totalWeight\": \"<unknown>\",\n \"vendorInstructions\": \"<string>\",\n \"vendorNumber\": \"<string>\",\n \"weightUnit\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.upwell.com/api/rest/purchase-orders/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"input\": {\n \"buyerContactName\": \"<string>\",\n \"buyerEmail\": \"<string>\",\n \"buyerName\": \"<string>\",\n \"buyerPhone\": \"<string>\",\n \"cancelAfterDate\": \"2023-12-25\",\n \"confirmToEmail\": \"<string>\",\n \"contractNumber\": \"<string>\",\n \"customerAccountNumber\": \"<string>\",\n \"department\": \"<string>\",\n \"fobPoint\": \"<string>\",\n \"freightTerms\": \"<string>\",\n \"incoterms\": \"<string>\",\n \"legibilityReasoning\": \"<string>\",\n \"legibilityScore\": \"<unknown>\",\n \"miscChargeAmount\": 123,\n \"notes\": \"<string>\",\n \"paymentTermsDescription\": \"<string>\",\n \"paymentTermsDiscountDays\": 123,\n \"paymentTermsDiscountPercent\": \"<unknown>\",\n \"paymentTermsNetDays\": 123,\n \"pickupDate\": \"2023-12-25\",\n \"poDate\": \"2023-12-25\",\n \"poNumber\": \"<string>\",\n \"poType\": \"<string>\",\n \"projectNumber\": \"<string>\",\n \"referenceNumbers\": \"<unknown>\",\n \"releaseNumber\": \"<string>\",\n \"requestedDeliveryDate\": \"2023-12-25\",\n \"requestedShipDate\": \"2023-12-25\",\n \"requesterName\": \"<string>\",\n \"requisitionNumber\": \"<string>\",\n \"revisionDate\": \"2023-12-25\",\n \"revisionNumber\": \"<string>\",\n \"shipToCode\": \"<string>\",\n \"shipVia\": \"<string>\",\n \"specialInstructions\": \"<string>\",\n \"subtotalAmount\": 123,\n \"taxAmount\": 123,\n \"totalAmount\": 123,\n \"totalQuantity\": \"<unknown>\",\n \"totalVolume\": \"<unknown>\",\n \"totalWeight\": \"<unknown>\",\n \"vendorInstructions\": \"<string>\",\n \"vendorNumber\": \"<string>\",\n \"weightUnit\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/purchase-orders/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"input\": {\n \"buyerContactName\": \"<string>\",\n \"buyerEmail\": \"<string>\",\n \"buyerName\": \"<string>\",\n \"buyerPhone\": \"<string>\",\n \"cancelAfterDate\": \"2023-12-25\",\n \"confirmToEmail\": \"<string>\",\n \"contractNumber\": \"<string>\",\n \"customerAccountNumber\": \"<string>\",\n \"department\": \"<string>\",\n \"fobPoint\": \"<string>\",\n \"freightTerms\": \"<string>\",\n \"incoterms\": \"<string>\",\n \"legibilityReasoning\": \"<string>\",\n \"legibilityScore\": \"<unknown>\",\n \"miscChargeAmount\": 123,\n \"notes\": \"<string>\",\n \"paymentTermsDescription\": \"<string>\",\n \"paymentTermsDiscountDays\": 123,\n \"paymentTermsDiscountPercent\": \"<unknown>\",\n \"paymentTermsNetDays\": 123,\n \"pickupDate\": \"2023-12-25\",\n \"poDate\": \"2023-12-25\",\n \"poNumber\": \"<string>\",\n \"poType\": \"<string>\",\n \"projectNumber\": \"<string>\",\n \"referenceNumbers\": \"<unknown>\",\n \"releaseNumber\": \"<string>\",\n \"requestedDeliveryDate\": \"2023-12-25\",\n \"requestedShipDate\": \"2023-12-25\",\n \"requesterName\": \"<string>\",\n \"requisitionNumber\": \"<string>\",\n \"revisionDate\": \"2023-12-25\",\n \"revisionNumber\": \"<string>\",\n \"shipToCode\": \"<string>\",\n \"shipVia\": \"<string>\",\n \"specialInstructions\": \"<string>\",\n \"subtotalAmount\": 123,\n \"taxAmount\": 123,\n \"totalAmount\": 123,\n \"totalQuantity\": \"<unknown>\",\n \"totalVolume\": \"<unknown>\",\n \"totalWeight\": \"<unknown>\",\n \"vendorInstructions\": \"<string>\",\n \"vendorNumber\": \"<string>\",\n \"weightUnit\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"updatePurchaseOrder": {
"id": "<string>"
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}Purchase Orders
Update One Purchase Order
Update parsed purchase order header fields. Body: { "input": { ...fields to set... } } using the record’s camelCase field names (amounts in integer cents). System-managed columns (ids, tenant/document linkage, party references, match state) are not updatable and are rejected.
PATCH
/
api
/
rest
/
purchase-orders
/
{id}
Update One Purchase Order
curl --request PATCH \
--url https://api.upwell.com/api/rest/purchase-orders/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"input": {
"buyerContactName": "<string>",
"buyerEmail": "<string>",
"buyerName": "<string>",
"buyerPhone": "<string>",
"cancelAfterDate": "2023-12-25",
"confirmToEmail": "<string>",
"contractNumber": "<string>",
"customerAccountNumber": "<string>",
"department": "<string>",
"fobPoint": "<string>",
"freightTerms": "<string>",
"incoterms": "<string>",
"legibilityReasoning": "<string>",
"legibilityScore": "<unknown>",
"miscChargeAmount": 123,
"notes": "<string>",
"paymentTermsDescription": "<string>",
"paymentTermsDiscountDays": 123,
"paymentTermsDiscountPercent": "<unknown>",
"paymentTermsNetDays": 123,
"pickupDate": "2023-12-25",
"poDate": "2023-12-25",
"poNumber": "<string>",
"poType": "<string>",
"projectNumber": "<string>",
"referenceNumbers": "<unknown>",
"releaseNumber": "<string>",
"requestedDeliveryDate": "2023-12-25",
"requestedShipDate": "2023-12-25",
"requesterName": "<string>",
"requisitionNumber": "<string>",
"revisionDate": "2023-12-25",
"revisionNumber": "<string>",
"shipToCode": "<string>",
"shipVia": "<string>",
"specialInstructions": "<string>",
"subtotalAmount": 123,
"taxAmount": 123,
"totalAmount": 123,
"totalQuantity": "<unknown>",
"totalVolume": "<unknown>",
"totalWeight": "<unknown>",
"vendorInstructions": "<string>",
"vendorNumber": "<string>",
"weightUnit": "<string>"
}
}
'import requests
url = "https://api.upwell.com/api/rest/purchase-orders/{id}"
payload = {
"id": "<string>",
"input": {
"buyerContactName": "<string>",
"buyerEmail": "<string>",
"buyerName": "<string>",
"buyerPhone": "<string>",
"cancelAfterDate": "2023-12-25",
"confirmToEmail": "<string>",
"contractNumber": "<string>",
"customerAccountNumber": "<string>",
"department": "<string>",
"fobPoint": "<string>",
"freightTerms": "<string>",
"incoterms": "<string>",
"legibilityReasoning": "<string>",
"legibilityScore": "<unknown>",
"miscChargeAmount": 123,
"notes": "<string>",
"paymentTermsDescription": "<string>",
"paymentTermsDiscountDays": 123,
"paymentTermsDiscountPercent": "<unknown>",
"paymentTermsNetDays": 123,
"pickupDate": "2023-12-25",
"poDate": "2023-12-25",
"poNumber": "<string>",
"poType": "<string>",
"projectNumber": "<string>",
"referenceNumbers": "<unknown>",
"releaseNumber": "<string>",
"requestedDeliveryDate": "2023-12-25",
"requestedShipDate": "2023-12-25",
"requesterName": "<string>",
"requisitionNumber": "<string>",
"revisionDate": "2023-12-25",
"revisionNumber": "<string>",
"shipToCode": "<string>",
"shipVia": "<string>",
"specialInstructions": "<string>",
"subtotalAmount": 123,
"taxAmount": 123,
"totalAmount": 123,
"totalQuantity": "<unknown>",
"totalVolume": "<unknown>",
"totalWeight": "<unknown>",
"vendorInstructions": "<string>",
"vendorNumber": "<string>",
"weightUnit": "<string>"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
input: {
buyerContactName: '<string>',
buyerEmail: '<string>',
buyerName: '<string>',
buyerPhone: '<string>',
cancelAfterDate: '2023-12-25',
confirmToEmail: '<string>',
contractNumber: '<string>',
customerAccountNumber: '<string>',
department: '<string>',
fobPoint: '<string>',
freightTerms: '<string>',
incoterms: '<string>',
legibilityReasoning: '<string>',
legibilityScore: '<unknown>',
miscChargeAmount: 123,
notes: '<string>',
paymentTermsDescription: '<string>',
paymentTermsDiscountDays: 123,
paymentTermsDiscountPercent: '<unknown>',
paymentTermsNetDays: 123,
pickupDate: '2023-12-25',
poDate: '2023-12-25',
poNumber: '<string>',
poType: '<string>',
projectNumber: '<string>',
referenceNumbers: '<unknown>',
releaseNumber: '<string>',
requestedDeliveryDate: '2023-12-25',
requestedShipDate: '2023-12-25',
requesterName: '<string>',
requisitionNumber: '<string>',
revisionDate: '2023-12-25',
revisionNumber: '<string>',
shipToCode: '<string>',
shipVia: '<string>',
specialInstructions: '<string>',
subtotalAmount: 123,
taxAmount: 123,
totalAmount: 123,
totalQuantity: '<unknown>',
totalVolume: '<unknown>',
totalWeight: '<unknown>',
vendorInstructions: '<string>',
vendorNumber: '<string>',
weightUnit: '<string>'
}
})
};
fetch('https://api.upwell.com/api/rest/purchase-orders/{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/purchase-orders/{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' => [
'buyerContactName' => '<string>',
'buyerEmail' => '<string>',
'buyerName' => '<string>',
'buyerPhone' => '<string>',
'cancelAfterDate' => '2023-12-25',
'confirmToEmail' => '<string>',
'contractNumber' => '<string>',
'customerAccountNumber' => '<string>',
'department' => '<string>',
'fobPoint' => '<string>',
'freightTerms' => '<string>',
'incoterms' => '<string>',
'legibilityReasoning' => '<string>',
'legibilityScore' => '<unknown>',
'miscChargeAmount' => 123,
'notes' => '<string>',
'paymentTermsDescription' => '<string>',
'paymentTermsDiscountDays' => 123,
'paymentTermsDiscountPercent' => '<unknown>',
'paymentTermsNetDays' => 123,
'pickupDate' => '2023-12-25',
'poDate' => '2023-12-25',
'poNumber' => '<string>',
'poType' => '<string>',
'projectNumber' => '<string>',
'referenceNumbers' => '<unknown>',
'releaseNumber' => '<string>',
'requestedDeliveryDate' => '2023-12-25',
'requestedShipDate' => '2023-12-25',
'requesterName' => '<string>',
'requisitionNumber' => '<string>',
'revisionDate' => '2023-12-25',
'revisionNumber' => '<string>',
'shipToCode' => '<string>',
'shipVia' => '<string>',
'specialInstructions' => '<string>',
'subtotalAmount' => 123,
'taxAmount' => 123,
'totalAmount' => 123,
'totalQuantity' => '<unknown>',
'totalVolume' => '<unknown>',
'totalWeight' => '<unknown>',
'vendorInstructions' => '<string>',
'vendorNumber' => '<string>',
'weightUnit' => '<string>'
]
]),
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/purchase-orders/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"input\": {\n \"buyerContactName\": \"<string>\",\n \"buyerEmail\": \"<string>\",\n \"buyerName\": \"<string>\",\n \"buyerPhone\": \"<string>\",\n \"cancelAfterDate\": \"2023-12-25\",\n \"confirmToEmail\": \"<string>\",\n \"contractNumber\": \"<string>\",\n \"customerAccountNumber\": \"<string>\",\n \"department\": \"<string>\",\n \"fobPoint\": \"<string>\",\n \"freightTerms\": \"<string>\",\n \"incoterms\": \"<string>\",\n \"legibilityReasoning\": \"<string>\",\n \"legibilityScore\": \"<unknown>\",\n \"miscChargeAmount\": 123,\n \"notes\": \"<string>\",\n \"paymentTermsDescription\": \"<string>\",\n \"paymentTermsDiscountDays\": 123,\n \"paymentTermsDiscountPercent\": \"<unknown>\",\n \"paymentTermsNetDays\": 123,\n \"pickupDate\": \"2023-12-25\",\n \"poDate\": \"2023-12-25\",\n \"poNumber\": \"<string>\",\n \"poType\": \"<string>\",\n \"projectNumber\": \"<string>\",\n \"referenceNumbers\": \"<unknown>\",\n \"releaseNumber\": \"<string>\",\n \"requestedDeliveryDate\": \"2023-12-25\",\n \"requestedShipDate\": \"2023-12-25\",\n \"requesterName\": \"<string>\",\n \"requisitionNumber\": \"<string>\",\n \"revisionDate\": \"2023-12-25\",\n \"revisionNumber\": \"<string>\",\n \"shipToCode\": \"<string>\",\n \"shipVia\": \"<string>\",\n \"specialInstructions\": \"<string>\",\n \"subtotalAmount\": 123,\n \"taxAmount\": 123,\n \"totalAmount\": 123,\n \"totalQuantity\": \"<unknown>\",\n \"totalVolume\": \"<unknown>\",\n \"totalWeight\": \"<unknown>\",\n \"vendorInstructions\": \"<string>\",\n \"vendorNumber\": \"<string>\",\n \"weightUnit\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.upwell.com/api/rest/purchase-orders/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"input\": {\n \"buyerContactName\": \"<string>\",\n \"buyerEmail\": \"<string>\",\n \"buyerName\": \"<string>\",\n \"buyerPhone\": \"<string>\",\n \"cancelAfterDate\": \"2023-12-25\",\n \"confirmToEmail\": \"<string>\",\n \"contractNumber\": \"<string>\",\n \"customerAccountNumber\": \"<string>\",\n \"department\": \"<string>\",\n \"fobPoint\": \"<string>\",\n \"freightTerms\": \"<string>\",\n \"incoterms\": \"<string>\",\n \"legibilityReasoning\": \"<string>\",\n \"legibilityScore\": \"<unknown>\",\n \"miscChargeAmount\": 123,\n \"notes\": \"<string>\",\n \"paymentTermsDescription\": \"<string>\",\n \"paymentTermsDiscountDays\": 123,\n \"paymentTermsDiscountPercent\": \"<unknown>\",\n \"paymentTermsNetDays\": 123,\n \"pickupDate\": \"2023-12-25\",\n \"poDate\": \"2023-12-25\",\n \"poNumber\": \"<string>\",\n \"poType\": \"<string>\",\n \"projectNumber\": \"<string>\",\n \"referenceNumbers\": \"<unknown>\",\n \"releaseNumber\": \"<string>\",\n \"requestedDeliveryDate\": \"2023-12-25\",\n \"requestedShipDate\": \"2023-12-25\",\n \"requesterName\": \"<string>\",\n \"requisitionNumber\": \"<string>\",\n \"revisionDate\": \"2023-12-25\",\n \"revisionNumber\": \"<string>\",\n \"shipToCode\": \"<string>\",\n \"shipVia\": \"<string>\",\n \"specialInstructions\": \"<string>\",\n \"subtotalAmount\": 123,\n \"taxAmount\": 123,\n \"totalAmount\": 123,\n \"totalQuantity\": \"<unknown>\",\n \"totalVolume\": \"<unknown>\",\n \"totalWeight\": \"<unknown>\",\n \"vendorInstructions\": \"<string>\",\n \"vendorNumber\": \"<string>\",\n \"weightUnit\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/purchase-orders/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"input\": {\n \"buyerContactName\": \"<string>\",\n \"buyerEmail\": \"<string>\",\n \"buyerName\": \"<string>\",\n \"buyerPhone\": \"<string>\",\n \"cancelAfterDate\": \"2023-12-25\",\n \"confirmToEmail\": \"<string>\",\n \"contractNumber\": \"<string>\",\n \"customerAccountNumber\": \"<string>\",\n \"department\": \"<string>\",\n \"fobPoint\": \"<string>\",\n \"freightTerms\": \"<string>\",\n \"incoterms\": \"<string>\",\n \"legibilityReasoning\": \"<string>\",\n \"legibilityScore\": \"<unknown>\",\n \"miscChargeAmount\": 123,\n \"notes\": \"<string>\",\n \"paymentTermsDescription\": \"<string>\",\n \"paymentTermsDiscountDays\": 123,\n \"paymentTermsDiscountPercent\": \"<unknown>\",\n \"paymentTermsNetDays\": 123,\n \"pickupDate\": \"2023-12-25\",\n \"poDate\": \"2023-12-25\",\n \"poNumber\": \"<string>\",\n \"poType\": \"<string>\",\n \"projectNumber\": \"<string>\",\n \"referenceNumbers\": \"<unknown>\",\n \"releaseNumber\": \"<string>\",\n \"requestedDeliveryDate\": \"2023-12-25\",\n \"requestedShipDate\": \"2023-12-25\",\n \"requesterName\": \"<string>\",\n \"requisitionNumber\": \"<string>\",\n \"revisionDate\": \"2023-12-25\",\n \"revisionNumber\": \"<string>\",\n \"shipToCode\": \"<string>\",\n \"shipVia\": \"<string>\",\n \"specialInstructions\": \"<string>\",\n \"subtotalAmount\": 123,\n \"taxAmount\": 123,\n \"totalAmount\": 123,\n \"totalQuantity\": \"<unknown>\",\n \"totalVolume\": \"<unknown>\",\n \"totalWeight\": \"<unknown>\",\n \"vendorInstructions\": \"<string>\",\n \"vendorNumber\": \"<string>\",\n \"weightUnit\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"updatePurchaseOrder": {
"id": "<string>"
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}Authorizations
Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.
Path Parameters
"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
Response
Responses for PATCH /api/rest/purchase-orders/{id}
Purchase Order supporting document - parsed data from PURCHASE_ORDER documents (inbound POs from the tenant's customers), modeled for EDI 850-series generation
Show child attributes
Show child attributes
⌘I