Create StockDocument - Cofactr Platform API

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Body Params multipart/form-data

stock_lot_ids

array[string]

required

List of StockLot UUID strings

Example:

[""]

document

file

required

document_type

enum<string>

required

Allowed values:

inspection_photoinspection_photo_bulkpackage_photox_rayx_ray_bulkdocumentreportquotepacking_slipc_of_cpurchase_updatepurchase_confirmationinvoiceship_notificationpurchase_orderrfqfile

metadata

string

optional

Stringified JSON object

Example:

"{\"field1\": \"value1\"}"

notes

string

optional

needs_review

boolean

optional

purchase_order_id

string

optional

UUID of a valid Purchase

document_extractor_id

string

optional

UUID of a valid DocumentExtractor (Used for AI Driven Document Parsing)

parsed_data

string

optional

Stringified JSON object (Used for AI Driven Document Parsing)

Example:

"{\"field1\": \"value1\"}"

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/v1/stock_documents/' \
--header 'Authorization;' \
--form 'stock_lot_ids=""' \
--form 'document=@""' \
--form 'document_type=""' \
--form 'metadata="\"{\\\"field1\\\": \\\"value1\\\"}\""' \
--form 'notes=""' \
--form 'needs_review=""' \
--form 'purchase_order_id=""' \
--form 'document_extractor_id=""' \
--form 'parsed_data="\"{\\\"field1\\\": \\\"value1\\\"}\""'

Responses

🟢200Success

application/json

Body

id

string <uuid>

required

metadata

object

optional

synced_from_integration

boolean

required

synced_from_integration_at

string <date-time>

required

integration_source_name

string

required

integration_record_id

string

required

notes

string

required

org_id

string <uuid>

required

document

string <uri>

required

parsed_data

object

required

needs_review

boolean

required

document_type

enum<string>

required

Allowed values:

inspection_photoinspection_photo_bulkpackage_photox_rayx_ray_bulkdocumentreportquotepacking_slipc_of_cpurchase_updatepurchase_confirmationinvoiceship_notificationpurchase_orderrfqfile

purchase_order_id

string <uuid>

required

document_extractor_id

string <uuid>

required

stock_lots

array[string <uuid>]

required

Example

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "metadata": {},
  "synced_from_integration": true,
  "synced_from_integration_at": "2019-08-24T14:15:22Z",
  "integration_source_name": "string",
  "integration_record_id": "string",
  "notes": "string",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "document": "http://example.com",
  "parsed_data": {},
  "needs_review": true,
  "document_type": "inspection_photo",
  "purchase_order_id": "21637704-484e-4c9d-a7ca-e34984d27d80",
  "document_extractor_id": "a8e15a72-f6df-43a2-ae41-9e1e715b55d7",
  "stock_lots": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}