Sales orders
Update a draft sales order
PUT
/
api
/
v1
/
sales-orders
/
{id}
Update a draft sales order
curl --request PUT \
--url https://sherpa-topaz.vercel.app/api/v1/sales-orders/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customerNumber": "<string>",
"name": "<string>"
},
"lines": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lineNumber": 123,
"description": "<string>",
"qtyOrdered": 123,
"qtyFulfilled": 123,
"unitPrice": 123,
"lineTotal": 123,
"procurementMode": "<string>",
"item": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sku": "<string>",
"name": "<string>"
},
"uom": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>"
}
}
],
"warehouse": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>"
},
"orderDate": "2023-12-25",
"channel": "<string>",
"notes": "<string>",
"externalId": "<string>",
"shipTo": {
"addressId": "<string>",
"contactName": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"email": "<string>",
"phone": "<string>"
},
"billTo": {
"addressId": "<string>",
"contactName": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"email": "<string>",
"phone": "<string>"
}
}
}
'import requests
url = "https://sherpa-topaz.vercel.app/api/v1/sales-orders/{id}"
payload = { "data": {
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customerNumber": "<string>",
"name": "<string>"
},
"lines": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lineNumber": 123,
"description": "<string>",
"qtyOrdered": 123,
"qtyFulfilled": 123,
"unitPrice": 123,
"lineTotal": 123,
"procurementMode": "<string>",
"item": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sku": "<string>",
"name": "<string>"
},
"uom": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>"
}
}
],
"warehouse": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>"
},
"orderDate": "2023-12-25",
"channel": "<string>",
"notes": "<string>",
"externalId": "<string>",
"shipTo": {
"addressId": "<string>",
"contactName": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"email": "<string>",
"phone": "<string>"
},
"billTo": {
"addressId": "<string>",
"contactName": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"email": "<string>",
"phone": "<string>"
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
customer: {
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
customerNumber: '<string>',
name: '<string>'
},
lines: [
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
lineNumber: 123,
description: '<string>',
qtyOrdered: 123,
qtyFulfilled: 123,
unitPrice: 123,
lineTotal: 123,
procurementMode: '<string>',
item: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', sku: '<string>', name: '<string>'},
uom: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', code: '<string>', name: '<string>'}
}
],
warehouse: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', code: '<string>', name: '<string>'},
orderDate: '2023-12-25',
channel: '<string>',
notes: '<string>',
externalId: '<string>',
shipTo: {
addressId: '<string>',
contactName: '<string>',
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>',
email: '<string>',
phone: '<string>'
},
billTo: {
addressId: '<string>',
contactName: '<string>',
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>',
email: '<string>',
phone: '<string>'
}
}
})
};
fetch('https://sherpa-topaz.vercel.app/api/v1/sales-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://sherpa-topaz.vercel.app/api/v1/sales-orders/{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([
'data' => [
'customer' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'customerNumber' => '<string>',
'name' => '<string>'
],
'lines' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'lineNumber' => 123,
'description' => '<string>',
'qtyOrdered' => 123,
'qtyFulfilled' => 123,
'unitPrice' => 123,
'lineTotal' => 123,
'procurementMode' => '<string>',
'item' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sku' => '<string>',
'name' => '<string>'
],
'uom' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'code' => '<string>',
'name' => '<string>'
]
]
],
'warehouse' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'code' => '<string>',
'name' => '<string>'
],
'orderDate' => '2023-12-25',
'channel' => '<string>',
'notes' => '<string>',
'externalId' => '<string>',
'shipTo' => [
'addressId' => '<string>',
'contactName' => '<string>',
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'email' => '<string>',
'phone' => '<string>'
],
'billTo' => [
'addressId' => '<string>',
'contactName' => '<string>',
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'email' => '<string>',
'phone' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://sherpa-topaz.vercel.app/api/v1/sales-orders/{id}"
payload := strings.NewReader("{\n \"data\": {\n \"customer\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"customerNumber\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"lines\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lineNumber\": 123,\n \"description\": \"<string>\",\n \"qtyOrdered\": 123,\n \"qtyFulfilled\": 123,\n \"unitPrice\": 123,\n \"lineTotal\": 123,\n \"procurementMode\": \"<string>\",\n \"item\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sku\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"uom\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n }\n }\n ],\n \"warehouse\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"orderDate\": \"2023-12-25\",\n \"channel\": \"<string>\",\n \"notes\": \"<string>\",\n \"externalId\": \"<string>\",\n \"shipTo\": {\n \"addressId\": \"<string>\",\n \"contactName\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"billTo\": {\n \"addressId\": \"<string>\",\n \"contactName\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://sherpa-topaz.vercel.app/api/v1/sales-orders/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"customer\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"customerNumber\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"lines\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lineNumber\": 123,\n \"description\": \"<string>\",\n \"qtyOrdered\": 123,\n \"qtyFulfilled\": 123,\n \"unitPrice\": 123,\n \"lineTotal\": 123,\n \"procurementMode\": \"<string>\",\n \"item\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sku\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"uom\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n }\n }\n ],\n \"warehouse\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"orderDate\": \"2023-12-25\",\n \"channel\": \"<string>\",\n \"notes\": \"<string>\",\n \"externalId\": \"<string>\",\n \"shipTo\": {\n \"addressId\": \"<string>\",\n \"contactName\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"billTo\": {\n \"addressId\": \"<string>\",\n \"contactName\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sherpa-topaz.vercel.app/api/v1/sales-orders/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"customer\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"customerNumber\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"lines\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lineNumber\": 123,\n \"description\": \"<string>\",\n \"qtyOrdered\": 123,\n \"qtyFulfilled\": 123,\n \"unitPrice\": 123,\n \"lineTotal\": 123,\n \"procurementMode\": \"<string>\",\n \"item\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sku\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"uom\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n }\n }\n ],\n \"warehouse\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"orderDate\": \"2023-12-25\",\n \"channel\": \"<string>\",\n \"notes\": \"<string>\",\n \"externalId\": \"<string>\",\n \"shipTo\": {\n \"addressId\": \"<string>\",\n \"contactName\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"billTo\": {\n \"addressId\": \"<string>\",\n \"contactName\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderNumber": "<string>",
"orderType": "<string>",
"channel": "<string>",
"fulfillmentMethod": "<string>",
"shippingPolicy": "<string>",
"status": "<string>",
"checkoutPaymentStatus": "<string>",
"orderDate": "2023-12-25",
"currency": "<string>",
"notes": "<string>",
"externalId": "<string>",
"origin": "<string>",
"subtotal": 123,
"discountTotal": 123,
"shippingTotal": 123,
"taxTotal": 123,
"total": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customerNumber": "<string>",
"name": "<string>"
},
"warehouse": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>"
},
"shipTo": {
"addressId": "<string>",
"contactName": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"email": "<string>",
"phone": "<string>"
},
"billTo": {
"addressId": "<string>",
"contactName": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"email": "<string>",
"phone": "<string>"
},
"lines": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lineNumber": 123,
"description": "<string>",
"qtyOrdered": 123,
"qtyFulfilled": 123,
"unitPrice": 123,
"lineTotal": 123,
"procurementMode": "<string>",
"item": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sku": "<string>",
"name": "<string>"
},
"uom": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>"
}
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Create or update payload inside { data }. POST creates a draft. PUT updates an
existing draft only (open or later statuses return 409). Server-owned id,
orderNumber, timestamps, and totals are ignored and recomputed.
On PUT, omitted header fields keep their current values. Omitted lines are
left unchanged.
Show child attributes
Show child attributes
Response
Updated draft sales order (same shape as GET)
Show child attributes
Show child attributes
⌘I
Update a draft sales order
curl --request PUT \
--url https://sherpa-topaz.vercel.app/api/v1/sales-orders/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customerNumber": "<string>",
"name": "<string>"
},
"lines": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lineNumber": 123,
"description": "<string>",
"qtyOrdered": 123,
"qtyFulfilled": 123,
"unitPrice": 123,
"lineTotal": 123,
"procurementMode": "<string>",
"item": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sku": "<string>",
"name": "<string>"
},
"uom": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>"
}
}
],
"warehouse": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>"
},
"orderDate": "2023-12-25",
"channel": "<string>",
"notes": "<string>",
"externalId": "<string>",
"shipTo": {
"addressId": "<string>",
"contactName": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"email": "<string>",
"phone": "<string>"
},
"billTo": {
"addressId": "<string>",
"contactName": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"email": "<string>",
"phone": "<string>"
}
}
}
'import requests
url = "https://sherpa-topaz.vercel.app/api/v1/sales-orders/{id}"
payload = { "data": {
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customerNumber": "<string>",
"name": "<string>"
},
"lines": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lineNumber": 123,
"description": "<string>",
"qtyOrdered": 123,
"qtyFulfilled": 123,
"unitPrice": 123,
"lineTotal": 123,
"procurementMode": "<string>",
"item": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sku": "<string>",
"name": "<string>"
},
"uom": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>"
}
}
],
"warehouse": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>"
},
"orderDate": "2023-12-25",
"channel": "<string>",
"notes": "<string>",
"externalId": "<string>",
"shipTo": {
"addressId": "<string>",
"contactName": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"email": "<string>",
"phone": "<string>"
},
"billTo": {
"addressId": "<string>",
"contactName": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"email": "<string>",
"phone": "<string>"
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
customer: {
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
customerNumber: '<string>',
name: '<string>'
},
lines: [
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
lineNumber: 123,
description: '<string>',
qtyOrdered: 123,
qtyFulfilled: 123,
unitPrice: 123,
lineTotal: 123,
procurementMode: '<string>',
item: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', sku: '<string>', name: '<string>'},
uom: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', code: '<string>', name: '<string>'}
}
],
warehouse: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', code: '<string>', name: '<string>'},
orderDate: '2023-12-25',
channel: '<string>',
notes: '<string>',
externalId: '<string>',
shipTo: {
addressId: '<string>',
contactName: '<string>',
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>',
email: '<string>',
phone: '<string>'
},
billTo: {
addressId: '<string>',
contactName: '<string>',
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>',
email: '<string>',
phone: '<string>'
}
}
})
};
fetch('https://sherpa-topaz.vercel.app/api/v1/sales-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://sherpa-topaz.vercel.app/api/v1/sales-orders/{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([
'data' => [
'customer' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'customerNumber' => '<string>',
'name' => '<string>'
],
'lines' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'lineNumber' => 123,
'description' => '<string>',
'qtyOrdered' => 123,
'qtyFulfilled' => 123,
'unitPrice' => 123,
'lineTotal' => 123,
'procurementMode' => '<string>',
'item' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sku' => '<string>',
'name' => '<string>'
],
'uom' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'code' => '<string>',
'name' => '<string>'
]
]
],
'warehouse' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'code' => '<string>',
'name' => '<string>'
],
'orderDate' => '2023-12-25',
'channel' => '<string>',
'notes' => '<string>',
'externalId' => '<string>',
'shipTo' => [
'addressId' => '<string>',
'contactName' => '<string>',
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'email' => '<string>',
'phone' => '<string>'
],
'billTo' => [
'addressId' => '<string>',
'contactName' => '<string>',
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'email' => '<string>',
'phone' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://sherpa-topaz.vercel.app/api/v1/sales-orders/{id}"
payload := strings.NewReader("{\n \"data\": {\n \"customer\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"customerNumber\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"lines\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lineNumber\": 123,\n \"description\": \"<string>\",\n \"qtyOrdered\": 123,\n \"qtyFulfilled\": 123,\n \"unitPrice\": 123,\n \"lineTotal\": 123,\n \"procurementMode\": \"<string>\",\n \"item\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sku\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"uom\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n }\n }\n ],\n \"warehouse\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"orderDate\": \"2023-12-25\",\n \"channel\": \"<string>\",\n \"notes\": \"<string>\",\n \"externalId\": \"<string>\",\n \"shipTo\": {\n \"addressId\": \"<string>\",\n \"contactName\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"billTo\": {\n \"addressId\": \"<string>\",\n \"contactName\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://sherpa-topaz.vercel.app/api/v1/sales-orders/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"customer\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"customerNumber\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"lines\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lineNumber\": 123,\n \"description\": \"<string>\",\n \"qtyOrdered\": 123,\n \"qtyFulfilled\": 123,\n \"unitPrice\": 123,\n \"lineTotal\": 123,\n \"procurementMode\": \"<string>\",\n \"item\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sku\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"uom\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n }\n }\n ],\n \"warehouse\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"orderDate\": \"2023-12-25\",\n \"channel\": \"<string>\",\n \"notes\": \"<string>\",\n \"externalId\": \"<string>\",\n \"shipTo\": {\n \"addressId\": \"<string>\",\n \"contactName\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"billTo\": {\n \"addressId\": \"<string>\",\n \"contactName\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sherpa-topaz.vercel.app/api/v1/sales-orders/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"customer\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"customerNumber\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"lines\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lineNumber\": 123,\n \"description\": \"<string>\",\n \"qtyOrdered\": 123,\n \"qtyFulfilled\": 123,\n \"unitPrice\": 123,\n \"lineTotal\": 123,\n \"procurementMode\": \"<string>\",\n \"item\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sku\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"uom\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n }\n }\n ],\n \"warehouse\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"orderDate\": \"2023-12-25\",\n \"channel\": \"<string>\",\n \"notes\": \"<string>\",\n \"externalId\": \"<string>\",\n \"shipTo\": {\n \"addressId\": \"<string>\",\n \"contactName\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"billTo\": {\n \"addressId\": \"<string>\",\n \"contactName\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderNumber": "<string>",
"orderType": "<string>",
"channel": "<string>",
"fulfillmentMethod": "<string>",
"shippingPolicy": "<string>",
"status": "<string>",
"checkoutPaymentStatus": "<string>",
"orderDate": "2023-12-25",
"currency": "<string>",
"notes": "<string>",
"externalId": "<string>",
"origin": "<string>",
"subtotal": 123,
"discountTotal": 123,
"shippingTotal": 123,
"taxTotal": 123,
"total": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customerNumber": "<string>",
"name": "<string>"
},
"warehouse": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>"
},
"shipTo": {
"addressId": "<string>",
"contactName": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"email": "<string>",
"phone": "<string>"
},
"billTo": {
"addressId": "<string>",
"contactName": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"email": "<string>",
"phone": "<string>"
},
"lines": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lineNumber": 123,
"description": "<string>",
"qtyOrdered": 123,
"qtyFulfilled": 123,
"unitPrice": 123,
"lineTotal": 123,
"procurementMode": "<string>",
"item": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sku": "<string>",
"name": "<string>"
},
"uom": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>"
}
}
]
}
}
