> ## Documentation Index
> Fetch the complete documentation index at: https://docs.api.onechain-tms.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Fetch a document
> Fetch a document givent its id
## OpenAPI
````yaml openapi.json get /v1/documents/{id}
openapi: 3.1.0
info:
title: OneChain API
version: 1.3.2
x-logo:
href: https://www.onechain-tms.com
url: static/logo.png
servers:
- url: localhost:8080
security: []
tags:
- description: |-
This API lets you fetch your data from ONECHAIN's servers.
URL: https://api.onechain-tms.com
name: Introduction
x-displayName: Introduction
- description: >-
To safely access the resources exposed by our API, you will need to
provide an authenticated token in your requests headers. Please reach out
to your ONECHAIN’s Account Manager to get your token.
| Name of the header | Type of authentication |
|--------------------|------------------------|
| Authorization | API AUTHORIZATION KEY |
Please note that the API authorization key must be prefixed with "Bearer "
For example:
`Authorization: Bearer 1234567890`
name: Authentication
x-displayName: Authentication
- description: |-
All endpoints fetching multiple items are paginated.
Use `skip` to skip to the items you want to retrieve.
Use `take` to define how many items you want to retrieve.
`skip` and `take` are optional parameters.
If you do not input them, `skip` equals to 0 and `take` equals to 10.
Example:
`/v1/shipments?skip=20&take=10`
name: Pagination
x-displayName: Pagination
- name: Shipments
- name: Purchase Orders
- name: Documents
- name: Locations
- name: Invoices
- name: Users
- name: Reporting
- description:
name: ShipmentObject
x-displayName: ShipmentObject
- description:
name: TrackingObject
x-displayName: TrackingObject
- description:
name: OrderPreparationObject
x-displayName: OrderPreparationObject
- description:
name: PurchaseOrderObject
x-displayName: PurchaseOrderObject
- description:
name: TrackingEventObject
x-displayName: TrackingEventObject
- description:
name: TrackingDateObject
x-displayName: TrackingDateObject
- description:
name: TrackingStepObject
x-displayName: TrackingStepObject
- description:
name: ProductObject
x-displayName: ProductObject
- description:
name: PortObject
x-displayName: PortObject
- description:
name: CoordinatesObject
x-displayName: CoordinatesObject
- description:
name: ContainerObject
x-displayName: ContainerObject
- description:
name: UserObject
x-displayName: UserObject
- description:
name: LoadObject
x-displayName: LoadObject
- description:
name: DocumentObject
x-displayName: DocumentObject
- description:
name: InvoiceObject
x-displayName: InvoiceObject
- description:
name: LocationObject
x-displayName: LocationObject
- description:
name: PriceObject
x-displayName: PriceObject
- description:
name: QuantityObject
x-displayName: QuantityObject
- description:
name: SizeObject
x-displayName: SizeObject
- description:
name: VolumeObject
x-displayName: VolumeObject
- description:
name: WeightObject
x-displayName: WeightObject
- description:
name: SimpleDateObject
x-displayName: SimpleDateObject
- description:
name: DateWithTimeObject
x-displayName: DateWithTimeObject
paths:
/v1/documents/{id}:
get:
tags:
- Documents
summary: Fetch a document
description: Fetch a document givent its id
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Fetch a document given its id
content:
application/json:
schema:
$ref: '#/components/schemas/Document'
description: Fetch a document given its id
'404':
description: Document not found
content:
application/json:
schema:
description: Document not found
type: object
components:
schemas:
Document:
type: object
modelName: Document
properties:
id:
type: string
example: '12345'
name:
type: string
example: packing-list-export.pdf
type:
type: string
enum:
- null
- packing_list
- commercial_invoice
- master_bill_of_lading
- house_bill_of_lading
- master_airway_bill
- house_airway_bill
- proof_of_delivery
- dangerous_goods_declaration
- material_safety_data_sheet
- exa
- cmr
- ima
- power_of_attorney_customs_declaration
- power_of_attorney_eur1
- eur1
- entry_summary
- t1
- cargo_manifest
- cargo_screening
- lithium_certificate
- carta_de_plastico
- levante
- ddi
- dde
- pickup_form
onechain_shipment_id:
type: string
example: CDEF
link:
type: string
size:
type: integer
example: 20000
uploaded_at:
$ref: '#/components/schemas/SimpleDate'
SimpleDate:
modelName: SimpleDate
type: string
example: '2021-10-11'
````