> ## 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.
# Create a purchase order
> Create a purchase order with the information provided
## OpenAPI
````yaml openapi.json post /v1/purchaseOrders
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/purchaseOrders:
post:
tags:
- Purchase Orders
summary: Create a purchase order
description: Create a purchase order with the information provided
requestBody:
content:
application/json:
schema:
properties:
custom_parameters:
items:
type: object
properties:
name:
type: string
example: parameter1
value:
type: string
example: value1
type: array
desired_delivery_date:
$ref: '#/components/schemas/SimpleDate'
desired_ex_factory_date:
$ref: '#/components/schemas/SimpleDate'
product_lines:
items:
properties:
ordered_quantity:
example: 24
type: number
product:
$ref: '#/components/schemas/Product'
reference:
example: 'Delivery #1'
type: string
unit_price:
$ref: '#/components/schemas/Price'
volume:
example: 15
type: number
volume_unit:
type: string
example: m3
required:
- product
- ordered_quantity
type: object
type: array
reference:
type: string
example: PO5792303
supplier_id:
example: Detroit Factory
type: string
required:
- reference
- supplier_id
- product_lines
type: object
required: true
responses:
'201':
description: Purchase order created
content:
application/json:
schema:
description: Purchase order created
properties:
reference:
type: string
type: object
'400':
description: Bad request
content:
application/json:
schema:
description: Bad request
type: object
components:
schemas:
SimpleDate:
modelName: SimpleDate
type: string
example: '2021-10-11'
Product:
type: object
required:
- sku
modelName: Product
properties:
sku:
type: string
example: REF0123458
hs_code:
type: string
example: '96032930'
description:
type: string
example: blue shirt with a T shape
is_hazardous:
type: boolean
default: 'false'
hazardous_description:
type: string
example: UN1993
custom_parameters:
type: array
description: Array of up to 3 custom parameters
items:
type: object
properties:
name:
type: string
example: parameter1
value:
type: string
example: value1
Price:
modelName: Price
type: object
properties:
amount:
type: number
format: float
example: 150357.99
currency:
type: string
enum:
- AED
- AUD
- BHD
- BRL
- CAD
- CHF
- CNY
- EUR
- GBP
- HKD
- IDR
- INR
- JPY
- MXN
- KRW
- KWD
- MYR
- NZD
- PLN
- SEK
- SGD
- THB
- TWD
- USD
- XOF
- XPF
- ZAR
example: USD
````