- General
- Endpoints
Update Single Order
PUT
/order/{order_id}
Order
NOTE
Request
Path Params
order_id
string <uuid>
required
Query Params
remove_missing
boolean
optional
Example:
false
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
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
{
"order_rows": [
{
"id": "995faf65-96c2-4968-bf74-ccc0cdfe66bd",
"name": "foo"
}
]
}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 PUT 'https://api.vplan.com/v1/order/' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_rows": [
{
"id": "995faf65-96c2-4968-bf74-ccc0cdfe66bd",
"name": "foo"
}
]
}'Responses
🟢204No Content
text/plain
Body
object {0}
🟠412412
🟠422Unprocessable Content
🟠404Not Found
🟠401Not Logged In
Modified at 2024-11-21 17:12:57