Order items

Here we go into detail about fetching, creating, updating and deleting Order items.

Order items can be accessed from the /phaser-Order-rows endpoint.

Fetching Order items #

You fetch Order items by sending a GET-request to the /phaser-Order-rows endpoint:

You can search for Order items by a variety of different parameters:

• phaser_order_id
  • internal Skyplanner Order id, can be found from the /phaser-orders-endpoint
• external_id
  • External identifier of the Order item
  • For example the unique identifier from your external system (ERP, etc)
• production_planning_product_id
  • Internal Skyplanner Product id
  • Can be found from the /products-endpoint
• parent_id
  • If an Order item has subitems (eg. sub products) the subitems have their parent Order item’s id in the parent_id field
• row_index
  • Index number of the Order item

• worknumber
  • The worknumber value of Order item
• status
  • Order item status
  • Allowed values: new, started or completed
• position
  • The position value of the Order item

• delivery_date
  • The delivery date of the Order item
  • Format: 2025-06-05T22:00:00+00:00
• delivery_date_condition
  • Optional condition of delivery date search
  • Options: >, <, >=, <=, =, !=
  • If no value given, >= condition will be used
• is_prospect
  • Return only Order items that are prospects
• include_archived
  • Include archived (soft deleted) Order items in fetch
  • Denoted by the is_archive value
• modified
  • Return Order items that have been modified after given date
  • Format: 2025-06-05T22:00:00+00:00
• modifiedCondition
  • Optional condition of modified value search
  • Options: >, <, >=, <=, =, !=
  • If no value given, >= condition will be used

You can also mix and match the search parameters like this:

To fetch a specific Order item with its internal Skyplanner id you can do a request like this:

Creating Order items #

Note that you must create an Order before creating the Order item!

To create an Order item send a POST request to the /phaser-Order-rows endpoint:

Here is an overview about the fields you can use when creating an Order item:

• phaser_order_id
  • Internal Skyplanner id for the Order the Order item is attached to
  • Required field
• production_planning_order_row_id
  • After the Order is exported to the production scheduling module of Skyplanner a separate entity called a production planning Order row is created and its id is set into this field
  • Not recommended to use (leave as null or do not send this field at all in the request field)
• production_planning_product_id
  • Skyplanner Product id for the Product the Order item is producing
  • Required if you want to bring default Process Steps from a Product
• external_id
  • Unique identifier of the Order item
  • Use this to link the Skyplanner Order item to your Order item from an external system (ERP etc)
  • Must be unique
• parent_id
  • If the Order item is a subitem for another Order item, give the parent’s id value here
• row_index
  • Where in the list of Order items in the Order this item is situated
• worknumber
  • Only used as an informative worknumber value for the Order item
  • Not visible in Skyplanner UI
• status
  • Status of the Order item
  • Allowed values: new, started, ready, phased
• is_archive
  • Is the Order item archived (soft deleted)
• position
  • Order item identifier value (see Fig 3.)
• amount
  • Total manufactured quantity of Product
• ordered_amount
  • Ordered quantity of Product
• price
  • Unit price of Product
• use_custom_materials
  • If you do not want to use the default Material setup from the Product data, set this value to true
  • Default: false
• use_custom_materials_calculated
  • Custom Material quantities are calculated based on the manufactured quantity of products
  • If set to false, Material quantities are fixed
  • Default: false
• get_default_steps
  • Create Process Steps to Order item based on the Product’s default Process Steps
  • Default: false
• use_calculated_job_durations
  • Calculate process step durations based on past timelog data
  • If not enough data available to calculate, default durations are used
  • Default: false
• sub_items
  • Create also Product’s sub items if available
  • Default: false
• delivery_date
  • Format: 2022-01-01 10:30:11
• start_eligibility_date
  • Format: 2022-01-01 10:30:11
• drawing_identifier
  • Drawing/blueprint/instructions identifier
• description
  • Order item description
• additional_description
  • Additional description for Order item
• is_prospect
  • Is the Order item a prospect
  • Default: false

Updating Order items #

To update Order item data you can send a PUT request to the /phaser-Order-rows endpoint:

Deleting Order items #

Deleting Order items is done in a “soft delete” method. In effect, deleting an Order item changes its is_archive value to true. This means you can restore deleted Order items by updating the is_archive value to false.

When deleting an Order item the system will also delete the associated Process Steps.

You delete Order items by sending a DELETE-request to the /phaser-Order-rows endpoint:

You can delete Order items by giving the internal Skyplanner ids in the array “ids” or the external_ids in the “external_ids” array.