Get a document

curl --request GET \
  --url https://app.amber.ai/api/public/v1/brands/{brand}/documents/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.amber.ai/api/public/v1/brands/{brand}/documents/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.amber.ai/api/public/v1/brands/{brand}/documents/{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://app.amber.ai/api/public/v1/brands/{brand}/documents/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.amber.ai/api/public/v1/brands/{brand}/documents/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.amber.ai/api/public/v1/brands/{brand}/documents/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "subjects": [
    {
      "subjectKind": "<string>",
      "subjectKey": "<string>",
      "establishedAs": "<string>",
      "subjectLabel": "<string>"
    }
  ],
  "id": "<string>",
  "ownerType": "<string>",
  "ownerId": "<string>",
  "visibility": "<string>",
  "documentTypeId": "<string>",
  "dataValue": "<string>",
  "fileName": "<string>",
  "mimeType": "<string>",
  "fileSizeBytes": 123,
  "channel": "<string>",
  "source": "<string>",
  "supersededByDocumentId": "<string>",
  "supersededAt": "<string>",
  "supersededReason": "<string>",
  "senderRole": "<string>",
  "issuerName": "<string>",
  "extent": "<unknown>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deletedAt": "<string>",
  "subjectKind": "<string>",
  "subjectKey": "<string>"
}

{
  "error": "<string>",
  "errorCode": "<string>",
  "details": "<unknown>"
}

{
  "error": "<string>",
  "errorCode": "<string>",
  "details": "<unknown>"
}

{
  "error": "<string>",
  "errorCode": "<string>",
  "details": "<unknown>"
}

{
  "error": "<string>",
  "errorCode": "<string>",
  "details": "<unknown>"
}

{
  "error": "<string>",
  "errorCode": "<string>",
  "details": "<unknown>"
}

GET

brands

{brand}

documents

{id}

Get a document

curl --request GET \
  --url https://app.amber.ai/api/public/v1/brands/{brand}/documents/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.amber.ai/api/public/v1/brands/{brand}/documents/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.amber.ai/api/public/v1/brands/{brand}/documents/{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://app.amber.ai/api/public/v1/brands/{brand}/documents/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.amber.ai/api/public/v1/brands/{brand}/documents/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.amber.ai/api/public/v1/brands/{brand}/documents/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "subjects": [
    {
      "subjectKind": "<string>",
      "subjectKey": "<string>",
      "establishedAs": "<string>",
      "subjectLabel": "<string>"
    }
  ],
  "id": "<string>",
  "ownerType": "<string>",
  "ownerId": "<string>",
  "visibility": "<string>",
  "documentTypeId": "<string>",
  "dataValue": "<string>",
  "fileName": "<string>",
  "mimeType": "<string>",
  "fileSizeBytes": 123,
  "channel": "<string>",
  "source": "<string>",
  "supersededByDocumentId": "<string>",
  "supersededAt": "<string>",
  "supersededReason": "<string>",
  "senderRole": "<string>",
  "issuerName": "<string>",
  "extent": "<unknown>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deletedAt": "<string>",
  "subjectKind": "<string>",
  "subjectKey": "<string>"
}

{
  "error": "<string>",
  "errorCode": "<string>",
  "details": "<unknown>"
}

{
  "error": "<string>",
  "errorCode": "<string>",
  "details": "<unknown>"
}

{
  "error": "<string>",
  "errorCode": "<string>",
  "details": "<unknown>"
}

{
  "error": "<string>",
  "errorCode": "<string>",
  "details": "<unknown>"
}

{
  "error": "<string>",
  "errorCode": "<string>",
  "details": "<unknown>"
}

Authorizations

Authorization

string

header

required

A brand-scoped or global amb_sk_... API key.

Path Parameters

brand

string

required

Brand slug authorized by this API key.

Example:

"acme"

string

required

Document UUID or opaque legacy:... identifier.

Query Parameters

subjectKind

enum<string>

Available options:

ORDER,

SHIPMENT,

PAYMENT,

PRODUCT,

PRODUCT_OPTION,

PRODUCT_VERSION,

SKU,

SAMPLE,

SAMPLE_ROUND,

QUOTE,

QUOTE_NOTE,

MATERIAL,

BOM_COMPONENT,

MEASUREMENT_TABLE,

PARTNER,

BRAND

subjectKey

string

Required string length: 1 - 255

documentTypeId

string

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

includeSuperseded

enum<string>

Available options:

true,

false

Response

Visible entity.

subjects

object[]

required

Show child attributes

string

required

ownerType

string

required

ownerId

string

required

visibility

string

required

documentTypeId

string | null

required

dataValue

string | null

required

fileName

string | null

required

mimeType

string | null

required

fileSizeBytes

number | null

required

channel

string

required

source

string | null

required

supersededByDocumentId

string | null

required

supersededAt

string | null

required

supersededReason

string | null

required

senderRole

string | null

required

issuerName

string | null

required

extent

any | null

required

createdAt

string

required

updatedAt

string

required

deletedAt

string | null

required

subjectKind

string | null

required

subjectKey

string | null

required