{"id":23714907,"url":"https://github.com/livescale/open-api","last_synced_at":"2025-07-04T15:37:54.489Z","repository":{"id":143762990,"uuid":"396810406","full_name":"livescale/open-api","owner":"livescale","description":"Livescale open-api","archived":false,"fork":false,"pushed_at":"2022-02-04T14:57:32.000Z","size":545,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-30T11:55:49.054Z","etag":null,"topics":["ecommerce","openapi"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/livescale.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-16T13:36:32.000Z","updated_at":"2022-02-04T14:57:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"ad4dc8ba-2830-49dc-a11d-b38e568f3d55","html_url":"https://github.com/livescale/open-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/livescale/open-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livescale%2Fopen-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livescale%2Fopen-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livescale%2Fopen-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livescale%2Fopen-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/livescale","download_url":"https://codeload.github.com/livescale/open-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livescale%2Fopen-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263568113,"owners_count":23481615,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ecommerce","openapi"],"created_at":"2024-12-30T20:51:34.041Z","updated_at":"2025-07-04T15:37:54.465Z","avatar_url":"https://github.com/livescale.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cp align=\"left\"\u003e\n  \u003cimg src=\"https://www.livescale.tv/wp-content/uploads/2020/11/Livescale-Horizontal-Logo-1.png\" alt=\"Livescale Logo\"\u003e\n\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\nThis repository holds the official Livescale Shopping OpenAPI specification.\n\nBefore you start, please consult the [Standard Flow](STANDARD-FLOW.md) description.\n\nLivescale is a platform that enables Live shopping for Merchants by connecting their e-commerce to our live shopping solution. This repository is for Merchants that operate on an e-commerce platform that have custom needs.\n\nWith this OpenAPI, the Merchant can choose to integrate fully with our seamless integrated checkout (i.e. viewer doesn't leave the live shopping experience) or can choose for the viewer to checkout on the Merchant or Retailer's website.\n\nThis OpenAPI specification allows you to create a server that will be able to interact with Livescale's live shopping App.\n\nOpenAPI spec 3.0 In Release\n\n* [Shopping API](https://github.com/livescale/open-api/blob/main/livescale-shopping-api.yml)\n\n## Code Generators\n\nYou can use this [OpenAPI generator](https://editor.swagger.io/) along with this OAS yaml file to generate a server. \n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\nThis is an example of the **POST /baskets/:basket_id/items** endpoint that use the SFCC© Commerce SDK.\n\n```javascript\n\nconst { ClientConfig, Checkout } = require('commerce-sdk');\nconst config = new ClientConfig();\nconfig.headers = {};\nconfig.parameters = {\n  clientId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx',\n  organizationId: 'f_ecom_xxxx_xxx',\n  shortCode: 'xxxxxxxx',\n  siteId: 'livescale',\n};\n\n\nserver.post('/baskets/:basket_id/items',\n  restify.plugins.conditionalHandler([{\n    version: ['1.0.0'], handler: async (req, res, next) =\u003e {\n      config.headers.authorization = authorization;\n      const shopperBasketsClient = new Checkout.ShopperBaskets(config);\n\n      try {\n\n        // Convert input for your ecommerce\n        const products = converter.productsConverter(body);\n\n        // Interact with your ecommerce\n        const basket = await shopperBasketsClient.addItemToBasket({\n          parameters: { basketId: basket_id },\n          body: products,\n        });\n\n        // Convert your ecommerce response to Livescale Basket Object\n        const convertedBasket = converter.basketConverter(basket);\n\n        res.send(200, convertedBasket);\n        return next();\n      } catch (error) {\n        const convertedError = converter.errorConverter(error);\n        res.send(convertedError.statusCode, convertedError.message);\n        return next();\n      }\n  }])\n);\n```\n\nThe example above show that there are three major steps in every endpoint of this API. \n\n1. Converting Livescale input into your e-commerce input format\n2. Passing the converted input into your e-commerce\n3. Converting your e-commerce response into the Livescale output format\n\n\u003c!-- ROADMAP --\u003e\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the Creative Commons Zero v1.0 Universal License. See [License](LICENSE) for more information.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flivescale%2Fopen-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flivescale%2Fopen-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flivescale%2Fopen-api/lists"}