Documents

Get a document

get/brands/{brand}/documents/{id}

Request

  • Base URL: https://app.amber.ai/api/public/v1
  • URL: https://app.amber.ai/api/public/v1/brands/{brand}/documents/{id}
  • Auth: HTTP bearer

Path parameters

brandstring required
Example:acme

Brand slug authorized by this API key.

idstring required

Document ID returned by the list endpoint. Keep the entire value, including any prefix.

Query parameters

subjectKind'ORDER' | 'SHIPMENT' | 'PAYMENT' | 'PRODUCT' | 'PRODUCT_OPTION' | 'PRODUCT_VERSION' | 'SKU' | 'SAMPLE' | 'SAMPLE_ROUND' | 'QUOTE' | 'QUOTE_NOTE' | 'MATERIAL' | 'BOM_COMPONENT' | 'MEASUREMENT_TABLE' | 'PARTNER' | 'BRAND'
subjectKeystring
documentTypeIdstring
includeSuperseded'true' | 'false'

Response

The requested record.

idstring required
ownerTypestring required
ownerIdstring required
visibilitystring required
documentTypeIdstring nullable required
dataValuestring nullable required
fileNamestring nullable required
mimeTypestring nullable required
fileSizeBytesnumber nullable required
channelstring required
sourcestring nullable required
supersededByDocumentIdstring nullable required
supersededAtstring nullable required
supersededReasonstring nullable required
senderRolestring nullable required
issuerNamestring nullable required
extentSchema0 required(unresolved $ref)
createdAtstring required
updatedAtstring required
deletedAtstring nullable required
subjectKindstring nullable required
subjectKeystring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.