Create a new Workorder

matbar20matbar20 Member Posts: 3
Is it possible to create a new workorder through the Lightspeed Retail API?


  • jamesratcliffejamesratcliffe Administrator, Lightspeed Staff Posts: 160 moderator
    The API only gives read access to work orders for now. We'd like to add this in the future, but there's no specific timeline at the moment.
    James Ratcliffe
    Lightspeed HQ
  • joshuaphamjoshuapham Member Posts: 2
    edited March 2018
    @jamesratcliffe what about work order lines? I'd like to be able to add a WorkOrderLine (I believe this is the correct abstraction) to a work order using the API. Is there any way to do this, or any alternative that you'd recommend?

    I was taking a look at the docs for Sale, and it doesn't look like there is a way to add a SaleLine to a Sale either?
  • jamesratcliffejamesratcliffe Administrator, Lightspeed Staff Posts: 160 moderator
    No, you can't do anything to create or modify a work order.

    You can add a SaleLine to a Sale with the Sale.SaleLine endpoint:

    You can also update the Sale with the SaleLine(s) nested in the payload.
    James Ratcliffe
    Lightspeed HQ
  • joshuaphamjoshuapham Member Posts: 2
    @jamesratcliffe Interesting, thank you!

    In the access scopes page there is a scope for employee:workbench that describes an ability to "View, create, update, and archive work orders." I found this misleading, but maybe this refers to something else?
  • jamesratcliffejamesratcliffe Administrator, Lightspeed Staff Posts: 160 moderator
    Yes, that is a bit confusing, but the scope technically does grant write access. Right now that access is useless because there's no endpoint that lets you create, update or archive work orders, but when they're added, tokens with this scope will already be able to use those endpoints.
    James Ratcliffe
    Lightspeed HQ
  • andyandy Member Posts: 20
    @jamesratcliffe What will it take to get this functionality added?
  • jamesratcliffejamesratcliffe Administrator, Lightspeed Staff Posts: 160 moderator
    @andy We want to add this at some point, but Development has other priorities right now, and there's no specific plan for work orders.

    If there are enough requests for a specific feature, the Product team may re-consider and re-prioritize to make room for that feature on the roadmap.
    James Ratcliffe
    Lightspeed HQ
  • mVaniermVanier Member Posts: 2
    edited February 2019
    Hi guys, any news on this feature? It almost been a year since the last update.

    We too would need those end-points for one of our projects. Any estimate on when we could expect to see those coming out?
  • Adrian SamuelAdrian Samuel Moderator, Lightspeed Staff Posts: 643 moderator
    @mVanier, none yet. Product managers are aware, there has been conversation on it, however any such updates would stand behind our major updates to our costing and inventory modules which we've publicly spoken about. Since workorders reserve inventory internally, all these things have to be factored into a logical development flow. 

    Adrian Samuel

    Software Developer

    Lightspeed HQ

  • mVaniermVanier Member Posts: 2
    Thank you for your answer @Adrian Samuel

    To your knowledge, is there another way to import workorders in bulk (ex. csv file, xml, etc.)? Or is the only way to create workorders is through the user interface?
  • [Deleted User][Deleted User] Posts: 0 moderator
    edited February 2019
    Hello @Mvanier,

    It is not possible to import workorders. You will have to create them using the UI.
  • ps1985ps1985 Member Posts: 1

    @Alex Lugo

    Thanks for the information on work order creation via API. I see that Booxi is able to create WOs via their integration:

    Can you share more on how that is done?

  • Jewelsmith2Jewelsmith2 Member Posts: 3

    I did the Booxi demo and the workorders are not created within booxi but actually through opening Lightspeed not through the API.

    The 2 options then are creating a sale or a work order. The only advantage I see is that the client name is on a pick list and if you are creating a sale the noninventory item that is associated with the appointment is populated into the sale.

    This still shows that the customer and noninventory item were added somehow through the API.

    Can you point me to how one can open a lightspeed session with those parameters?

  • rcuartasrcuartas Member Posts: 2

    Please consider this as another formal request to get Workorder Put/Post available in the API.

    Workorders are a key component for our business and not having that in the API is making our users to create data manually in multiple systems.



  • griffithgriffith Member Posts: 7

    Are there any updates on this request? Is it on a road map anywhere?

    Since the loss of GSX in OnSite and the changes to work orders in Retail, this is becoming a critical need for us to be able to consider moving to Retail.

    Given that the drop dead date for OnSite is a little less than a year away, this could be a significant pain point that may prevent us moving to Retail. We can understand that it is a small subset of users that needed GSX integration and OnSite like Work orders, and that Lightspeed may not be able to support this directly in new products. I would expect that extensions like this to the API would benefit a rather large number of users and allow users like us to implement custom integrations to keep our businesses running smoothly.


  • leoleo Member Posts: 4

    it will be amazing GSX integration!

  • cboutroscboutros Member Posts: 7

    Creating work orders is definitely important.

Sign In or Register to comment.