{ "opencollection": "1.0.0", "info": { "name": "Sibill Integration Account Product API", "version": "1.0.0" }, "items": [ { "info": { "name": "Product", "type": "folder" }, "items": [ { "info": { "name": "Get the list of products", "type": "http" }, "http": { "method": "GET", "url": "http://integration.app.svc.cluster.local:4000/api/v1/companies/:company_id/products", "params": [ { "name": "company_id", "value": "", "type": "path", "description": "The company the products belong to" }, { "name": "page_size", "value": "", "type": "query", "description": "The page size" }, { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor. A cursor is used to paginate through a large set of data.\nIt is a unique identifier that represents a specific position in the dataset.\n" }, { "name": "filter", "value": "", "type": "query", "description": "List of filters on the resource. Currently the fields that allow to be filtered are: `code`, `description`, `search`" }, { "name": "sort", "value": "", "type": "query", "description": "Fields for which we can order the results. Sortable fields: `code`, `description`" } ] }, "docs": "The return value is paginated. By default the response contains 25 elements per page but can be instructed to return more elements per page.\nA cursor is needed to traverse the results.\n" }, { "info": { "name": "Create a new product", "type": "http" }, "http": { "method": "POST", "url": "http://integration.app.svc.cluster.local:4000/api/v1/companies/:company_id/products", "params": [ { "name": "company_id", "value": "", "type": "path", "description": "The company the product belongs to" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new product" }, { "info": { "name": "Get a specific product", "type": "http" }, "http": { "method": "GET", "url": "http://integration.app.svc.cluster.local:4000/api/v1/companies/:company_id/products/:id", "params": [ { "name": "company_id", "value": "", "type": "path", "description": "The company the product belongs to" }, { "name": "id", "value": "", "type": "path", "description": "The product identifier" } ] }, "docs": "Get a specific product" }, { "info": { "name": "Update an existing product", "type": "http" }, "http": { "method": "PATCH", "url": "http://integration.app.svc.cluster.local:4000/api/v1/companies/:company_id/products/:id", "params": [ { "name": "company_id", "value": "", "type": "path", "description": "The company the product belongs to" }, { "name": "id", "value": "", "type": "path", "description": "The product identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing product" }, { "info": { "name": "Delete a product", "type": "http" }, "http": { "method": "DELETE", "url": "http://integration.app.svc.cluster.local:4000/api/v1/companies/:company_id/products/:id", "params": [ { "name": "company_id", "value": "", "type": "path", "description": "The company the product belongs to" }, { "name": "id", "value": "", "type": "path", "description": "The product identifier" } ] }, "docs": "Delete a product" } ] } ], "bundled": true }