View Categories

Order items

Sami
Updated on May 13, 2025

3 min read

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:

Fig 1. Fetching order items

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
Fig 2. Order item row indices
  • 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
Fig 3. Order item position values
  • 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:

Fig 4. Fetching order items by phaser_order_id and row_index

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

Fig 5. Fetching an order item with the Skyplanner id 4

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:

Fig 6. Creating an order item
Fig 7. Created order item

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:

Fig 8. Updating an order item
Fig 9. Updated order item

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:

Fig 10. Deleting order items

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

Updated on May 13, 2025
API, Integration