Adds a document to the specified shipment. Please read desription for full instructions

post

https://production.embedded.chain.io/shipment/{shipment_id}/document/

Adds a document to the given shipment. Before using this endpoint, a document has to be uploaded using /document-upload-url endpoint to get the upload_identifier token (example, looks like aSwe123Uis). Now using this upload identifier, the document can be linked to the shipment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

shipment_id

string

required

length ≤ 100

^[A-Za-z0-9\.\_\-]*$

Unique ID of the shipment in the remote system used for lookup purposes.

Body Params

Add a document to the specified shipment ID
Please use the document-upload-url endpoint to upload the actual document to get the upload identifier.
Do not attach your file to the body of this request.

document_sensitivity

string

enum

Defaults to private

specifies if document is public or private.

Allowed:

file_name

string

required

Name of file.

created_at

date-time

timestamp of when the file was created.

document_type_code

string

required

A short code representing the logical type of document.

upload_identifier

string

required

unique token used to refer to the uploaded file in the future

Headers

X-Client-Request-Id

string

length ≤ 100

^[A-Za-z0-9\.\_\-]*$

An optional unique id set by the client for an api request. This can be use to identify a request when communicating with Chain.io support.

Responses

200

Blank response if document attached successfully.

400Given upload_identifier not found, make sure file is uploaded at /document-upload-url