Skip to main content
POST
/
purchase-orders
/
{id}
/
send-to-vendor
Email a purchase order to the vendor (first send or revision send)
curl --request POST \
  --url https://api.arcuserp.com/v1/purchase-orders/{id}/send-to-vendor \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to_email": "jsmith@example.com",
  "stamp_only": false,
  "template_key_override": "po_revised",
  "revision_number": 123,
  "changed_fields": "<string>"
}
'
import requests

url = "https://api.arcuserp.com/v1/purchase-orders/{id}/send-to-vendor"

payload = {
"to_email": "jsmith@example.com",
"stamp_only": False,
"template_key_override": "po_revised",
"revision_number": 123,
"changed_fields": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to_email: 'jsmith@example.com',
stamp_only: false,
template_key_override: 'po_revised',
revision_number: 123,
changed_fields: '<string>'
})
};

fetch('https://api.arcuserp.com/v1/purchase-orders/{id}/send-to-vendor', 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.arcuserp.com/v1/purchase-orders/{id}/send-to-vendor",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'to_email' => 'jsmith@example.com',
'stamp_only' => false,
'template_key_override' => 'po_revised',
'revision_number' => 123,
'changed_fields' => '<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://api.arcuserp.com/v1/purchase-orders/{id}/send-to-vendor"

payload := strings.NewReader("{\n \"to_email\": \"jsmith@example.com\",\n \"stamp_only\": false,\n \"template_key_override\": \"po_revised\",\n \"revision_number\": 123,\n \"changed_fields\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", 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.post("https://api.arcuserp.com/v1/purchase-orders/{id}/send-to-vendor")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to_email\": \"jsmith@example.com\",\n \"stamp_only\": false,\n \"template_key_override\": \"po_revised\",\n \"revision_number\": 123,\n \"changed_fields\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/purchase-orders/{id}/send-to-vendor")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to_email\": \"jsmith@example.com\",\n \"stamp_only\": false,\n \"template_key_override\": \"po_revised\",\n \"revision_number\": 123,\n \"changed_fields\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "po_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "po_number": "<string>",
  "sent_to": "jsmith@example.com",
  "sent_at": "2023-11-07T05:31:56Z",
  "revision_send": true,
  "revision_number": 123
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
"<unknown>"
"<unknown>"

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key
string

Optional idempotency key for safe retries (Stripe-style).

Maximum string length: 255

Path Parameters

id
string<uuid>
required

Body

application/json
to_email
string<email>

Override the destination email. When omitted, defaults to the vendor account's email. Required (either here or on the vendor) unless stamp_only=true.

stamp_only
boolean
default:false

When true, stamps sent_at + last_notified_revision without dispatching an email (the email has already been sent through a separate path). Skips the to_email / vendor-email guard.

template_key_override
enum<string>

When set to po_revised, uses the revision-send template instead of the default purchase-order template. Combine with revision_number and changed_fields for context.

Available options:
po_revised
revision_number
integer

The revision number being sent (e.g. 2 for the second send after the initial first-send 1). Used only when template_key_override='po_revised'.

changed_fields
string

Human-readable summary of what changed between revisions (e.g. "line quantity, due date"). Rendered in the revision email template. Used only when template_key_override='po_revised'.

Response

Purchase order sent (or stamped). Returns the canonical send result.

po_id
string<uuid>
po_number
string
sent_to
string<email>
sent_at
string<date-time>
revision_send
boolean

Present and true only when template_key_override='po_revised'.

revision_number
integer

Echoes the request body when this was a revision send.