Skip to main content
POST
/
api
/
v1
/
orders
Create Order
curl --request POST \
  --url https://api.example.com/api/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "draft",
  "clientId": "<string>",
  "styleId": "<string>",
  "etd": "2023-11-07T05:31:56Z",
  "shippingTerm": "<string>",
  "paymentTerm": "<string>",
  "id": "<string>",
  "clientPoNumber": "<string>",
  "estimatedCost": 123,
  "budgetAllowableTolerance": 0,
  "requestedDeliveryDate": "2023-11-07T05:31:56Z",
  "requestedBulkReadyDate": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "lineItems": [],
  "changeDescription": "<string>"
}
'
{
  "success": true,
  "message": "<string>",
  "salesOrderId": "<string>",
  "documentId": "<string>",
  "versionNumber": 123,
  "status": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vinmake.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
X-User-Id
string | null

Body

application/json

Input schema for creating a new sales order (POST /orders/).

  • action: "draft" saves as draft, "submit_for_review" submits for approval
  • id: None = create new, provided = update existing (create new version)
​
action
enum<string>
required

Actions for sales order state transitions

Permissions:

  • draft, submit_for_review: Any authenticated user
  • confirm, reject: Manager or Admin only
  • mark_in_procurement, mark_in_production, mark_delivered: Manager or Admin only
Available options:
draft,
submit_for_review,
confirm,
reject,
mark_in_procurement,
mark_in_production,
mark_partially_delivered,
mark_delivered
​
clientId
string
required
​
styleId
string
required
​
etd
string<date-time>
required
​
shippingTerm
string
required
​
paymentTerm
string
required
​
id
string | null
​
clientPoNumber
string | null
Maximum string length: 50
​
estimatedCost
number | null
​
budgetAllowableTolerance
number
default:0
​
requestedDeliveryDate
string<date-time> | null
​
requestedBulkReadyDate
string<date-time> | null
​
notes
string | null
​
lineItems
SalesOrderLineItemInput · object[]
​
changeDescription
string | null

Response

Successful Response

Response after creating a sales order

​
success
boolean
required
​
message
string
required
​
salesOrderId
string
required
​
documentId
string
required
​
versionNumber
integer
required
​
status
string
required