vPlan
  1. Endpoints
  2. Order Data
  3. Order
vPlan
  • General
    • Structure
    • Synchronize Data
    • Pagination
    • Sorting
    • Filtering
    • Show & Hide
    • Eager Loading
    • Deep Insertion
    • Deprecated
    • External Reference
    • Rate Limits
    • Authentication
      • Authentication
        • Get authorization
        • Token Exchange
      • Me
        • Retrieve information about current authentication
    • Errors
      • Empty values in created object
      • Memory Exhausted
      • Report an issue
      • Service Unavailable
      • Retrieve Api Messages
  • Endpoints
    • Base Data
      • Board
        • Label
        • Status
        • Capacity
          • Capacity Stage
          • Capacity Resource Type Stage
          • Capacity Resource
          • Capacity Group
        • Retrieve Board List
        • Create New Board
        • Retrieve Single Board
        • Update Single Board
        • Remove Single Board
      • Stage
        • Retrieve Stage List
        • Create New Stage
        • Retrieve Single Stage
        • Update Single Stage
        • Remove Single Stage
      • Activity
        • Retrieve Activity List
        • Create New Activity
        • Retrieve Single Activity
        • Update Single Activity
        • Remove Single Activity
      • Resource
        • Retrieve Resource List
        • Create New Resource
        • Retrieve Single Resource
        • Update Single Resource
        • Remove Single Resource
      • Schedule
        • Retrieve Schedule List
        • Retrieve Schedule Year
        • Retrieve Schedule Month
        • Schedule Retrieve Day
      • Group
        • Retrieve Group List
        • Create New Group
        • Retrieve Single Group
        • Update Single Group
        • Remove Single Group
      • User
        • Retrieve User List
        • Retrieve Single User
        • Update Single User
    • Card Data
      • Collection
        • Custom Fields
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Collection List
        • Create New Collection
        • Retrieve Single Collection
        • Update Single Collection
        • Remove Single Collection
        • Move Collection to Backlog
        • Move Collection to Board
      • Card
        • Custom Field
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Card List
        • All Cards List
        • Create New Card
        • Retrieve Single Card
        • Update Single Card
        • Remove Single Card
        • Split Card
      • Attachment
        • Retrieve Attachment List
        • Upload New Attachment
        • Add New Attachment Link
        • Retrieve Single Attachment
        • Remove Single Attachment
      • Comment
        • Retrieve Comment List
        • Create New Comment
        • Retrieve Single Comment
        • Update Single Comment
        • Remove Single Comment
      • Checklist
        • Collection
          • Retrieve Collection Checklist List
          • Create New Collection Checklist
          • Retrieve Single Collection Checklist
          • Update Single Collection Checklist
          • Remove Single Collection Checklist
        • Card
          • Retrieve Card Checklist List
          • Create New Card Checklist
          • Retrieve Single Card Checklist
          • Update Single Card Checklist
          • Remove Single Card Checklist
      • Time Tracking
        • Retrieve TimeTracking List
        • Create New TimeTracking
        • Retrieve Single TimeTracking
        • Update Single TimeTracking
        • Remove Single TimeTracking
        • Export TimeTracking
      • Relations between cards
        • Retrieve CardRelation List
        • Create New CardRelation
        • Retrieve Single CardRelation
        • Remove Single CardRelation
    • Order Data
      • Address
      • Order
        • Retrieve Order List
          GET
        • Create New Order
          POST
        • Retrieve Single Order
          GET
        • Update Single Order
          PUT
        • Remove Single Order
          DELETE
      • Row
        • Retrieve OrderRow List
        • Create New OrderRow
        • Retrieve Single OrderRow
        • Update Single OrderRow
        • Remove Single OrderRow
      • Item
        • Retrieve Item List
        • Create New Item
        • Retrieve Single Item
        • Update Single Item
        • Remove Single Item
      • Project
        • Retrieve Project List
        • Create New Project
        • Retrieve Single Project
        • Update Single Project
        • Remove Single Project
      • Relation
        • Retrieve Relation List
        • Create New Relation
        • Retrieve Single Relation
        • Update Single Relation
        • Remove Single Relation
      • Warehouse
        • Retrieve Warehouse List
        • Create New Warehouse
        • Retrieve Single Warehouse
        • Update Single Warehouse
        • Remove Single Warehouse
    • Webhook
      • Retrieve Webhook List
      • Create New Webhook
      • Retrieve Single Webhook
      • Update Single Webhook
      • Remove Single Webhook
    • Payload send to webhook url
      • Normal Object
      • Nested Object
      • Nested Object with Pivot
  1. Endpoints
  2. Order Data
  3. Order

Create New Order

POST
/order
Order
Create a new Order and store it
NOTE
It is possible to create an Order with Rows in one request.
It is not possible to update both in one request.

Request

Query Params
show
string 
optional
limit the response to show only specific properties, see show & hide for more info
Example:
id,updated_at
hide
string 
optional
hide properties from the response, see show & hide for more info
Example:
created_at,updated_at
Header Params
x-api-key
string 
required
Default:
{{api_key}}
x-api-env
string 
required
Default:
{{api_env}}
Body Params application/json
project_id
string <uuid> | null 
optional
<= 36 characters
Default:
NULL
warehouse_id
string <uuid> | null 
optional
<= 36 characters
Default:
NULL
relation_id
string <uuid> | null 
optional
<= 36 characters
Default:
NULL
item_id
string <uuid> | null 
optional
<= 36 characters
Default:
NULL
address_id
string <uuid> | null 
optional
<= 36 characters
Default:
NULL
collection_id
string <uuid>
optional
Unique identifier of the Collection
meta
object  | null 
optional
transaction
string  | null 
optional
<= 36 characters
Default:
NULL
code
string 
optional
<= 100 characters
type
enum<string>  | enum<null> 
optional
Allowed values:
ProductionProjectPurchaseQuotationSales
sub_type
string  | null 
optional
<= 25 characters
Default:
NULL
status
string  | null 
optional
<= 10 characters
Default:
NULL
note
string  | null 
optional
<= 65535 characters
Default:
NULL
description
string 
optional
<= 150 characters
Default:
NULL
contact
string  | null 
optional
<= 100 characters
Default:
NULL
date
string <date> | null 
optional
Default:
NULL
promised_date
string <date> | null 
optional
Default:
NULL
desired_date
string <date> | null 
optional
Default:
NULL
delivered_date
string <date> | null 
optional
Default:
NULL
quantity
number  | null 
optional
Default:
NULL
relation_ref
string  | null 
optional
<= 255 characters
Default:
NULL
external_url
string  | null 
optional
<= 2048 characters
Default:
NULL
Example
{
  "type": "Sales"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.vplan.com/v1/order' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "Sales"
}'

Responses

🟢201Created
application/json
Body
id
string <uuid>
read-onlyoptional
Unique identifier
project_id
string <uuid> | null 
optional
<= 36 characters
Default:
NULL
warehouse_id
string <uuid> | null 
optional
<= 36 characters
Default:
NULL
relation_id
string <uuid> | null 
optional
<= 36 characters
Default:
NULL
item_id
string <uuid> | null 
optional
<= 36 characters
Default:
NULL
address_id
string <uuid> | null 
optional
<= 36 characters
Default:
NULL
collection_id
string <uuid>
optional
Unique identifier of the Collection
meta
object  | null 
optional
transaction
string  | null 
optional
<= 36 characters
Default:
NULL
code
string 
optional
<= 100 characters
type
enum<string>  | enum<null> 
optional
Allowed values:
ProductionProjectPurchaseQuotationSales
sub_type
string  | null 
optional
<= 25 characters
Default:
NULL
status
string  | null 
optional
<= 10 characters
Default:
NULL
note
string  | null 
optional
<= 65535 characters
Default:
NULL
description
string 
optional
<= 150 characters
Default:
NULL
contact
string  | null 
optional
<= 100 characters
Default:
NULL
date
string <date> | null 
optional
Default:
NULL
promised_date
string <date> | null 
optional
Default:
NULL
desired_date
string <date> | null 
optional
Default:
NULL
delivered_date
string <date> | null 
optional
Default:
NULL
quantity
number  | null 
optional
Default:
NULL
relation_ref
string  | null 
optional
<= 255 characters
Default:
NULL
external_url
string  | null 
optional
<= 2048 characters
Default:
NULL
external_ref
string  | null 
read-onlyoptional
Third-party reference of the object, for informational purposes only
Example:
fb1033a2ed70
created_at
string <date-time>
read-onlyoptional
Date and time of creation
Example:
2024-04-11T10:22:15Z
updated_at
string <date-time>
read-onlyoptional
Date and time of last update
Example:
2024-04-11T10:22:15Z
Example
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_id": "NULL",
  "warehouse_id": "NULL",
  "relation_id": "NULL",
  "item_id": "NULL",
  "address_id": "NULL",
  "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
  "meta": {},
  "transaction": "NULL",
  "code": "string",
  "type": "Production",
  "sub_type": "NULL",
  "status": "NULL",
  "note": "NULL",
  "description": "NULL",
  "contact": "NULL",
  "date": "NULL",
  "promised_date": "NULL",
  "desired_date": "NULL",
  "delivered_date": "NULL",
  "quantity": "NULL",
  "relation_ref": "NULL",
  "external_url": "NULL",
  "external_ref": "fb1033a2ed70",
  "created_at": "2024-04-11T10:22:15Z",
  "updated_at": "2024-04-11T10:22:15Z"
}
🟠422Unprocessable Content
🟠401Not Logged In
Modified at 2024-10-14 12:07:08
Previous
Retrieve Order List
Next
Retrieve Single Order
Built with