Using Watermelon APIs
Guides

Lightspeed template: Retrieving order status

This article will guide you through using the Lightspeed Action template.

Suggest Edits

By using this template, you can easily connect to your Lightspeed database and have your chatbot answer questions about order statuses. This template is prefilled with all necessary information, allowing you to seamlessly retrieve order status information.


1: Access the Template

In your chatbot in Pulse, navigate to Actions. Select the Lightspeed template.
This template includes prefilled information necessary for retrieving order status information from your Lightspeed database.

2. Add information

Fill in the required fields:

  • Base URL: Enter the URL for your Lightspeed API. This is the endpoint where the action will send requests to retrieve order status information.

    • Within Watermelon, replace api-key with your API key, api-secret with your API secret, and language with the language of your webshop (e.g., en, nl, etc.).

      https://api-key:[email protected]/language/

    • Within Lightspeed, follow the steps below to create an API key and secret.

      1. Go to Settings > Store Settings > Developers.
      2. Select New API key.
      3. Enter a name for the API key (e.g. the name of the integration or of your developer).
      4. Select Save.
      5. Under SETTINGS, select the switch to enable the API key.
      6. Select the checkboxes of the permissions you want to grant.
      7. Select Save. Under DETAILS, the API key will display.
      8. Select Show to display the API secret.

  • Authentication: No authentication ('No auth') is needed for the Lightspeed Action (this is already done by including the API key and API secret in the Base URL).
  • Health Check URL and Instruction: No health check is needed for the Lightspeed Action.

3. Update the Schema

The template already has a filled-in schema, so you can use it right away. If you want, you can change the schema to fit other purposes.


4. Validating Your Action

After filling in the required details and schema:

  • Validate: Click Validate to check for any errors in your schema. Correct any issues that are identified.
  • Available Actions: Once validated, the available actions will be displayed.

Updated 25 days ago

What’s Next