cURL
curl --request PUT \
--url https://app.stockshift.io/api/v1/sales/customers/{customer}/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"templates": {
"quote": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"packing_slip": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"certificate_of_conformance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"certificate_of_analysis": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
'import requests
url = "https://app.stockshift.io/api/v1/sales/customers/{customer}/documents"
payload = { "templates": {
"quote": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"packing_slip": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"certificate_of_conformance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"certificate_of_analysis": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/sales/customers/{customer}/documents",
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([
'templates' => [
'quote' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'invoice' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'packing_slip' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'certificate_of_conformance' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'certificate_of_analysis' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
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://app.stockshift.io/api/v1/sales/customers/{customer}/documents"
payload := strings.NewReader("{\n \"templates\": {\n \"quote\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"invoice\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"packing_slip\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"certificate_of_conformance\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"certificate_of_analysis\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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))
}{
"data": {
"locale": "<string>",
"templates": {}
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}Customers
Set a customer's document language and templates
The language its documents print and are emailed in, and the template
of each document type it uses where not the default. Audited. Needs
the sales.customers.manage permission and a token with sales:write.
PUT
/
sales
/
customers
/
{customer}
/
documents
cURL
curl --request PUT \
--url https://app.stockshift.io/api/v1/sales/customers/{customer}/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"templates": {
"quote": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"packing_slip": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"certificate_of_conformance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"certificate_of_analysis": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
'import requests
url = "https://app.stockshift.io/api/v1/sales/customers/{customer}/documents"
payload = { "templates": {
"quote": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"packing_slip": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"certificate_of_conformance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"certificate_of_analysis": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/sales/customers/{customer}/documents",
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([
'templates' => [
'quote' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'invoice' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'packing_slip' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'certificate_of_conformance' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'certificate_of_analysis' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
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://app.stockshift.io/api/v1/sales/customers/{customer}/documents"
payload := strings.NewReader("{\n \"templates\": {\n \"quote\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"invoice\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"packing_slip\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"certificate_of_conformance\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"certificate_of_analysis\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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))
}{
"data": {
"locale": "<string>",
"templates": {}
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}Authorizations
apiKeyoauth2
For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.
Path Parameters
Body
application/json
The language and templates a customer's documents use.
The template of each document type (quote, invoice, packing_slip, certificate_of_conformance or certificate_of_analysis) where the customer uses one other than the default.
Show child attributes
Show child attributes
en, es or fr-CA. Null prints in the organization's document language.
Available options:
en, es, fr-CA, null Response
CustomerDocumentsResource
Show child attributes
Show child attributes
Was this page helpful?