> ## 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 an order preparation
> Create an order preparation with the information provided
## OpenAPI
````yaml openapi.json post /v1/orderPreparations
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/orderPreparations:
post:
tags:
- Order Preparations
summary: Create an order preparation
description: Create an order preparation with the information provided
requestBody:
content:
application/json:
schema:
properties:
client_role_on_order:
type: string
enum:
- buyer
- seller
commercial_invoice_ids:
type: array
items:
type: string
customer_names_for_whom_order_is_prepared:
type: array
items:
type: string
external_user_ids:
type: array
items:
type: string
freight_method:
type: string
enum:
- air
- ocean
- rail
- truck
incoterm:
type: string
enum:
- cfr
- cif
- cip
- cpt
- dap
- dat
- ddp
- dpu
- exw
- fas
- fca
- fob
hazardous_details:
type: string
example: UN1845 - Dry ice
instructions:
type: object
properties:
origin_certification_type:
type: string
enum:
- atr
- certificate_of_origin
- eur1
should_certify_commercial_invoices:
type: boolean
should_label_packages:
type: boolean
should_palletise:
type: boolean
target_pickup_date:
type: integer
required:
- should_label_packages
- should_palletise
locations:
type: object
properties:
delivery_location_id:
type: string
preparing_warehouse_id:
type: string
required:
- preparing_warehouse_id
name:
type: string
on_behalf_of_client_id:
type: string
on_behalf_of_user_id:
type: string
owner_in_charge_of_moving_goods_in_fca_export:
type: boolean
picking_references:
type: array
items:
type: string
refrigerated_details:
type: string
example: +2°C/+8°C
total_commercial_invoice_amount:
type: number
total_commercial_invoice_amount_currency:
type: string
enum:
- AED
- AUD
- BHD
- BRL
- CAD
- CHF
- CNY
- EUR
- GBP
- HKD
- IDR
- INR
- JPY
- KRW
- KWD
- MXN
- MYR
- NZD
- PLN
- SEK
- SGD
- THB
- TWD
- USD
- XOF
- XPF
- ZAR
target_pickup_date:
$ref: '#/components/schemas/SimpleDate'
packaging_done_at:
$ref: '#/components/schemas/SimpleDate'
required:
- name
- picking_references
- client_role_on_order
- locations
- instructions
- owner_in_charge_of_moving_goods_in_fca_export
type: object
required: true
responses:
'201':
description: Order preparation created
content:
application/json:
schema:
description: Order preparation created
example:
reference: BIO-0008
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'
````