vPlan
  1. Order Data
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
        • View
          • Create New BoardView
        • 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
        • Schedule
        • Schedule Deviation
          • Retrieve Deviation List
          • Create New Schedule Deviation
          • Retrieve Single Schedule Deviation
          • Update Single Schedule Deviation
          • Remove Single Schedule Deviation
        • 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
        • Invite 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
        • Remove Single Collection
        • Move Collection to Backlog
        • Update Single Collection
        • Move Collection to Board
      • Card
        • Custom Field
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Card List
        • Create New Card
        • Retrieve Single Card
        • Update Single Card
        • Remove Single Card
        • Split Card
        • All Cards List
      • 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
        • Create New Order
        • Retrieve Single Order
        • Update Single Order
        • Remove Single Order
      • 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. Order Data

Row

OrderRows are part of orders and represent a list of items, and/or operations that an order can consist of. Therefore rows are always related to an order. The activity_id can be used in combination with the unit and quantity properties to add activities with a time estimation to vPlan.
OrderRows can also be included in the order object.
OrderRow
id
string <uuid>
read-onlyoptional
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
created_at
string <date-time>
read-onlyoptional
Date and time of creation
Default:
NULL
updated_at
string <date-time>
read-onlyoptional
Date and time of last update
Default:
NULL
Modified at 2025-06-30 07:38:47
Previous
Remove Single Order
Next
Retrieve OrderRow List
Built with