Create New Item

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:

x-api-env

string

required

Default:

Body Params application/json

description

string

optional

<= 150 characters

code

string

optional

<= 50 characters

stockmanagement

boolean

optional

unit

string | null

optional

note

string | null

optional

location

string | null

optional

Example

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.vplan.com/v1/item' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢201Created

application/json

Body

id

string <uuid>

read-onlyoptional

Unique identifier

description

string

optional

<= 150 characters

code

string

optional

<= 50 characters

external_ref

string | null

read-onlyoptional

Third-party reference of the object, for informational purposes only

Example:

fb1033a2ed70

stockmanagement

boolean

optional

unit

string | null

optional

note

string | null

optional

location

string | null

optional

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",
  "description": "string",
  "code": "string",
  "external_ref": "fb1033a2ed70",
  "stockmanagement": true,
  "unit": "string",
  "note": "string",
  "location": "string",
  "created_at": "2024-04-11T10:22:15Z",
  "updated_at": "2024-04-11T10:22:15Z"
}

🟠412412

🟠422Unprocessable Content

🟠401Not Logged In