- General
- Endpoints
Update Single OrderRow
PUT
/order/{order_id}/row/{row_id}
Row
Request
Path Params
order_id
string <uuid>
required
row_id
string <uuid>
required
Header Params
x-api-key
string
required
Default:
{{api_key}}
x-api-env
string
required
Default:
{{api_env}}
Body Params application/json
code
string | null
optional
<= 50 characters
Default:
NULL
description
string
optional
<= 150 characters
order_id
string <uuid> | null
optional
item_id
string <uuid> | null
optional
activity_id
string <uuid> | null
optional
transaction
string | null
optional
<= 36 characters
Default:
NULL
position
integer | null
optional
>= 0<= 4294967296
type
string | null
optional
<= 50 characters
Default:
NULL
unit
string
optional
<= 50 characters
item_code
string | null
optional
<= 50 characters
Default:
NULL
reserved
number | null
optional
Default:
NULL
quantity
number | null
optional
Default:
NULL
quantity_delivered
number | null
optional
Default:
NULL
quantity_backorder
number | null
optional
Default:
NULL
quantity_original
number | null
optional
Default:
NULL
status
string | null
optional
<= 32 characters
Default:
NULL
delivered_date
string <date>
optional
Default:
NULL
resource_ref
string | null
optional
<= 64 characters
Default:
NULL
external_ref
string | null
optional
<= 64 characters
Default:
NULL
Example
{
"code": "NULL",
"description": "string",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
"activity_id": "98dae057-958f-4b2f-9ed4-41f109afdc3f",
"transaction": "NULL",
"position": 0,
"type": "NULL",
"unit": "string",
"item_code": "NULL",
"reserved": "NULL",
"quantity": "NULL",
"quantity_delivered": "NULL",
"quantity_backorder": "NULL",
"quantity_original": "NULL",
"status": "NULL",
"delivered_date": "NULL",
"resource_ref": "NULL",
"external_ref": "NULL"
}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//row/' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw '{
"code": "NULL",
"description": "string",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
"activity_id": "98dae057-958f-4b2f-9ed4-41f109afdc3f",
"transaction": "NULL",
"position": 0,
"type": "NULL",
"unit": "string",
"item_code": "NULL",
"reserved": "NULL",
"quantity": "NULL",
"quantity_delivered": "NULL",
"quantity_backorder": "NULL",
"quantity_original": "NULL",
"status": "NULL",
"delivered_date": "NULL",
"resource_ref": "NULL",
"external_ref": "NULL"
}'Responses
🟢204No Content
text/plain
Body
object {0}
🟠412412
🟠422Unprocessable Content
🟠404Not Found
🟠401Not Logged In
Modified at 2024-10-14 12:07:08