{ "opencollection": "1.0.0", "info": { "name": "Lightspeed Restaurant K Series Account Rich Item API", "version": "1.0.0" }, "items": [ { "info": { "name": "Rich Item", "type": "folder" }, "items": [ { "info": { "name": "Lightspeed Get Allergens", "type": "http" }, "http": { "method": "GET", "url": "https://api.trial.lsk.lightspeed.app/i/allergens", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of all possible allergens that can be added to a rich item. See [Allergens Table](https://api-portal.lsk.lightspeed.app/guides/reference/reference-tables/allergens) for more details." }, { "info": { "name": "Lightspeed Get Locales", "type": "http" }, "http": { "method": "GET", "url": "https://api.trial.lsk.lightspeed.app/i/locales/:businessId", "params": [ { "name": "businessId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the locales of a business in ISO Code 2 or language_localization (eg. 'en' or 'en_US')." }, { "info": { "name": "Lightspeed Update Locales", "type": "http" }, "http": { "method": "PUT", "url": "https://api.trial.lsk.lightspeed.app/i/locales/:businessId", "params": [ { "name": "businessId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Sets business item languages. Supports language ISO code 2 or language_localization (eg. 'en' or 'en_US')." }, { "info": { "name": "Lightspeed Get Rich Items", "type": "http" }, "http": { "method": "GET", "url": "https://api.trial.lsk.lightspeed.app/i/richItem/:businessId", "params": [ { "name": "businessId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all of the rich item information for a specific business." }, { "info": { "name": "Lightspeed Get Rich Item by Sku", "type": "http" }, "http": { "method": "GET", "url": "https://api.trial.lsk.lightspeed.app/i/richItem/:businessId/:sku", "params": [ { "name": "businessId", "value": "", "type": "path" }, { "name": "sku", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a rich item from its sku and the business id." }, { "info": { "name": "Lightspeed Create or Update Rich Item", "type": "http" }, "http": { "method": "PUT", "url": "https://api.trial.lsk.lightspeed.app/i/richItem/:businessId/:sku", "params": [ { "name": "businessId", "value": "", "type": "path" }, { "name": "sku", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new rich item or updates an existing rich item. To update the sku, set the new sku in the request body. The picture cannot be set using this method (use PATCH method)." }, { "info": { "name": "Lightspeed Update Picture", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.trial.lsk.lightspeed.app/i/richItem/:businessId/:sku", "params": [ { "name": "businessId", "value": "", "type": "path" }, { "name": "sku", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Partially updates the rich item to set the picture or rawPicture." }, { "info": { "name": "Lightspeed Delete Rich Item", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.trial.lsk.lightspeed.app/i/richItem/:businessId/:sku", "params": [ { "name": "businessId", "value": "", "type": "path" }, { "name": "sku", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete rich item" }, { "info": { "name": "Lightspeed Get Rich Items by SKUs", "type": "http" }, "http": { "method": "POST", "url": "https://api.trial.lsk.lightspeed.app/i/richItem/:businessId/itemsBySkus", "params": [ { "name": "businessId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of rich items matching the SKUs provided in the request." }, { "info": { "name": "Lightspeed Get Picture Specifications", "type": "http" }, "http": { "method": "GET", "url": "https://api.trial.lsk.lightspeed.app/i/richItem/:businessId/pictureSpec", "params": [ { "name": "businessId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get rich item picture specifications." } ] } ], "bundled": true }