Add a business location ID to a webhook endpoint.

PUT /o/wh/1/webhook/{endpointId}/business-locations/{businessLocationId}
O auth2

Enables a webhook for the specified business location. Required to receive item availability notifications (type 'item'). Not required for 'order' and 'payment' webhooks.

Path parameters

  • endpointId string Required
  • businessLocationId integer(int64) Required

    The unique identifier for the business location.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • businessLocationId integer(int64) Required

      ID of the business location

    • createdAt string(date-time)

      Timestamp when this association was created

    • updatedAt string(date-time)

      Timestamp when this association was last updated

    • warnings array[object]

      A list of warnings that occurred during the request, but which did not prevent a successful response. For instance, if the Business Location does not have the required POS app version to support item availability.

      Hide warnings attributes Show warnings attributes object
      • information string
      • type string
  • 404

    Not Found

PUT /o/wh/1/webhook/{endpointId}/business-locations/{businessLocationId} 
curl \
 --request PUT 'https://api.trial.lsk.lightspeed.app/o/wh/1/webhook/endpoint/business-locations/45454565682155' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "businessLocationId": 45454565682155,
  "createdAt": "2023-11-07T19:15:05.043+0000",
  "updatedAt": "2023-11-07T19:15:05.043+0000",
  "warnings": [
    {
      "information": "string",
      "type": "string"
    }
  ]
}