{ "opencollection": "1.0.0", "info": { "name": "YOOBIC Public Answers Business KPIs data - salesdata API", "version": "1.0" }, "items": [ { "info": { "name": "Business KPIs data - salesdata", "type": "folder" }, "items": [ { "info": { "name": "Get", "type": "http" }, "http": { "method": "GET", "url": "https:///public/api/salesdata/:id", "headers": [ { "name": "Accept", "value": "application/json" } ], "params": [ { "name": "id", "value": "54ab03c6546847ee0d30086b", "type": "path", "description": "The id of the salesdata" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/", "accessTokenUrl": "/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a salesdata for the given id." }, { "info": { "name": "Partial Update", "type": "http" }, "http": { "method": "PATCH", "url": "https:///public/api/salesdata/:id", "headers": [ { "name": "Accept", "value": "application/json" } ], "params": [ { "name": "id", "value": "54ab03c6546847ee0d30086b", "type": "path", "description": "The id of the salesdata" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/", "accessTokenUrl": "/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a subset of properties of a salesdata" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https:///public/api/salesdata/:id", "params": [ { "name": "id", "value": "54ab03c6546847ee0d30086b", "type": "path", "description": "The id of the salesdata" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/", "accessTokenUrl": "/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a salesdata by id." }, { "info": { "name": "Get All", "type": "http" }, "http": { "method": "GET", "url": "https:///public/api/salesdata?filter=:filter", "headers": [ { "name": "Accept", "value": "application/json" } ], "params": [ { "name": "filter", "value": "{}", "type": "query", "description": "A valid JSON filter object" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get all the salesdata." }, { "info": { "name": "Count", "type": "http" }, "http": { "method": "GET", "url": "https:///public/api/salesdata/count?where=:where", "headers": [ { "name": "Accept", "value": "application/json" } ], "params": [ { "name": "where", "value": "{ \"property\": \"value\" }", "type": "query", "description": "A valid JSON [Where filter](#section-api-requests-filter-where)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Count all the existing entities based on the where filter" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https:///public/api/salesdata", "headers": [ { "name": "Accept", "value": "application/json" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/", "accessTokenUrl": "/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "You may create a new single salesdata or multiple salesdatas using this action. \nWhen creating a single salesdata the body contains a json object, when creating multiple salesdata the body contains an array of objects. \n**Warning: a maximum of 1000 items can be sent in a single request.**" }, { "info": { "name": "Export", "type": "http" }, "http": { "method": "GET", "url": "https:///public/api/salesdata/export?:filter&type=:type", "headers": [ { "name": "Accept", "value": "application/json" } ], "params": [ { "name": "type", "value": "csv", "type": "path", "description": "The type of file, either `csv` (default value) or `excel`" }, { "name": "filter", "value": "{}", "type": "query", "description": "A valid JSON filter object (does not accept a `fields` filter)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource." }, { "info": { "name": "Import", "type": "http" }, "http": { "method": "POST", "url": "https:///public/api/salesdata/import?type=:type", "headers": [ { "name": "Content-Disposition", "value": "form-data; name=\"file\"; filename=\"file.csv\"" } ], "params": [ { "name": "type", "value": "csv", "type": "path", "description": "The type of file, either `csv` (default value) or `excel`" } ] }, "docs": "See the [Import file section](#section-import-jobs) for more information.\n\n### Fields\n\n| Field | Format | Required | Description |\n|--------------------------|---------|:--------:|-----------------|\n|`salesdata_id` | string | | Unique id of the salesdata |\n|`store_id` | string | | Unique id of the store |\n|`store_client_id` | string | | client_id of the store. Can be used instead of the store_id |\n|`repor" } ] } ], "bundled": true }