API OrderCredit Documentation not clear

ralfdralfd Member Posts: 2

Could you please give me a full description to the API Interface "OrderCredit" - especialy how to add custom notes. In the UI it is marked as "custom_line" ... but in the documentation to this interface I can't find any word how to create a credit with custom notes.

The given example is not self explaining at all.


The whole documentation to this API interface is confusing and need a restruct.

Kind Regards



  • LeahLeah Moderator, Lightspeed Staff Posts: 182 moderator

    Hi @ralfd An order credit creates an additional invoice which is attached to an order. Invoices do not have custom notes, but you could update the Order itself with a note using the "memo" field at the order endpoint: https://developers.lightspeedhq.com/ecom/endpoints/order/

    To create a credit for a particular product or products, the orderProduct ID (and not the regular product ID) must be used. Those IDs can be retrieved at the orderProduct endpoint: https://developers.lightspeedhq.com/ecom/endpoints/orderproduct/#get-all-order-products

    API Support
    Lightspeed HQ
  • ralfdralfd Member Posts: 2

    Thank you for your answer.

    But you may missunderstood my question to the custom note.

    Via Lightspeed Frontend it is possible to make a custom note to a non ordered product or some kind of special custom note, i.e. a discount (cause the product was not as good the customer expexted but he does not want to change, just to get a discount).

    In that case, I do not have an orderProductID. Via frontend it is possible to add a custom note (with a custom text and a custom price). How to do this via API?

  • LeahLeah Moderator, Lightspeed Staff Posts: 182 moderator

    @ralfd these are referred to as "Custom Credits" These are not available via the API, only via the UI.

    API Support
    Lightspeed HQ
Sign In or Register to comment.