Create New Order

POST

/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

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

API Key

Add parameter in header

x-api-env

Example:

x-api-env: ********************

Body Params application/json

Example

{
    "type": "Sales"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.vplan.com/v1/order' \
--header 'x-api-key: <api-key>' \
--header 'x-api-env: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "Sales"
}'

Responses

🟢201Created

application/json

Body

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "Production",
    "code": "string",
    "description": "NULL",
    "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",
    "sub_type": "NULL",
    "status": "NULL",
    "note": "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"
}

🟠401Not Logged In

Modified at 2025-10-30 09:44:22

Retrieve Order List

Retrieve Single Order