These legacy docs are still available here, but new and up-to-date information can be found at our new developer hub at developers.apicbase.com.
\nThe Apicbase API uses version 2.0 of the OAuth specification for authentication and authorization. This means that all requests will need to be encrypted and sent via HTTPS.
\nIs this your first time connecting to the Apicbase API? Are you not familiar with OAuth? Take a look at the quick start guide in our knowledge base to help you get started.
\nThe API is accessed by making HTTP requests to an endpoint URL. Most GET endpoints accept parameters that allow you to specify which information you wish to access. Calls to the API must be made via an SSL-enabled HTTPS (port 443), as per the OAuth 2.0 specification.
\nThe base URL for every HTTP endpoint for the current version is https://app.apicbase.com/api/v1/
This API exclusively uses the Authorization Code grant of the OAuth framework for authorization. A comprehensive guide to the Authorization Code flow can be found here.
\nDo you have questions about the API? Contact us directly at api_support@apicbase.com to receive specialised support. When you describe a potential issue, please provide the maximum amount of details possible, and include both the raw request and response.
\nEvery party accessing the API must be registered as an application.
\nLibrary owners can create an application for themselves through the Apicbase user interface. This option can be found in your library settings page. You must have the API module in order to use API functionalities -- contact us at sales@apicbase.com to add this module to your account.
\nThird parties must obtain those credentials directly from us. Contact us first at sales@apicbase.com if you are a third party that wishes to interact with customer data through the Apicbase API.
\nThe the quick start guide at our knowledge base contains detailed instructions on how to generate an access token and authorize your client into our API for the first time.
\nUse your client credentials to generate an access token.
\nThe authorization URL is https://app.apicbase.com/oauth/authorize/. A sample valid url will therefore look like https://app.apicbase.com/oauth/authorize/?response_type=code&client_id=MY_CLIENT_ID&scope=SCOPE1+SCOPE2.
The access token URL is https://app.apicbase.com/oauth/token/. With the authentication code obtained from the authorization URL, make a POST request to this URL with the following payload:
grant_type=\"authorization_code\",\ncode=\"YOUR_AUTHORIZATION_CODE\",\nredirect_uri=\"YOUR_REDIRECT_URI\",\nclient_id=\"YOUR_CLIENT_ID\",\nclient_secret=\"YOUR_CLIENT_SECRET\"\n\nPOST requests to the oauth/token endpoint must be encoded as x-www-form-urlencoded.
You may opt for sending your client's credentials in the Authorization header as Basic authentication. This also works. In this case, you can omit the client_id and the client_secret from the payload.
The authorization server will reply with an access token and a refresh token, as well as the allowed scopes and the expiration time (in seconds).
\nThe access token is used to both authenticate (tell Apicbase which library you're connecting to) and authorize (verify that you have the required permissions) your client. Include the access token in the Authorization header with each request, like so:
\ncurl --location \\\n--request GET 'https://app.apicbase.com/api/v1/outlets/' \\\n--header 'Authorization: Bearer {YOUR ACCESS TOKEN}'\n\nAn access token is tied to a library, so all actions will be performed in the library that the token you're using is tied to.
\nAs a third party, you must keep track of which libraries your tokens belong to.
\nThe access token expires automatically after some time. You might get a 401 Unauthorized if you're using an expired token. When that happens, request a new token using the refresh token by making a new POST request to the token endpoint:
curl -X POST \\\n -d \"grant_type=refresh_token&client_id=MY_CLIENT_ID&client_secret=MY_CLIENT_SECRET&refresh_token=MY_REFRESH_TOKEN\" \\\nhttps://app.apicbase.com/oauth/token/\n\nThe server will reply with a new set of access and refresh tokens. The old pair will be invalidated.
\nYour client can make requests to https://app.apicbase.com/oauth/introspect/ in order to check the validity of an access token. Include the token along with your client credentials in a GET request:
curl --location \\\n--request GET 'https://app.apicbase.com/oauth/introspect/?token=MY_ACCESS_TOKEN&client_id=MY_CLIENT_ID&client_secret=MY_CLIENT_SECRET'\n\nOr in a POST request, with those same parameters in the request body:
\ncurl -X POST -d \"token=MY_ACCESS_TOKEN&client_id=MY_CLIENT_ID&client_secret=MY_CLIENT_SECRET&refresh_token=MY_REFRESH_TOKEN\" \\\nhttps://app.apicbase.com/oauth/introspect/\n\nIf the token is valid, belongs to the authenticated client and is not expired, the server will reply with information about the token:
\n{\n \"active\": true,\n \"scope\": \"library sales accounts procurement\",\n \"exp\": 1613120953,\n \"client_id\": \"MY_CLIENT_ID\",\n \"username\": \"john.doe@apicbase.com\"\n}\n\nThe exp field contains a unix timestamp which represents the expiration date of the token. This response means that the token is valid and can be used to interact with the API.
If the token is valid but expired, the server will reply with a 200 OK response, but the following body:
{\n \"active\": false\n}\n\nThis means that your client should use the refresh token to request a new access token.
\nIf the token is invalid or does not belong to the given client, the server will reply with a 401 Unauthorized response.
The authorized scopes of your token define which endpoints it can be used to interact with. The following scopes have been defined:
\naccounts: Manage user accounts and permissionslibrary: View library items: ingredients, recipes, menus...procurement: View purchase orders and delivery information of orders made through Apicbasesales: Read and upload sales/POS datamedia: View images uploaded to ApicbaseFor security reasons, you should only request the scopes that are necessary for your application to function. You may request multiple scopes at a time: separate them with a + in the authorization code URL.
The permissions of the API account your application will be used to connect also determine the level of access your client will have. For example, if the API user in the library you're connecting to doesn't have admin rights, your application will be blocked from managing accounts in that library even if you've requested the accounts scope.
In order to maximize stability and ensure good service to all API users, the Apicbase API employs a rate limiting strategy. All API users are currently limited to 100 request per minute. This limit applies to trial as well as full customers and third-party partners, for read and write operations. If your application exceeds this limit, the server will respond with status code 429 Too Many Requests.
API users should do their best to avoid getting this error (for example, by introducing a sleep statement between requests) or implement a retry mechanism to handle these errors gracefully.
It's common to run into this issue when GET endpoints (e.g. the Recipe list endpoint) are accessed in quick succession. API users should keep in mind that it is not ideal to use the Apicbase API as a live API to serve real-time data about recipes, ingredients and other entities. The detail endpoints are particularly resource-intensive operations that aggregate large amounts of data to be served in a single JSON object.
For the sake of their own application flow, and in order to minimize the overhead of waiting for Apicbase to compile this data or of having requests denied by the rate limiter, clients should best employ strategies to avoid querying the Apicbase API for redundant data (i.e. unchanged since the last request) and generating unnecessary load. Customers will find the modified_date filter available on the list GET endpoints most useful for implementing such strategies.
To further help API consumers graciously handle rate limiting and avoid errors due to limits violation, we provide Rate Limiter Headers on every response from an endpoint bound by the rate limiter. The Rate Limiting Header contains three parameters:
\nBy using the information provided on the X-RateLimit-Remaining header, the API consumer can prevent a limit violation by not exceeding the number of requests left from the moment the response was received up to one minute after that.
In case a violation of the limit incurs and a 429 Too Many Requests is received, the API consumer can retrieve from the X-RateLimit-Wait header of the 429 response the amount of seconds it must wait before making the next request, in order to prevent further 429 responses.
The pseudo-python code below constitutes a routine that continuously fetches information from the /xyz endpoint at the limit allowed by the rate limiter. This routine demonstrates the use of both the X-RateLimit-Remaining and X-RateLimit-Wait.
while True:\n requests_left = 1\n while requests_left > 0:\n response = request.get('apicbase.com/xyz')\n requests_left = response.headers['X-RateLimit-Remaining']\n do_something_with_the_(response)\n wait_time = response.headers['X-RateLimit-Wait']\n time.sleep(wait_time)\n\nGets a list of all users with access to the library, and their permissions.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"A page number within the paginated result set. Starts at 1
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"A name value to query on
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"A username value to query on
\n","type":"text/plain"},"key":"username","value":""}],"variable":[]}},"response":[{"id":"bcdfe98b-3fc7-4d9b-855d-ebfbf950d795","name":"Without optional params","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/accounts/users/","host":["https://app.apicbase.com/api/v1/accounts"],"path":["users",""],"query":[{"key":"page","value":"1","description":"A page number within the paginated result set. Starts at 1","disabled":true},{"key":"name","value":"John","description":"A name value to query on","disabled":true},{"key":"username","value":"john.doe@apicbase.com","description":"A username value to query on","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/accounts/users/236700641440007/\",\n \"id\": \"236700641440007\",\n \"username\": \"john.doe@apicbase.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"created_date\": \"2020-06-16T16:01:14.447462+02:00\",\n \"permissions\": {\n \"admin\": false,\n \"write\": true,\n \"delete\": false,\n \"share\": false,\n \"image_upload\": true,\n \"financial\": false,\n \"allergen_verification\": true\n }\n },\n {\n \"url\": \"https://www.apicbase.com/api/v1/accounts/users/236300957450001/\",\n \"id\": \"236300957450001\",\n \"username\": \"john.smith@apicbase.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"created_date\": \"2020-06-16T12:37:38.457149+02:00\",\n \"permissions\": {\n \"admin\": true,\n \"write\": true,\n \"delete\": true,\n \"share\": true,\n \"image_upload\": true,\n \"financial\": true,\n \"allergen_verification\": true\n }\n }\n ]\n}"},{"id":"d9393c59-df4a-4e3f-856d-b38f9d2520b5","name":"With optional params","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/accounts/users/?page=1&name=John&username=john.doe@apicbase.com","host":["https://app.apicbase.com/api/v1/accounts"],"path":["users",""],"query":[{"key":"page","value":"1","description":"A page number within the paginated result set. Starts at 1"},{"key":"name","value":"John","description":"A name value to query on"},{"key":"username","value":"john.doe@apicbase.com","description":"A username value to query on"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/accounts/users/236700641440007/\",\n \"id\": \"236700641440007\",\n \"username\": \"john.doe@apicbase.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"created_date\": \"2020-06-16T16:01:14.447462+02:00\",\n \"permissions\": {\n \"admin\": false,\n \"write\": true,\n \"delete\": false,\n \"share\": false,\n \"image_upload\": true,\n \"financial\": false,\n \"allergen_verification\": true\n }\n }\n ]\n}"}],"_postman_id":"546f26f9-02b6-4d14-82d4-7a5dfb0c6e3d"},{"name":"Get user details","id":"a293a0c9-8c0c-4fe9-84c8-44eed6209699","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.apicbase.com/api/v1/accounts/users/{{userId}}/","description":"Gets information about a specific user in the library.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"Removes a user from the library. The user is not deleted, but their access to the library is revoked. If the user still exists in another library, they will continue to be able to access it.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"This collection of endpoints is used to manage users in a library and their permissions.
\n","event":[{"listen":"prerequest","script":{"id":"86609e46-d847-4ad0-bf03-80c8a0aa29ec","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3ca7ac27-08ed-4b16-8a00-cd82735c4fe9","type":"text/javascript","exec":[""]}}],"_postman_id":"7db0948e-7b7c-47e8-94be-acedeb0c46fe","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"Gets a list of outlets in the library, complete with information about them.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"A page number within the paginated result set. Starts at 1
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"A name value to query on
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"A field to order the results on
\n","type":"text/plain"},"key":"ordering","value":""}],"variable":[]}},"response":[{"id":"8d9ef1c6-8363-4105-8246-fba052083841","name":"Without optional params","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/accounts/outlets/","host":["https://app.apicbase.com/api/v1/accounts"],"path":["outlets",""],"query":[{"key":"page","value":"1","description":"A page number within the paginated result set. Starts at 1","disabled":true},{"key":"name","value":"Antwerpen","description":"A name value to query on","disabled":true},{"key":"ordering","value":"name","description":"A field to order the results on","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 3,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/accounts/outlets/729100535470009/\",\n \"id\": \"729100535470009\",\n \"name\": \"Gent\",\n \"description\": null,\n \"supplier\": {\n \"id\": \"425220328090009\",\n \"url\": \"https://app.apicbase.com/api/v1/contact/425220328090009/\",\n \"company_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"avatar\": \"https://production-apicvault-static.s3.amazonaws.com/apicbase/images/avatar.png\",\n \"telephone\": null,\n \"mobile\": null,\n \"email\": null,\n \"website\": null,\n \"facebook_url\": null,\n \"twitter_url\": null,\n \"instagram_url\": null,\n \"linkedin_url\": null,\n \"street\": null,\n \"number\": null,\n \"postal_code\": null,\n \"city\": null,\n \"country\": null\n }\n },\n {\n \"url\": \"https://app.apicbase.com/api/v1/accounts/outlets/829100725420008/\",\n \"id\": \"829100725420008\",\n \"name\": \"Brussel\",\n \"description\": null,\n \"supplier\": {\n \"id\": \"525220818060002\",\n \"url\": \"https://app.apicbase.com/api/v1/contact/525220818060002/\",\n \"company_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"avatar\": \"https://production-apicvault-static.s3.amazonaws.com/apicbase/images/avatar.png\",\n \"telephone\": null,\n \"mobile\": null,\n \"email\": null,\n \"website\": null,\n \"facebook_url\": null,\n \"twitter_url\": null,\n \"instagram_url\": null,\n \"linkedin_url\": null,\n \"street\": null,\n \"number\": null,\n \"postal_code\": null,\n \"city\": null,\n \"country\": null\n }\n },\n {\n \"url\": \"https://app.apicbase.com/api/v1/accounts/outlets/229100415400002/\",\n \"id\": \"229100415400002\",\n \"name\": \"Antwerpen\",\n \"description\": null,\n \"supplier\": {\n \"id\": \"525220897070005\",\n \"url\": \"https://app.apicbase.com/api/v1/contact/525220897070005/\",\n \"company_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"avatar\": \"https://production-apicvault-static.s3.amazonaws.com/apicbase/images/avatar.png\",\n \"telephone\": null,\n \"mobile\": null,\n \"email\": null,\n \"website\": null,\n \"facebook_url\": null,\n \"twitter_url\": null,\n \"instagram_url\": null,\n \"linkedin_url\": null,\n \"street\": null,\n \"number\": null,\n \"postal_code\": null,\n \"city\": null,\n \"country\": null\n }\n }\n ]\n}"},{"id":"d5044610-91e3-49c4-b64b-4bbf80e8952f","name":"With optional params","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/accounts/outlets/?page=1&name=Antwerpen&ordering=name","host":["https://app.apicbase.com/api/v1/accounts"],"path":["outlets",""],"query":[{"key":"page","value":"1","description":"A page number within the paginated result set. Starts at 1"},{"key":"name","value":"Antwerpen","description":"A name value to query on"},{"key":"ordering","value":"name","description":"A field to order the results on"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/accounts/outlets/229100415400002/\",\n \"id\": \"229100415400002\",\n \"name\": \"Antwerpen\",\n \"description\": null,\n \"supplier\": {\n \"id\": \"525220897070005\",\n \"url\": \"https://app.apicbase.com/api/v1/contact/525220897070005/\",\n \"company_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"avatar\": \"https://production-apicvault-static.s3.amazonaws.com/apicbase/images/avatar.png\",\n \"telephone\": null,\n \"mobile\": null,\n \"email\": null,\n \"website\": null,\n \"facebook_url\": null,\n \"twitter_url\": null,\n \"instagram_url\": null,\n \"linkedin_url\": null,\n \"street\": null,\n \"number\": null,\n \"postal_code\": null,\n \"city\": null,\n \"country\": null\n }\n }\n ]\n}"}],"_postman_id":"3e7ce0da-b8ea-4485-9547-36b6dde5bc00"},{"name":"Get outlet details","id":"5f5fd4b3-ce53-45d1-b6d3-f7297516cb66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.apicbase.com/api/v1/accounts/outlets/{{outletId}}/","description":"Gets information about a specific outlet in the library.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"Gets a list of ingredients in the library. Optional params can be used to filter and sort the results. Results are paginated, with 10 items being shown by page by default, but more records can be requested by page by specifying a page_size value.
Supports the following filters: name, short_name, composition, category, subcategory, created_by, allergen_verified, supplier, supplier_email, created_date[__gt|__lt], modified_date[__gt|__lt], custom_fields.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"A page number within the paginated result set
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Amount of records per page (max 200)
\n","type":"text/plain"},"key":"page_size","value":null},{"disabled":true,"description":{"content":"A name or part of one to filter on
\n","type":"text/plain"},"key":"name","value":null},{"disabled":true,"description":{"content":"The ingredient's short name
\n","type":"text/plain"},"key":"short_name","value":null},{"disabled":true,"description":{"content":"Composition
\n","type":"text/plain"},"key":"composition","value":null},{"disabled":true,"description":{"content":"Category
\n","type":"text/plain"},"key":"category","value":null},{"disabled":true,"description":{"content":"Subcategory
\n","type":"text/plain"},"key":"subcategory","value":null},{"disabled":true,"description":{"content":"The ID of the creator
\n","type":"text/plain"},"key":"created_by","value":null},{"disabled":true,"description":{"content":"Whether the ingredient's allergens are verified (true/false)
\n","type":"text/plain"},"key":"allergen_verified","value":null},{"disabled":true,"description":{"content":"Filter on suppliers by ID
\n","type":"text/plain"},"key":"supplier","value":null},{"disabled":true,"description":{"content":"Filter on suppliers by email
\n","type":"text/plain"},"key":"supplier_email","value":null},{"disabled":true,"description":{"content":"Creation_date
\n","type":"text/plain"},"key":"created_date","value":null},{"disabled":true,"key":"created_date__gt","value":null},{"disabled":true,"key":"created_date__lt","value":null},{"disabled":true,"description":{"content":"Modification date
\n","type":"text/plain"},"key":"modified_date","value":null},{"disabled":true,"key":"modified_date__gt","value":null},{"disabled":true,"key":"modified_date__lt","value":null},{"disabled":true,"description":{"content":"Custom fields
\n","type":"text/plain"},"key":"custom_fields","value":null}],"variable":[]}},"response":[{"id":"b838462a-2b3a-4736-87ab-a72bc7e1c28b","name":"Without optional params","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/products/ingredients/","host":["https://app.apicbase.com/api/v1/products"],"path":["ingredients",""],"query":[{"key":"page","value":"1","description":"A page number within the paginated result set","type":"text","disabled":true},{"key":"name","value":"Milk","description":"A name to query on","type":"text","disabled":true},{"key":"supplier","value":"ordering@happycowproducts.com","type":"text","disabled":true},{"key":"uid","value":"444444","description":"An internal UID to query on","type":"text","disabled":true},{"key":"category","value":"Dairy","description":"A category to filter on","type":"text","disabled":true},{"key":"approved","value":"true","description":"An approved status to filter on (true/false)","type":"text","disabled":true},{"key":"start_date","value":"2020-06-01","description":"Return products created after this date","type":"text","disabled":true},{"key":"end_date","value":"2020-06-30","description":"Return products created before this date","type":"text","disabled":true},{"key":"ordering","value":"category","description":"A field to order the results on","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/ingredients/264556747770006/\",\n \"id\": \"264556747770006\",\n \"gtin\": \"44100262692\",\n \"supplier_article_number\": \"100020\",\n \"internal_uid\": \"444444\",\n \"external_uid\": \"123456\",\n \"name\": \"Milk\",\n \"short_name\": \"\",\n \"composition\": \"Some information goes here.\",\n \"description\": \"More information about the ingredient.\",\n \"brand\": \"Happy Cow Products\",\n \"category\": \"Dairy\",\n \"subcategory\": \"Milk\",\n \"article_type\": \"\",\n \"storage_instructions\": \"Don't let it stay out too long\",\n \"shelf_life\": \"3 months\",\n \"created_date\": \"2020-06-16T17:48:40.971604+02:00\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"modified_date\": \"2020-06-16T17:48:40.988036+02:00\",\n \"suppliers\": [\n {\n \"id\": \"325220129010007\",\n \"url\": \"https://app.apicbase.com/api/v1/contact/325220129010007/\",\n \"company_name\": \"Happy Cow Products\",\n \"first_name\": \"Matthew\",\n \"last_name\": \"Smith\",\n \"avatar\": \"https://production-apicvault-static.s3.amazonaws.com/apicbase/images/avatar.png\",\n \"telephone\": \"+321234567890\",\n \"mobile\": \"\",\n \"email\": null,\n \"website\": null,\n \"facebook_url\": null,\n \"twitter_url\": null,\n \"instagram_url\": null,\n \"linkedin_url\": null,\n \"street\": \"Main Street\",\n \"number\": \"12\",\n \"postal_code\": \"2000\",\n \"city\": \"Brussels\",\n \"country\": null\n }\n ],\n \"approved\": true,\n \"in_use\": false,\n \"allergen_verified\": false,\n \"custom_fields\": [\n {\n \"name\": \"Accounting Category\",\n \"value\": null\n },\n {\n \"name\": \"Category\",\n \"value\": null\n },\n {\n \"name\": \"Subcategory\",\n \"value\": null\n },\n {\n \"name\": \"Free Text Field\",\n \"value\": \"I type this freely\"\n },\n {\n \"name\": \"Multi Choice Field\",\n \"value\": [\n \"Choice 1\",\n \"Choice 3\"\n ]\n }\n ],\n \"main_stock_items\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/stock_items/421794978110009/\"\n },\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/stock_items/121794868100003/\"\n },\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/stock_items/521794758100007/\"\n }\n ]\n },\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/ingredients/964556037770002/\",\n \"id\": \"964556037770002\",\n \"gtin\": \"\",\n \"supplier_article_number\": null,\n \"internal_uid\": \"05400141090284\",\n \"external_uid\": \"\",\n \"name\": \"Egg\",\n \"short_name\": \"Tomato\",\n \"composition\": \"\",\n \"description\": \"\",\n \"brand\": \"Joey's Eggs\",\n \"category\": \"\",\n \"subcategory\": \"\",\n \"article_type\": \"\",\n \"storage_instructions\": \"\",\n \"shelf_life\": \"\",\n \"created_date\": \"2020-06-16T17:43:50.043180+02:00\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"modified_date\": \"2020-06-16T17:43:50.057521+02:00\",\n \"suppliers\": [],\n \"approved\": true,\n \"in_use\": true,\n \"allergen_verified\": false,\n \"custom_fields\": [\n {\n \"name\": \"Accounting Category\",\n \"value\": null\n },\n {\n \"name\": \"Category\",\n \"value\": null\n },\n {\n \"name\": \"Subcategory\",\n \"value\": null\n },\n {\n \"name\": \"Free Text Field\",\n \"value\": null\n },\n {\n \"name\": \"Multi Choice Field\",\n \"value\": null\n }\n ],\n \"main_stock_items\": []\n }\n ]\n}"},{"id":"bb2de684-aaaf-4652-be24-abbc8c6a9c22","name":"With optional params","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/products/ingredients/?page=1&name=Milk&supplier=ordering@happycowproducts.com&uid=444444&category=Dairy&approved=true&start_date=2020-06-01&end_date=2020-06-30&ordering=category","host":["https://app.apicbase.com/api/v1/products"],"path":["ingredients",""],"query":[{"key":"page","value":"1","description":"A page number within the paginated result set"},{"key":"name","value":"Milk","description":"A name to query on"},{"key":"supplier","value":"ordering@happycowproducts.com"},{"key":"uid","value":"444444","description":"An internal UID to query on"},{"key":"category","value":"Dairy","description":"A category to filter on"},{"key":"approved","value":"true","description":"An approved status to filter on (true/false)"},{"key":"start_date","value":"2020-06-01","description":"Return products created after this date"},{"key":"end_date","value":"2020-06-30","description":"Return products created before this date"},{"key":"ordering","value":"category","description":"A field to order the results on"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/ingredients/264556747770006/\",\n \"id\": \"264556747770006\",\n \"gtin\": \"44100262692\",\n \"supplier_article_number\": \"100020\",\n \"internal_uid\": \"444444\",\n \"external_uid\": \"123456\",\n \"name\": \"Milk\",\n \"short_name\": \"\",\n \"composition\": \"Some information goes here.\",\n \"description\": \"More information about the ingredient.\",\n \"brand\": \"Happy Cow Products\",\n \"category\": \"Dairy\",\n \"subcategory\": \"Milk\",\n \"article_type\": \"\",\n \"storage_instructions\": \"Don't let it stay out too long\",\n \"shelf_life\": \"3 months\",\n \"created_date\": \"2020-06-16T17:48:40.971604+02:00\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"modified_date\": \"2020-06-16T17:48:40.988036+02:00\",\n \"suppliers\": [\n {\n \"id\": \"325220129010007\",\n \"url\": \"https://app.apicbase.com/api/v1/contact/325220129010007/\",\n \"company_name\": \"Happy Cow Products\",\n \"first_name\": \"Matthew\",\n \"last_name\": \"Smith\",\n \"avatar\": \"https://production-apicvault-static.s3.amazonaws.com/apicbase/images/avatar.png\",\n \"telephone\": \"+321234567890\",\n \"mobile\": \"\",\n \"email\": null,\n \"website\": null,\n \"facebook_url\": null,\n \"twitter_url\": null,\n \"instagram_url\": null,\n \"linkedin_url\": null,\n \"street\": \"Main Street\",\n \"number\": \"12\",\n \"postal_code\": \"2000\",\n \"city\": \"Brussels\",\n \"country\": null\n }\n ],\n \"approved\": true,\n \"in_use\": false,\n \"allergen_verified\": false,\n \"custom_fields\": [\n {\n \"name\": \"Accounting Category\",\n \"value\": null\n },\n {\n \"name\": \"Category\",\n \"value\": null\n },\n {\n \"name\": \"Subcategory\",\n \"value\": null\n },\n {\n \"name\": \"Free Text Field\",\n \"value\": \"I type this freely\"\n },\n {\n \"name\": \"Multi Choice Field\",\n \"value\": [\n \"Choice 1\",\n \"Choice 3\"\n ]\n }\n ],\n \"main_stock_items\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/stock_items/421794978110009/\"\n },\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/stock_items/121794868100003/\"\n },\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/stock_items/521794758100007/\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"90961d9b-78d6-4bec-8436-a2c8e536eebb"},{"name":"Get ingredient details","id":"c2443141-b9e2-45b4-b133-a0cb4647d31b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.apicbase.com/api/v1/products/ingredients/{{ingredientId}}/","description":"Gets information about a specific ingredient.
\nAllergen data:
\n0 = does not contain
1 = contains
2 = may contain traces of
3 = unknown
Creates a new instance of an ingredient.
\nWatch out: the POST method is strictly for creating new entries. Making repeated POST requests with the same payload will create duplicates! To update an existing ingredient, make a PATCH request.
\nThe only required field is name. All other fields are optional.
Uniqueness is enforced on the internal_uid field (when provided), meaning that no two entries can have the same value for this field. When attempting to create entries with duplicated UIDs, the server will respond with a 400 Bad Request error.
Edits an existing ingredient. The same fields available and restrictions applied to the POST method also apply here. For this method, only fields included in the request body will be modified; omitted fields will keep their current values.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"Gets a list of menus in the library. Optional params can be used to filter and sort the results. Results are paginated, with 10 items being shown by page by default.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"A page number within the paginated result set
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"A name to query on
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"A UID (reference number) to filter on
\n","type":"text/plain"},"key":"uid","value":""},{"disabled":true,"description":{"content":"Filter by the contents of the menus' description
\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"A user ID to filter on
\n","type":"text/plain"},"key":"created_by","value":""},{"disabled":true,"description":{"content":"The menus' creation date (YYYY-MM-DD)
\n","type":"text/plain"},"key":"created_date","value":""},{"disabled":true,"key":"created_date__gt","value":null},{"disabled":true,"key":"created_date__lt","value":null},{"disabled":true,"description":{"content":"The menus' last modified date (YYYY-MM-DD)
\n","type":"text/plain"},"key":"modified_date","value":null},{"disabled":true,"key":"modified_date__gt","value":null},{"disabled":true,"key":"modified_date__lt","value":null},{"disabled":true,"description":{"content":"The menus' start date (YYYY-MM-DD)
\n","type":"text/plain"},"key":"starting_date","value":null},{"disabled":true,"key":"starting_date__gt","value":null},{"disabled":true,"key":"starting_date__lt","value":null},{"disabled":true,"description":{"content":"The menus' end date (YYYY-MM-DD)
\n","type":"text/plain"},"key":"ending_date","value":null},{"disabled":true,"key":"ending_date__gt","value":null},{"disabled":true,"key":"ending_date__lt","value":null},{"disabled":true,"description":{"content":"The menus' sell price (exact)
\n","type":"text/plain"},"key":"current_sell_price","value":null},{"disabled":true,"key":"current_sell_price__gt","value":null},{"disabled":true,"key":"current_sell_price__lt","value":null},{"disabled":true,"description":{"content":"The menus' VAT rate (exact)
\n","type":"text/plain"},"key":"vat","value":null},{"disabled":true,"key":"vat__gt","value":null},{"disabled":true,"key":"vat__lt","value":null},{"disabled":true,"description":{"content":"A field to order the results by
\n","type":"text/plain"},"key":"ordering","value":null},{"disabled":true,"description":{"content":"Custom fields
\n","type":"text/plain"},"key":"custom_fields","value":null}],"variable":[]}},"response":[{"id":"ef04dd5c-df42-46ed-b330-ba942207c2a4","name":"With optional params","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/products/menus/?page=1&name=Spaghetti&created_after=2020-06-01&created_before=2020-06-30&uid=1000&ordering=-name","host":["https://app.apicbase.com/api/v1/products"],"path":["menus",""],"query":[{"key":"page","value":"1"},{"key":"name","value":"Spaghetti"},{"key":"created_after","value":"2020-06-01"},{"key":"created_before","value":"2020-06-30"},{"key":"uid","value":"1000"},{"key":"ordering","value":"-name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/menus/390400735470004/\",\n \"id\": \"390400735470004\",\n \"name\": \"Spaghetti Special Menu\",\n \"uid\": \"1000\",\n \"description\": \"A menu for all tastes.\",\n \"created_date\": \"2020-06-17T11:54:31.484550+02:00\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"modified_date\": \"2020-06-17T11:55:36.303100+02:00\",\n \"courses\": [\n {\n \"name\": \"Main Course\",\n \"recipes\": [\n \"https://app.apicbase.com/api/v1/products/recipes/349980442190000/\",\n \"https://app.apicbase.com/api/v1/products/recipes/749980262120005/\"\n ]\n },\n {\n \"name\": \"Dessert\",\n \"recipes\": [\n \"https://app.apicbase.com/api/v1/products/recipes/549980272150003/\"\n ]\n }\n ],\n \"cycle_year\": null,\n \"cycle_week\": null,\n \"cycle_day\": null,\n \"starting_date\": \"2020-06-01\",\n \"ending_date\": \"2020-08-31\",\n \"time_of_day\": \"12:00:00\",\n \"vat\": \"12.00\",\n \"target_profit_margin\": \"60.00\",\n \"current_sell_price\": {\n \"created\": \"2020-06-17 11:55:36.302531\",\n \"pricing\": 16,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n \"sell_price_history\": [\n {\n \"created\": \"2020-06-17 11:55:32.387997\",\n \"pricing\": 16,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n }\n ],\n \"custom_fields\": [\n {\n \"name\": \"Menu Choice Field\",\n \"value\": \"Choice 2\"\n }\n ]\n }\n ]\n}"},{"id":"7923dcc1-53b0-4b19-b5c9-293c96387f59","name":"Without optional params","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/products/menus/","host":["https://app.apicbase.com/api/v1/products"],"path":["menus",""],"query":[{"key":"page","value":"1","disabled":true},{"key":"name","value":"Spaghetti","disabled":true},{"key":"created_after","value":"2020-06-01","disabled":true},{"key":"created_before","value":"2020-06-30","disabled":true},{"key":"uid","value":"1000","disabled":true},{"key":"ordering","value":"-name","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/menus/990400245400005/\",\n \"id\": \"990400245400005\",\n \"name\": \"Second Menu\",\n \"uid\": \"\",\n \"description\": \"\",\n \"created_date\": \"2020-06-17T12:11:33.452280+02:00\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"modified_date\": \"2020-06-17T12:11:33.452297+02:00\",\n \"courses\": [],\n \"cycle_year\": null,\n \"cycle_week\": null,\n \"cycle_day\": null,\n \"starting_date\": null,\n \"ending_date\": null,\n \"time_of_day\": null,\n \"vat\": \"12.00\",\n \"target_profit_margin\": null,\n \"current_sell_price\": {\n \"created\": \"2020-06-17 12:11:33.445185\",\n \"pricing\": 10,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n \"sell_price_history\": [],\n \"custom_fields\": [\n {\n \"name\": \"Menu Choice Field\",\n \"value\": null\n }\n ]\n },\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/menus/390400735470004/\",\n \"id\": \"390400735470004\",\n \"name\": \"Spaghetti Special Menu\",\n \"uid\": \"1000\",\n \"description\": \"A menu for all tastes.\",\n \"created_date\": \"2020-06-17T11:54:31.484550+02:00\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"modified_date\": \"2020-06-17T11:55:36.303100+02:00\",\n \"courses\": [\n {\n \"name\": \"Main Course\",\n \"recipes\": [\n \"https://app.apicbase.com/api/v1/products/recipes/349980442190000/\",\n \"https://app.apicbase.com/api/v1/products/recipes/749980262120005/\"\n ]\n },\n {\n \"name\": \"Dessert\",\n \"recipes\": [\n \"https://app.apicbase.com/api/v1/products/recipes/549980272150003/\"\n ]\n }\n ],\n \"cycle_year\": null,\n \"cycle_week\": null,\n \"cycle_day\": null,\n \"starting_date\": \"2020-06-01\",\n \"ending_date\": \"2020-08-31\",\n \"time_of_day\": \"12:00:00\",\n \"vat\": \"12.00\",\n \"target_profit_margin\": \"60.00\",\n \"current_sell_price\": {\n \"created\": \"2020-06-17 11:55:36.302531\",\n \"pricing\": 16,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n \"sell_price_history\": [\n {\n \"created\": \"2020-06-17 11:55:32.387997\",\n \"pricing\": 16,\n \"user_pk\": 3475,\n \"username\": \"thiago@apicbase.com\"\n }\n ],\n \"custom_fields\": [\n {\n \"name\": \"Menu Choice Field\",\n \"value\": \"Choice 2\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"dec0e8bb-6cd5-4f5a-baa7-23b9b9a732e6"},{"name":"Get menu details","id":"83eab303-9810-4188-b290-547ed6e300d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.apicbase.com/api/v1/products/menus/{{menuId}}/","description":"Gets information about a specific menu.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"Gets a list of menus linked to a given outlet. Optional params can be used to filter and sort the results. Results are paginated, with 10 items being shown by page by default.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"A page number within the paginated result set
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"A name to query on
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"A UID (reference number) to filter on
\n","type":"text/plain"},"key":"uid","value":""},{"disabled":true,"description":{"content":"Filter by the contents of the menus' description
\n","type":"text/plain"},"key":"description","value":null},{"disabled":true,"description":{"content":"A user ID to filter on
\n","type":"text/plain"},"key":"created_by","value":null},{"disabled":true,"description":{"content":"The menus' creation date
\n","type":"text/plain"},"key":"created_date","value":""},{"disabled":true,"key":"created_date__gt","value":""},{"disabled":true,"key":"created_date__lt","value":""},{"disabled":true,"description":{"content":"The menus' last modified date
\n","type":"text/plain"},"key":"modified_date","value":""},{"disabled":true,"key":"modified_date__gt","value":""},{"disabled":true,"key":"modified_date__lt","value":""},{"disabled":true,"description":{"content":"The menus' start date
\n","type":"text/plain"},"key":"starting_date","value":""},{"disabled":true,"key":"starting_date__gt","value":""},{"disabled":true,"key":"starting_date__lt","value":""},{"disabled":true,"description":{"content":"The menus' end date
\n","type":"text/plain"},"key":"ending_date","value":""},{"disabled":true,"key":"ending_date__gt","value":""},{"disabled":true,"key":"ending_date__lt","value":""},{"disabled":true,"description":{"content":"The menus' sell price (exact)
\n","type":"text/plain"},"key":"current_sell_price","value":null},{"disabled":true,"key":"current_sell_price__gt","value":null},{"disabled":true,"key":"current_sell_price__lt","value":null},{"disabled":true,"description":{"content":"The menus' VAT rate (exact)
\n","type":"text/plain"},"key":"vat","value":null},{"disabled":true,"key":"vat__gt","value":null},{"disabled":true,"key":"vat__lt","value":null},{"disabled":true,"description":{"content":"A field to order the results by
\n","type":"text/plain"},"key":"ordering","value":""},{"disabled":true,"description":{"content":"Custom fields
\n","type":"text/plain"},"key":"custom_fields","value":null}],"variable":[]}},"response":[{"id":"cac3ec41-a414-4738-9f0e-3bf73ed6c9a6","name":"Success response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/products/outlets/{{outletId}}/menus/","host":["https://app.apicbase.com/api/v1/products"],"path":["outlets","{{outletId}}","menus",""],"query":[{"key":"page","value":"","description":"A page number within the paginated result set","disabled":true},{"key":"name","value":"","description":"A name to query on","disabled":true},{"key":"created_after","value":"","description":"Get created after this date","disabled":true},{"key":"created_before","value":"","description":"Get created before this date","disabled":true},{"key":"uid","value":"","description":"An internal UID to query on","disabled":true},{"key":"ordering","value":"","description":"A field to order the results on","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/menus/990400245400005/\",\n \"id\": \"990400245400005\",\n \"name\": \"Second Menu\",\n \"uid\": \"\",\n \"description\": \"\",\n \"created_date\": \"2020-06-17T12:11:33.452280+02:00\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"modified_date\": \"2020-06-17T12:11:33.452297+02:00\",\n \"courses\": [],\n \"cycle_year\": null,\n \"cycle_week\": null,\n \"cycle_day\": null,\n \"starting_date\": null,\n \"ending_date\": null,\n \"time_of_day\": null,\n \"vat\": \"12.00\",\n \"target_profit_margin\": null,\n \"current_sell_price\": {\n \"created\": \"2020-06-17 12:11:33.445185\",\n \"pricing\": 10,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n \"sell_price_history\": [],\n \"custom_fields\": [\n {\n \"name\": \"Menu Choice Field\",\n \"value\": null\n }\n ]\n },\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/menus/390400735470004/\",\n \"id\": \"390400735470004\",\n \"name\": \"Spaghetti Special Menu\",\n \"uid\": \"1000\",\n \"description\": \"A menu for all tastes.\",\n \"created_date\": \"2020-06-17T11:54:31.484550+02:00\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"modified_date\": \"2020-06-17T11:55:36.303100+02:00\",\n \"courses\": [\n {\n \"name\": \"Main Course\",\n \"recipes\": [\n \"https://app.apicbase.com/api/v1/products/recipes/349980442190000/\",\n \"https://app.apicbase.com/api/v1/products/recipes/749980262120005/\"\n ]\n },\n {\n \"name\": \"Dessert\",\n \"recipes\": [\n \"https://app.apicbase.com/api/v1/products/recipes/549980272150003/\"\n ]\n }\n ],\n \"cycle_year\": null,\n \"cycle_week\": null,\n \"cycle_day\": null,\n \"starting_date\": \"2020-06-01\",\n \"ending_date\": \"2020-08-31\",\n \"time_of_day\": \"12:00:00\",\n \"vat\": \"12.00\",\n \"target_profit_margin\": \"60.00\",\n \"current_sell_price\": {\n \"created\": \"2020-06-17 11:55:36.302531\",\n \"pricing\": 16,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n \"sell_price_history\": [\n {\n \"created\": \"2020-06-17 11:55:32.387997\",\n \"pricing\": 16,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n }\n ],\n \"custom_fields\": [\n {\n \"name\": \"Menu Choice Field\",\n \"value\": \"Choice 2\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"b5d56cdd-a82b-41da-ab63-77c998e509a9"},{"name":"Get courses in a menu","id":"681df5c5-061d-476c-892c-2e6416d917fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.apicbase.com/api/v1/products/menus/{{menuId}}/courses/","description":"Gets a menu's courses. Results are paginated, with 10 items being shown by page.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"A page number within the paginated result set.
\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[{"id":"e9c5613f-6bfe-4fb1-a8b5-7ee6fa3d2956","name":"Success response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/products/menus/{{menuId}}/courses/","host":["https://app.apicbase.com/api/v1/products"],"path":["menus","{{menuId}}","courses",""],"query":[{"description":"A page number within the paginated result set.","key":"page","type":"text","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"name\": \"Main Course\",\n \"recipes\": [\n \"https://app.apicbase.com/api/v1/products/recipes/349980442190000/\",\n \"https://app.apicbase.com/api/v1/products/recipes/749980262120005/\"\n ]\n },\n {\n \"name\": \"Dessert\",\n \"recipes\": [\n \"https://app.apicbase.com/api/v1/products/recipes/549980272150003/\"\n ]\n }\n ]\n}"}],"_postman_id":"681df5c5-061d-476c-892c-2e6416d917fe"},{"name":"Get recipes","id":"db4386f2-8b2a-48b3-a666-de4af902a0a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.apicbase.com/api/v1/products/recipes/","description":"Gets a list of recipes in the library. Optional params can be used to filter and sort the results. Results are paginated, with 10 items being shown by page, but more records can be requested by page by specifying a page_size value.
Supports the following filters: name, uid, persons[__gt|__lt], vat[__gt|__lt], current_sell_price[__gt|__lt], created_date[__gt|__lt], modified_date[__gt|__lt], created_by, original, net_weight[__gt|__lt], net_volume[__gt|__lt], prep_time[__gt|__lt], prep_time_passive[__gt|__lt], cooking_time[__gt|__lt], cooking_time_passive[__gt|__lt], plating_time[__gt|__lt], plating_time_passive[__gt|__lt], custom_fields
\nNote: See examples for how to filter on custom fields.
\nAbout filtering on modified_date: the modified_date field reflects modifications to a Recipe's data fields and not changes in the potential outcomes of calculated fields, such as allergens, food cost and nutrition info. Those fields (available in the Recipe detail endpoint) are calculated from data native to the Recipe's individual Ingredients -- those Ingredients' modified_date attributes must be tracked in order to detect potential changes in the calculated attributes of Recipes that contain them.
A page number within the paginated result set
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"The amount of records per page (max 200)
\n","type":"text/plain"},"key":"page_size","value":null},{"disabled":true,"description":{"content":"A name to query on
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"An internal UID to query on
\n","type":"text/plain"},"key":"uid","value":""},{"disabled":true,"description":{"content":"Amount of servings
\n","type":"text/plain"},"key":"persons","value":null},{"disabled":true,"key":"persons__gt","value":null},{"disabled":true,"key":"persons__lt","value":null},{"disabled":true,"description":{"content":"VAT percentage
\n","type":"text/plain"},"key":"vat","value":null},{"disabled":true,"key":"vat__gt","value":null},{"disabled":true,"key":"vat__lt","value":null},{"disabled":true,"description":{"content":"Sell price (decimal)
\n","type":"text/plain"},"key":"current_sell_price","value":null},{"disabled":true,"key":"current_sell_price__gt","value":null},{"disabled":true,"key":"current_sell_price__lt","value":null},{"disabled":true,"description":{"content":"Most recent modification date
\n","type":"text/plain"},"key":"modified_date","value":null},{"disabled":true,"key":"modified_date__gt","value":null},{"disabled":true,"key":"modified_date__lt","value":null},{"disabled":true,"description":{"content":"Creation date
\n","type":"text/plain"},"key":"created_date","value":null},{"disabled":true,"key":"created_date__gt","value":null},{"disabled":true,"key":"created_date__lt","value":null},{"disabled":true,"description":{"content":"The ID of the user who created
\n","type":"text/plain"},"key":"created_by","value":null},{"disabled":true,"description":{"content":"The ID of the original recipe (get a recipe's clones)
\n","type":"text/plain"},"key":"original","value":null},{"disabled":true,"description":{"content":"Net weight
\n","type":"text/plain"},"key":"net_weight","value":null},{"disabled":true,"key":"net_weight__gt","value":null},{"disabled":true,"key":"net_weight__lt","value":null},{"disabled":true,"description":{"content":"Net volume
\n","type":"text/plain"},"key":"net_volume","value":null},{"disabled":true,"key":"net_volume__gt","value":null},{"disabled":true,"key":"net_volume__lt","value":null},{"disabled":true,"description":{"content":"Preparation time (hh:mm:ss)
\n","type":"text/plain"},"key":"prep_time","value":null},{"disabled":true,"key":"prep_time__gt","value":null},{"disabled":true,"key":"prep_time__lt","value":null},{"disabled":true,"description":{"content":"Cooking time (hh:mm:ss)
\n","type":"text/plain"},"key":"cooking_time","value":null},{"disabled":true,"key":"cooking_time__gt","value":null},{"disabled":true,"key":"cooking_time__lt","value":null},{"disabled":true,"description":{"content":"Plating time (hh:mm:ss)
\n","type":"text/plain"},"key":"plating_time","value":null},{"disabled":true,"key":"plating_time__gt","value":null},{"disabled":true,"key":"plating_time__lt","value":null},{"disabled":true,"description":{"content":"Custom fields
\n","type":"text/plain"},"key":"custom_fields","value":""}],"variable":[]}},"response":[{"id":"088d46f7-9ba6-4252-8166-b0607a7f236e","name":"Without optional params","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/products/recipes/","host":["https://app.apicbase.com/api/v1/products"],"path":["recipes",""],"query":[{"key":"page","value":"","type":"text","description":"A page number within the paginated result set","disabled":true},{"key":"uid","value":"","type":"text","description":"An internal UID to query on","disabled":true},{"key":"min_persons","value":"","type":"text","description":"Minimum amount of servings","disabled":true},{"key":"max_persons","value":"","type":"text","description":"Maximum amount of servings","disabled":true},{"key":"start_date","value":"","type":"text","description":"Get created after this date","disabled":true},{"key":"end_date","value":"","type":"text","description":"Get created before this date","disabled":true},{"key":"prepping_time_greater","value":"","type":"text","description":"Get recipes with prep time greater than this. Format: hh:mm:ss","disabled":true},{"key":"prepping_time_lower","value":"","type":"text","description":"Get recipes with prep time lesser than this. Format: hh:mm:ss","disabled":true},{"key":"ordering","value":"","type":"text","description":"A field to order the results on","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 4,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/recipes/549980272150003/\",\n \"id\": \"549980272150003\",\n \"name\": \"Tiramisù\",\n \"uid\": \"\",\n \"description\": \"\",\n \"persons\": 1,\n \"cuisine\": \"\",\n \"recipe_stage\": \"\",\n \"remarks\": \"General remarks about this recipe. Free text.
\",\n \"recipe_type\": \"Main course\",\n \"recipe_type_other\": null,\n \"season\": \"all_seasons\",\n \"difficulty\": 1,\n \"recipe_class\": \"dish\",\n \"target_profit_margin\": \"80.00\",\n \"vat\": \"12.00\",\n \"current_sell_price\": {\n \"created\": \"2020-06-17 12:04:28.685633\",\n \"pricing\": 13,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n \"sell_price_history\": [\n {\n \"created\": \"2020-06-17 11:44:38.762287\",\n \"pricing\": 13,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n {\n \"created\": \"2020-06-17 11:49:30.968115\",\n \"pricing\": 13,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n }\n ],\n \"created_date\": \"2020-06-17T11:44:38.737130+02:00\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"modified_date\": \"2020-06-17T12:04:28.748661+02:00\",\n \"original\": null,\n \"clones\": [],\n \"public\": false,\n \"net_weight\": \"3.00\",\n \"net_weight_unit\": \"kg\",\n \"net_volume\": null,\n \"net_volume_unit\": \"\",\n \"prep_time\": \"00:05:00\",\n \"prep_time_passive\": null,\n \"cooking_time\": \"00:02:00\",\n \"cooking_time_passive\": \"00:15:30\",\n \"plating_time\": \"00:01:00\",\n \"portion_pieces\": null,\n \"custom_fields\": [\n {\n \"name\": \"Kitchen Utensils\",\n \"value\": null\n },\n {\n \"name\": \"Recipe Multi Field\",\n \"value\": [\n \"Choice 1\",\n \"Choice 3\"\n ]\n }\n ],\n \"main_stock_items\": [],\n \"shelf_life\": \"4 00:00:00\"\n }\n ]\n}"},{"id":"0d5d359c-e38f-4cd2-8443-9e6482ef5fe2","name":"With optional params","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/products/recipes/?page=1&name=spaghetti&uid=0001&min_persons=16&max_persons=20&start_date=2020-06-01&end_date=2020-06-30&prepping_time_greater=00:04:59&prepping_time_lower=00:05:01&ordering=name","host":["https://app.apicbase.com/api/v1/products"],"path":["recipes",""],"query":[{"key":"page","value":"1","description":"A page number within the paginated result set"},{"key":"name","value":"spaghetti","description":"A name to query on"},{"key":"uid","value":"0001","description":"An internal UID to query on"},{"key":"min_persons","value":"16","description":"Minimum amount of servings"},{"key":"max_persons","value":"20","description":"Maximum amount of servings"},{"key":"start_date","value":"2020-06-01","description":"Get created after this date"},{"key":"end_date","value":"2020-06-30","description":"Get created before this date"},{"key":"prepping_time_greater","value":"00:04:59","description":"Get recipes with prep time greater than this. Format: hh:mm:ss"},{"key":"prepping_time_lower","value":"00:05:01","description":"Get recipes with prep time lesser than this. Format: hh:mm:ss"},{"key":"ordering","value":"name","description":"A field to order the results on"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/recipes/349980442190000/\",\n \"id\": \"349980442190000\",\n \"name\": \"Spaghetti Bolognese\",\n \"uid\": \"0001\",\n \"description\": \"A free text field here\",\n \"persons\": 16,\n \"cuisine\": \"Italian\",\n \"recipe_stage\": \"active\",\n \"remarks\": \"General remarks about this recipe. Free text.
\",\n \"recipe_type\": \"Main course\",\n \"recipe_type_other\": null,\n \"season\": \"all_seasons\",\n \"difficulty\": 1,\n \"recipe_class\": \"dish\",\n \"target_profit_margin\": \"80.00\",\n \"vat\": \"12.00\",\n \"current_sell_price\": {\n \"created\": \"2020-06-17 12:04:28.685633\",\n \"pricing\": 13,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n \"sell_price_history\": [\n {\n \"created\": \"2020-06-17 11:44:38.762287\",\n \"pricing\": 13,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n {\n \"created\": \"2020-06-17 11:49:30.968115\",\n \"pricing\": 13,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n }\n ],\n \"created_date\": \"2020-06-17T11:44:38.737130+02:00\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"modified_date\": \"2020-06-17T12:04:28.748661+02:00\",\n \"original\": null,\n \"clones\": [],\n \"net_weight\": \"3.00\",\n \"net_weight_unit\": \"kg\",\n \"net_volume\": null,\n \"net_volume_unit\": \"\",\n \"prep_time\": \"00:05:00\",\n \"prep_time_passive\": null,\n \"cooking_time\": \"00:02:00\",\n \"cooking_time_passive\": \"00:15:30\",\n \"plating_time\": \"00:01:00\",\n \"portion_pieces\": null,\n \"custom_fields\": [\n {\n \"name\": \"Kitchen Utensils\",\n \"value\": null\n },\n {\n \"name\": \"Recipe Multi Field\",\n \"value\": [\n \"Choice 1\",\n \"Choice 3\"\n ]\n }\n ],\n \"main_stock_items\": [],\n \"shelf_life\": \"4 00:00:00\"\n }\n ]\n}"},{"id":"8c6c8276-c714-48b0-bc0d-999a4ed0b2f6","name":"Filter on custom fields (single value)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/products/recipes/?custom_fields={\"filter-field-single\": \"Single 1\"}","host":["https://app.apicbase.com/api/v1/products"],"path":["recipes",""],"query":[{"key":"custom_fields","value":"{\"filter-field-single\": \"Single 1\"}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/recipes/549980272150003/\",\n \"id\": \"549980272150003\",\n \"name\": \"Tiramisù\",\n \"uid\": \"\",\n \"description\": \"\",\n \"persons\": 1,\n \"cuisine\": \"\",\n \"recipe_stage\": \"\",\n \"remarks\": \"General remarks about this recipe. Free text.
\",\n \"recipe_type\": \"Main course\",\n \"recipe_type_other\": null,\n \"season\": \"all_seasons\",\n \"difficulty\": 1,\n \"recipe_class\": \"dish\",\n \"target_profit_margin\": \"80.00\",\n \"vat\": \"12.00\",\n \"current_sell_price\": {\n \"created\": \"2020-06-17 12:04:28.685633\",\n \"pricing\": 13.0,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n \"sell_price_history\": [\n {\n \"created\": \"2020-06-17 11:44:38.762287\",\n \"pricing\": 13.0,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n {\n \"created\": \"2020-06-17 11:49:30.968115\",\n \"pricing\": 13.0,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n }\n ],\n \"created_date\": \"2020-06-17T11:44:38.737130+02:00\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"modified_date\": \"2020-11-18T16:21:35.938295+01:00\",\n \"original\": null,\n \"clones\": [],\n \"net_weight\": \"3.00\",\n \"net_weight_unit\": \"kg\",\n \"net_volume\": null,\n \"net_volume_unit\": \"\",\n \"prep_time\": \"00:05:00\",\n \"prep_time_passive\": null,\n \"cooking_time\": \"00:02:00\",\n \"cooking_time_passive\": \"00:15:30\",\n \"plating_time\": \"00:01:00\",\n \"portion_pieces\": null,\n \"custom_fields\": [\n {\n \"name\": \"Kitchen Utensils\",\n \"value\": null\n },\n {\n \"name\": \"Filter Field Multi\",\n \"value\": null\n },\n {\n \"name\": \"Filter Field Single\",\n \"value\": \"Single 1\"\n },\n {\n \"name\": \"Filter Field Text\",\n \"value\": null\n },\n {\n \"name\": \"Recipe Multi Field\",\n \"value\": [\n \"Choice 1\",\n \"Choice 3\"\n ]\n }\n ],\n \"main_stock_items\": [],\n \"shelf_life\": 4\n }\n ]\n}"},{"id":"0c3125a0-18a7-44c3-927e-1129458ff28e","name":"Filter on custom fields (multiple values)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/products/recipes/?custom_fields={\"filter-field-multi\": [\"First\"], \"filter-field-text\": \"filter text\"}","host":["https://app.apicbase.com/api/v1/products"],"path":["recipes",""],"query":[{"key":"custom_fields","value":"{\"filter-field-multi\": [\"First\"], \"filter-field-text\": \"filter text\"}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/recipes/549980272150003/\",\n \"id\": \"549980272150003\",\n \"name\": \"Tiramisù\",\n \"uid\": \"\",\n \"description\": \"\",\n \"persons\": 1,\n \"cuisine\": \"\",\n \"recipe_stage\": \"\",\n \"remarks\": \"Remarks about the spaghetti
\","," \"recipe_type\": \"Main course\","," \"recipe_type_other\": null,"," \"season\": \"all_seasons\","," \"difficulty\": 2,"," \"recipe_class\": \"Dish\","," \"target_profit_margin\": \"30.00\","," \"vat\": \"15.00\","," \"current_sell_price\": {"," \"created\": \"2021-01-11 15:45:10.615603\","," \"pricing\": 7.5,"," \"user_pk\": 3475,"," \"username\": \"thiago@apicbase.com\""," },"," \"sell_price_history\": ["," {"," \"created\": \"2021-01-11 15:43:53.244686\","," \"pricing\": 7.0,"," \"user_pk\": 3475,"," \"username\": \"thiago@apicbase.com\""," }"," ],"," \"created_date\": \"2021-01-11T15:43:53.223490+01:00\","," \"created_by\": \"thiago@apicbase.com\","," \"modified_date\": \"2021-01-11T15:45:10.668153+01:00\","," \"original\": null,"," \"clones\": [],"," \"public\": false,"," \"net_weight\": \"1320.00\","," \"net_weight_unit\": \"g\","," \"net_volume\": \"1320.00\","," \"net_volume_unit\": \"ml\","," \"prep_time\": null,"," \"prep_time_passive\": null,"," \"cooking_time\": \"00:05:00\","," \"cooking_time_passive\": null,"," \"plating_time\": null,"," \"portion_pieces\": null,"," \"custom_fields\": ["," {"," \"name\": \"Kitchen Utensils\","," \"value\": null"," },"," {"," \"name\": \"Custom Free Text Field\","," \"value\": null"," },"," {"," \"name\": \"Custom Multi Choice Field\","," \"value\": ["," \"Value 1\","," \"Value 3\""," ]"," }"," ],"," \"main_stock_items\": [],"," \"shelf_life\": \"00:00:00\","," \"ingredients\": ["," {"," \"number\": 1,"," \"description\": \"[R] Bolognese sauce\","," \"quantity\": \"1.000\","," \"unit\": \"piece\","," \"ingredient\": null,"," \"subrecipe\": \"https://www.apicbase.com/api/v1/products/recipes/149711257190004/\","," \"remarks\": \"\","," \"waste_percentage\": 0.03"," },"," {"," \"number\": 2,"," \"description\": \"[R] Pasta\","," \"quantity\": \"500.000\","," \"unit\": \"g\","," \"ingredient\": null,"," \"subrecipe\": \"https://www.apicbase.com/api/v1/products/recipes/549711338150008/\","," \"remarks\": \"\","," \"waste_percentage\": 0.03"," },"," {"," \"number\": 3,"," \"description\": \"[I] Parmesan cheese\","," \"quantity\": \"20.000\","," \"unit\": \"g\","," \"ingredient\": \"https://www.apicbase.com/api/v1/products/ingredients/364687147510005/\","," \"subrecipe\": null,"," \"remarks\": \"grated\","," \"waste_percentage\": 0.03"," }"," ],"," \"allergens\": {"," \"brazil_nuts\": 0,"," \"seeds\": 0,"," \"shellfish\": 0,"," \"barley\": 0,"," \"peanut\": 0,"," \"poppy_seeds\": 0,"," \"kamut\": 0,"," \"rye\": 0,"," \"macadamia_nuts\": 0,"," \"oats\": 0,"," \"pistachio_nuts\": 0,"," \"hazelnuts\": 0,"," \"sunflower_seeds\": 0,"," \"egg\": 1,"," \"wheat\": 1,"," \"nut\": 0,"," \"sesame\": 0,"," \"milk_dairy\": 1,"," \"spelt\": 0,"," \"lupine\": 0,"," \"gluten\": 1,"," \"pecan_nuts\": 0,"," \"soy\": 0,"," \"sulfites\": 0,"," \"mustard\": 0,"," \"celery\": 0,"," \"almonds\": 0,"," \"mollusc\": 0,"," \"corn\": 0,"," \"legume_pulse\": 0,"," \"fish\": 0,"," \"cashews\": 0,"," \"lactose\": 1,"," \"walnuts\": 0"," },"," \"steps\": ["," {"," \"description\": \"Step one\","," \"description_translations\": []"," },"," {"," \"description\": \"Step two\","," \"description_translations\": []"," },"," {"," \"description\": \"Step three\","," \"image_thumb_url\": null,"," \"image_web_url\": null,"," \"image_orig_url\": null,"," \"description_translations\": []"," }"," ],"," \"images\": ["," \"https://www.apicbase.com/api/v1/media/images/881537947580005/\""," ],"," \"main_image\": {"," \"url\": \"https://www.apicbase.com/api/v1/media/images/881537947580005/\","," \"id\": \"881537947580005\","," \"studio_login\": \"thiago@apicbase.com\","," \"restaurant\": null,"," \"description\": \"placeholder\","," \"category\": null,"," \"uploaded_at\": \"2021-01-07T15:58:27.230009+01:00\","," \"picture_taken_date\": \"2021-01-07T15:58:27.241922+01:00\","," \"shared_on\": null,"," \"modified_date\": \"2021-01-07T16:00:10.894590+01:00\","," \"uploaded_by\": \"thiago@apicbase.com\","," \"tags\": ["," {"," \"id\": \"id-29-45\","," \"top\": 45,"," \"left\": 29,"," \"text\": \"I'm a tag!\""," }"," ],"," \"public\": false,"," \"external\": true"," },"," \"name_translations\": [],"," \"financial\": {"," \"foodcost\": 3.7021118919434906,"," \"personnel_cost\": 2.0"," },"," \"nutrition_info\": {"," \"for\": {"," \"quantity\": 100,"," \"unit\": \"g\""," },"," \"kcal\": {"," \"quantity\": 106.58146666666667,"," \"unit\": \"kcal\""," },"," \"kj\": {"," \"quantity\": 445.9625535030304,"," \"unit\": \"kJ\""," },"," \"fat\": {"," \"quantity\": 8.22256734006734,"," \"unit\": \"g\""," },"," \"trans_fatty_acids\": {"," \"quantity\": 0.0,"," \"unit\": \"g\""," },"," \"saturated_fat\": {"," \"quantity\": 2.4241164983164984,"," \"unit\": \"g\""," },"," \"mono_unsaturated_fat\": {"," \"quantity\": 0.15673400673400675,"," \"unit\": \"g\""," },"," \"poly_unsaturated_fat\": {"," \"quantity\": 0.13602693602693605,"," \"unit\": \"g\""," },"," \"carbohydrate\": {"," \"quantity\": 24.515193602693607,"," \"unit\": \"g\""," },"," \"sugar\": {"," \"quantity\": 1.2876262626262627,"," \"unit\": \"g\""," },"," \"protein\": {"," \"quantity\": 9.657870370370372,"," \"unit\": \"g\""," },"," \"animal_protein\": {"," \"quantity\": 5.757575757575758,"," \"unit\": \"g\""," },"," \"plants_protein\": {"," \"quantity\": 2.9461279461279464,"," \"unit\": \"g\""," },"," \"fibre\": {"," \"quantity\": 0.1609848484848485,"," \"unit\": \"g\""," },"," \"polyol\": {"," \"quantity\": 0.0,"," \"unit\": \"g\""," },"," \"salt\": {"," \"quantity\": 1.17246632996633,"," \"unit\": \"g\""," },"," \"sodium\": {"," \"quantity\": 21.06470287643097,"," \"unit\": \"g\""," },"," \"starch\": {"," \"quantity\": 0.0,"," \"unit\": \"g\""," },"," \"vitamin_a\": {"," \"quantity\": 0.0,"," \"unit\": \"µg\""," },"," \"vitamin_c\": {"," \"quantity\": 0.0,"," \"unit\": \"mg\""," },"," \"vitamin_d\": {"," \"quantity\": 0.0,"," \"unit\": \"µg\""," },"," \"vitamin_e\": {"," \"quantity\": 0.004545454545454545,"," \"unit\": \"mg\""," },"," \"vitamin_k\": {"," \"quantity\": 0.028787878787878786,"," \"unit\": \"µg\""," },"," \"thiamin\": {"," \"quantity\": 0.0,"," \"unit\": \"mg\""," },"," \"riboflavin\": {"," \"quantity\": 0.007575757575757576,"," \"unit\": \"mg\""," },"," \"niacin\": {"," \"quantity\": 0.0015151515151515154,"," \"unit\": \"mg\""," },"," \"vitamin_b6\": {"," \"quantity\": 0.0,"," \"unit\": \"mg\""," },"," \"folic_acid\": {"," \"quantity\": 0.15151515151515152,"," \"unit\": \"µg\""," },"," \"vitamin_b12\": {"," \"quantity\": 0.034848484848484844,"," \"unit\": \"µg\""," },"," \"biotin\": {"," \"quantity\": 0.0,"," \"unit\": \"µg\""," },"," \"pantothenic_acid\": {"," \"quantity\": 0.0,"," \"unit\": \"mg\""," },"," \"potassium\": {"," \"quantity\": 204.77811750841755,"," \"unit\": \"mg\""," },"," \"chloride\": {"," \"quantity\": 0.0,"," \"unit\": \"mg\""," },"," \"calcium\": {"," \"quantity\": 30.383162626262628,"," \"unit\": \"mg\""," },"," \"phosphorus\": {"," \"quantity\": 0.0,"," \"unit\": \"mg\""," },"," \"magnesium\": {"," \"quantity\": 0.5757575757575758,"," \"unit\": \"mg\""," },"," \"iron\": {"," \"quantity\": 2.1087605664983164,"," \"unit\": \"mg\""," },"," \"zinc\": {"," \"quantity\": 0.05909090909090909,"," \"unit\": \"mg\""," },"," \"copper\": {"," \"quantity\": 0.0030303030303030307,"," \"unit\": \"mg\""," },"," \"manganese\": {"," \"quantity\": 0.0015151515151515154,"," \"unit\": \"mg\""," },"," \"fluoride\": {"," \"quantity\": 0.0,"," \"unit\": \"mg\""," },"," \"selenium\": {"," \"quantity\": 0.2681818181818182,"," \"unit\": \"µg\""," },"," \"chromium\": {"," \"quantity\": 0.0,"," \"unit\": \"µg\""," },"," \"molybdenum\": {"," \"quantity\": 0.0,"," \"unit\": \"µg\""," },"," \"iodine\": {"," \"quantity\": 0.0,"," \"unit\": \"µg\""," },"," \"water\": {"," \"quantity\": 0.3151515151515152,"," \"unit\": \"g\""," }"," },"," \"nutriscore\": null,"," \"dietary_info\": {"," \"halal\": false,"," \"carrot\": false,"," \"glutamate\": false,"," \"alcohol\": false,"," \"poultry_meat\": false,"," \"blackened\": false,"," \"cacao\": false,"," \"benzoates\": false,"," \"lamb\": false,"," \"caffeine\": false,"," \"quinine\": false,"," \"vegan\": false,"," \"genetic_modified\": false,"," \"sulphur\": false,"," \"propionates\": false,"," \"antioxidant\": false,"," \"sweetener\": false,"," \"phosphate\": false,"," \"acesulfame_e962\": false,"," \"nitrates\": false,"," \"sorbates\": false,"," \"preservative\": true,"," \"coloring\": false,"," \"coriander\": false,"," \"vegetarian\": false,"," \"flavor_enhancer\": false,"," \"pigmeat\": false,"," \"aspartame_e951\": false,"," \"taurine\": false,"," \"beef\": true,"," \"kosher\": false"," }"," }"," var responseJson = pm.response.json();",""," function compareObjects(x, y) {"," for (var p in x) {"," if (!y.hasOwnProperty(p)) throw new Error(\"Attribute {\"+p+\"} missing in response\");",""," if(typeof(x[p]) === \"object\") {"," compareObjects(x[p], y[p]);"," } else {"," pm.expect(y[p]).to.eql(x[p], \"Attribute {\"+p+\"} mismatch\");"," }"," }"," }"," compareObjects(expectedJson, responseJson);","});"],"type":"text/javascript"}}],"id":"3c50668b-7b24-4834-90df-076c9d7528ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.apicbase.com/api/v1/products/recipes/{{recipeId}}/","description":"Gets information about a specific recipe.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"General remarks about this recipe. Free text.
\",\n \"recipe_type\": \"Main course\",\n \"recipe_type_other\": null,\n \"season\": \"all_seasons\",\n \"difficulty\": 1,\n \"recipe_class\": \"Dish\",\n \"target_profit_margin\": \"80.00\",\n \"vat\": \"12.00\",\n \"current_sell_price\": {\n \"created\": \"2020-06-17 12:04:28.685633\",\n \"pricing\": 13,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n \"sell_price_history\": [\n {\n \"created\": \"2020-06-17 11:44:38.762287\",\n \"pricing\": 13,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n {\n \"created\": \"2020-06-17 11:49:30.968115\",\n \"pricing\": 13,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n }\n ],\n \"created_date\": \"2020-06-17T11:44:38.737130+02:00\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"modified_date\": \"2020-11-18T16:21:35.938295+01:00\",\n \"original\": null,\n \"clones\": [\n \"https://app.apicbase.com/api/v1/products/recipes/349691174570004/\"\n ],\n \"public\": false,\n \"net_weight\": \"3.00\",\n \"net_weight_unit\": \"kg\",\n \"net_volume\": \"3000.00\",\n \"net_volume_unit\": \"ml\",\n \"prep_time\": \"00:05:00\",\n \"prep_time_passive\": null,\n \"cooking_time\": \"00:02:00\",\n \"cooking_time_passive\": \"00:15:30\",\n \"plating_time\": \"00:01:00\",\n \"portion_pieces\": null,\n \"custom_fields\": [\n {\n \"name\": \"Kitchen Utensils\",\n \"value\": null\n },\n {\n \"name\": \"Filter Field Multi\",\n \"value\": null\n },\n {\n \"name\": \"Filter Field Single\",\n \"value\": \"Single 1\"\n },\n {\n \"name\": \"Filter Field Text\",\n \"value\": \"Some free text\"\n },\n {\n \"name\": \"Recipe Multi Field\",\n \"value\": [\n \"Choice 1\",\n \"Choice 3\"\n ]\n }\n ],\n \"main_stock_items\": [],\n \"shelf_life\": {\n \"days\": 4,\n \"hours\": 0\n },\n \"ingredients\": [\n {\n \"number\": 1,\n \"quantity\": \"1.000\",\n \"unit\": \"kg\",\n \"type\": \"INGREDIENT\",\n \"name\": \"Pasta Spaghetti\",\n \"uid\": \"\",\n \"ingredient\": \"https://app.apicbase.com/api/v1/products/ingredients/764556666890005/\",\n \"subrecipe\": null,\n \"remarks\": \"\",\n \"waste_percentage\": 0,\n \"description\": \"[I] Pasta Spaghetti\"\n },\n {\n \"number\": 2,\n \"quantity\": \"1.500\",\n \"unit\": \"l\",\n \"type\": \"RECIPE\",\n \"name\": \"Tomato Passata\",\n \"uid\": \"2222\",\n \"ingredient\": null,\n \"subrecipe\": \"https://app.apicbase.com/api/v1/products/recipes/449980552170001/\",\n \"remarks\": \"\",\n \"waste_percentage\": 0,\n \"description\": \"[R] Tomato Passata\"\n },\n {\n \"number\": 3,\n \"quantity\": \"800.000\",\n \"unit\": \"g\",\n \"type\": \"INGREDIENT\",\n \"name\": \"Beef mince\",\n \"uid\": \"\",\n \"ingredient\": \"https://app.apicbase.com/api/v1/products/ingredients/764556486880003/\",\n \"subrecipe\": null,\n \"remarks\": \"\",\n \"waste_percentage\": 0,\n \"description\": \"[I] Beef mince\"\n },\n {\n \"number\": 4,\n \"quantity\": \"5.000\",\n \"unit\": \"g\",\n \"type\": \"INGREDIENT\",\n \"name\": \"White pepper powder\",\n \"uid\": \"\",\n \"ingredient\": \"https://app.apicbase.com/api/v1/products/ingredients/664556196850009/\",\n \"subrecipe\": null,\n \"remarks\": \"\",\n \"waste_percentage\": 0,\n \"description\": \"[I] White pepper powder\"\n },\n {\n \"number\": 5,\n \"quantity\": \"600.000\",\n \"unit\": \"g\",\n \"type\": \"INGREDIENT\",\n \"name\": \"Carrots\",\n \"uid\": \"\",\n \"ingredient\": \"https://app.apicbase.com/api/v1/products/ingredients/464556907820001/\",\n \"subrecipe\": null,\n \"remarks\": \"Only fresh carrots!\",\n \"waste_percentage\": 0,\n \"description\": \"[I] Carrots\"\n }\n ],\n \"allergens\": {\n \"kamut\": 0,\n \"pecan_nuts\": 0,\n \"gluten\": 1,\n \"spelt\": 0,\n \"barley\": 0,\n \"hazelnuts\": 0,\n \"shellfish\": 0,\n \"milk_dairy\": 0,\n \"almonds\": 0,\n \"lupine\": 0,\n \"seeds\": 0,\n \"celery\": 0,\n \"rye\": 0,\n \"mustard\": 0,\n \"poppy_seeds\": 0,\n \"sesame\": 0,\n \"peanut\": 0,\n \"egg\": 0,\n \"walnuts\": 0,\n \"wheat\": 1,\n \"lactose\": 0,\n \"brazil_nuts\": 0,\n \"macadamia_nuts\": 0,\n \"pistachio_nuts\": 0,\n \"sulfites\": 0,\n \"cashews\": 0,\n \"oats\": 0,\n \"fish\": 0,\n \"sunflower_seeds\": 0,\n \"nut\": 0,\n \"legume_pulse\": 0,\n \"soy\": 0,\n \"corn\": 0,\n \"mollusc\": 0\n },\n \"steps\": [\n {\n \"description\": \"This is the first step.\",\n \"image_thumb_url\": null,\n \"image_web_url\": null,\n \"image_orig_url\": null,\n \"description_translations\": []\n },\n {\n \"description\": \"This is the second step.\",\n \"image_thumb_url\": null,\n \"image_web_url\": null,\n \"image_orig_url\": null,\n \"description_translations\": []\n },\n {\n \"description\": \"Third step, voilà.\",\n \"image_thumb_url\": null,\n \"image_web_url\": null,\n \"image_orig_url\": null,\n \"description_translations\": []\n }\n ],\n \"images\": [\n \"https://app.apicbase.com/api/v1/media/images/181566068410002/\"\n ],\n \"main_image\": {\n \"url\": \"https://app.apicbase.com/api/v1/media/images/181566068410002/\",\n \"id\": \"181566068410002\",\n \"studio_login\": \"john.doe@apicbase.com\",\n \"full_image_url\": \"https://production-apicvault.s3.amazonaws.com/rooms/apic_user_3475/download_7MkdGJt.png?AWSAccessKeyId=AKIA3XQ5A2DMB3AJEFEK&Signature=%2BBJFlKxbZtd%2Bp7VDtkL5%2FC86UqI%3D&Expires=1617201562\",\n \"web_image_url\": \"https://production-apicvault.s3.amazonaws.com/rooms/apic_user_3475/download-webImage_large.png?AWSAccessKeyId=AKIA3XQ5A2DMB3AJEFEK&Signature=p8Ixii%2BWO2wuVzn2%2BZ5x1UE1P7Q%3D&Expires=1617201562\",\n \"thumb_image_url\": \"https://production-apicvault.s3.amazonaws.com/rooms/apic_user_3475/download-thumbImage.png?AWSAccessKeyId=AKIA3XQ5A2DMB3AJEFEK&Signature=4lZooFXA4qRBMB6zJEU8WWfK%2BFw%3D&Expires=1617201562\",\n \"restaurant\": null,\n \"description\": \"download\",\n \"category\": \"recipe\",\n \"uploaded_at\": \"2020-06-17T18:08:28.851366+02:00\",\n \"picture_taken_date\": \"2020-06-17T18:08:28.861966+02:00\",\n \"shared_on\": null,\n \"modified_date\": \"2020-06-17T18:09:49.459202+02:00\",\n \"uploaded_by\": \"john.doe@apicbase.com\",\n \"tags\": [\n {\n \"id\": \"id-54-78\",\n \"top\": 78,\n \"left\": 54,\n \"text\": \"tag 1\"\n },\n {\n \"id\": \"id-65-43\",\n \"top\": 43,\n \"left\": 65,\n \"text\": \"tag 2\"\n }\n ],\n \"public\": false,\n \"external\": true\n },\n \"outlets\": [\n \"https://app.apicbase.com/api/v1/accounts/outlets/229100415400002/\",\n \"https://app.apicbase.com/api/v1/accounts/outlets/829100725420008/\"\n ],\n \"preferred_uoms\": [\n \"g\",\n \"kg\"\n ],\n \"allergen_verified\": false,\n \"name_translations\": [],\n \"financial\": {\n \"foodcost\": 0.05714285714285714,\n \"personnel_cost\": 0\n },\n \"nutrition_info\": {\n \"for\": {\n \"quantity\": 100,\n \"unit\": \"g\"\n },\n \"kcal\": {\n \"quantity\": 3.333333333333334,\n \"unit\": \"kcal\"\n },\n \"kj\": {\n \"quantity\": 13.946666666666669,\n \"unit\": \"kJ\"\n },\n \"fat\": {\n \"quantity\": 3.333333333333334,\n \"unit\": \"g\"\n },\n \"saturated_fat\": {\n \"quantity\": 1.666666666666667,\n \"unit\": \"g\"\n },\n \"carbohydrate\": {\n \"quantity\": 3.333333333333334,\n \"unit\": \"g\"\n },\n \"sugar\": {\n \"quantity\": 3.333333333333334,\n \"unit\": \"g\"\n },\n \"protein\": {\n \"quantity\": 3.333333333333334,\n \"unit\": \"g\"\n },\n \"salt\": {\n \"quantity\": 3.333333333333334,\n \"unit\": \"g\"\n }\n },\n \"nutrition_info_per_portion\": {\n \"for\": {\n \"quantity\": 1,\n \"unit\": \"portion\"\n },\n \"kcal\": {\n \"quantity\": 6.25,\n \"unit\": \"kcal\"\n },\n \"kj\": {\n \"quantity\": 26.150000000000002,\n \"unit\": \"kJ\"\n },\n \"fat\": {\n \"quantity\": 6.25,\n \"unit\": \"g\"\n },\n \"saturated_fat\": {\n \"quantity\": 3.125,\n \"unit\": \"g\"\n },\n \"carbohydrate\": {\n \"quantity\": 6.25,\n \"unit\": \"g\"\n },\n \"sugar\": {\n \"quantity\": 6.25,\n \"unit\": \"g\"\n },\n \"protein\": {\n \"quantity\": 6.25,\n \"unit\": \"g\"\n },\n \"salt\": {\n \"quantity\": 6.25,\n \"unit\": \"g\"\n }\n },\n \"nutriscore\": null,\n \"dietary_info\": {\n \"blackened\": false,\n \"acesulfame_e962\": false,\n \"alcohol\": false,\n \"quinine\": false,\n \"genetic_modified\": false,\n \"coriander\": false,\n \"kosher\": false,\n \"preservative\": false,\n \"sweetener\": false,\n \"coloring\": false,\n \"vegetarian\": false,\n \"vegan\": false,\n \"halal\": false,\n \"phosphate\": false,\n \"sorbates\": false,\n \"aspartame_e951\": false,\n \"pigmeat\": false,\n \"sulphur\": false,\n \"flavor_enhancer\": false,\n \"lamb\": false,\n \"beef\": true,\n \"taurine\": false,\n \"nitrates\": false,\n \"poultry_meat\": false,\n \"glutamate\": false,\n \"cacao\": false,\n \"benzoates\": false,\n \"carrot\": true,\n \"propionates\": false,\n \"caffeine\": false,\n \"antioxidant\": false\n },\n \"used_in_recipes\": [\n \"https://app.apicbase.com/api/v1/products/recipes/349173044980009/\"\n ],\n \"used_in_menus\": [\n \"https://app.apicbase.com/api/v1/products/menus/390400735470004/\"\n ],\n \"inventory_ingredient\": null,\n \"outlet_prices\": [\n {\n \"created\": \"2022-01-01 12:00:00.335435\",\n \"pricing\": 8,\n \"user_pk\": null,\n \"username\": null,\n \"outlet\": {\n \"id\": \"829100725420008\",\n \"name\": \"Brussel\",\n \"url\": \"https://app.apicbase.com/api/v1/accounts/outlets/829100725420008/\"\n }\n },\n {\n \"created\": \"2022-01-01 12:00:00.335435\",\n \"pricing\": 7.5,\n \"user_pk\": null,\n \"username\": null,\n \"outlet\": {\n \"id\": \"229100415400002\",\n \"name\": \"Antwerpen\",\n \"url\": \"https://app.apicbase.com/api/v1/accounts/outlets/229100415400002/\"\n }\n }\n ]\n}"}],"_postman_id":"3c50668b-7b24-4834-90df-076c9d7528ce"},{"name":"Create a recipe","id":"8fee1155-d766-4b7d-85a7-49df5f0bc1c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://app.apicbase.com/api/v1/products/recipes/","description":"Creates a new instance of a recipe.
\nWatch out: the POST method is strictly for creating new entries. Making repeated POST requests with the same payload will create duplicates! To update an existing recipe, make a PATCH request.
\nThe only required fields are name and persons (servings). All other fields are optional.
Uniqueness is enforced on the uid field (when provided), meaning that no two entries can have the same value for this field. When attempting to create entries with duplicated UIDs, the server will respond with a 400 Bad Request error.
Edits an existing ingredient. The same fields available and restrictions applied to the POST method also apply here. For this method, only fields included in the request body will be modified; omitted fields will keep their current values.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"Gets historical pricing data for a given recipe, including all recorded price changes. Results are paginated, with 10 items being shown by page.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"A page number within the paginated result set
\n","type":"text/plain"},"key":"page","value":null}],"variable":[]}},"response":[{"id":"20d18e0c-082d-4adf-afe8-4a6f475967d9","name":"Success response","originalRequest":{"method":"GET","header":[],"url":"https://app.apicbase.com/api/v1/products/recipes/{{recipeId}}/cost_history/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"recipe\": \"https://app.apicbase.com/api/v1/products/recipes/749980262120005/\",\n \"cache_date\": \"2020-10-14\",\n \"personnel_cost_one\": \"0.00\",\n \"waste_cost_one\": \"0.00\",\n \"ingredient_cost_one\": \"0.00\",\n \"prime_cost_one\": \"0.00\",\n \"actual_profit_one\": \"1.65\",\n \"sell_price_excl_vat\": \"1.65\",\n \"actual_profit_margin\": \"100.00\",\n \"servings\": 1,\n \"extra_info\": {},\n \"updated_at\": \"2020-10-14T17:01:27.666624+02:00\"\n },\n {\n \"recipe\": \"https://app.apicbase.com/api/v1/products/recipes/749980262120005/\",\n \"cache_date\": \"2020-06-17\",\n \"personnel_cost_one\": \"0.00\",\n \"waste_cost_one\": \"0.00\",\n \"ingredient_cost_one\": \"0.00\",\n \"prime_cost_one\": \"0.00\",\n \"actual_profit_one\": null,\n \"sell_price_excl_vat\": null,\n \"actual_profit_margin\": null,\n \"servings\": 1,\n \"extra_info\": {},\n \"updated_at\": \"2020-06-17T11:55:47.326323+02:00\"\n }\n ]\n}"}],"_postman_id":"8f27c673-020e-4666-b0ba-0ff2a1716677"},{"name":"Get recipe nutritional data","id":"efa95e96-5118-479f-a523-d36f66983eaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.apicbase.com/api/v1/products/recipes/{{recipeId}}/nutrition","description":"Gets data from a recipe's allergen and nutritional info tab.
\nThe attributes of the allergens object may contain these values, meaning:
0 = does not contain
1 = contains
2 = may contain traces of
3 = unknown
Gets a list of recipes linked to a given outlet. Recipes indirectly linked to the queried outlet through subrecipes or menus are also shown. Optional params can be used to filter and sort the results. Results are paginated, with 10 items being shown by page.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"A page number within the paginated result set
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"A name to query on
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"An internal UID to query on
\n","type":"text/plain"},"key":"uid","value":""},{"disabled":true,"description":{"content":"Minimum amount of servings
\n","type":"text/plain"},"key":"min_persons","value":""},{"disabled":true,"description":{"content":"Maximum amount of servings
\n","type":"text/plain"},"key":"max_persons","value":""},{"disabled":true,"description":{"content":"Get created after this date
\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"Get created before this date
\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"Get recipes with prep time greater than this. Format: hh:mm:ss
\n","type":"text/plain"},"key":"prepping_time_greater","value":""},{"disabled":true,"description":{"content":"Get recipes with prep time lesser than this. Format: hh:mm:ss
\n","type":"text/plain"},"key":"prepping_time_lower","value":""},{"disabled":true,"description":{"content":"A field to order the results on
\n","type":"text/plain"},"key":"ordering","value":""}],"variable":[]}},"response":[{"id":"bbf668df-bb47-4d67-a9c1-429fe5bb24d1","name":"Success response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/products/outlets/{{outletId}}/recipes/","host":["https://app.apicbase.com/api/v1/products"],"path":["outlets","{{outletId}}","recipes",""],"query":[{"description":"A page number within the paginated result set","key":"page","type":"text","value":"","disabled":true},{"description":"A name to query on","key":"name","value":"","disabled":true},{"description":"An internal UID to query on","key":"uid","type":"text","value":"","disabled":true},{"description":"Minimum amount of servings","key":"min_persons","type":"text","value":"","disabled":true},{"description":"Maximum amount of servings","key":"max_persons","type":"text","value":"","disabled":true},{"description":"Get created after this date","key":"start_date","type":"text","value":"","disabled":true},{"description":"Get created before this date","key":"end_date","type":"text","value":"","disabled":true},{"description":"Get recipes with prep time greater than this. Format: hh:mm:ss","key":"prepping_time_greater","type":"text","value":"","disabled":true},{"description":"Get recipes with prep time lesser than this. Format: hh:mm:ss","key":"prepping_time_lower","type":"text","value":"","disabled":true},{"description":"A field to order the results on","key":"ordering","type":"text","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 4,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/recipes/549980272150003/\",\n \"id\": \"549980272150003\",\n \"name\": \"Tiramisù\",\n \"uid\": \"\",\n \"description\": \"\",\n \"persons\": 1,\n \"cuisine\": \"\",\n \"recipe_stage\": \"\",\n \"remarks\": \"General remarks about this recipe. Free text.
\",\n \"recipe_type\": \"Main course\",\n \"recipe_type_other\": null,\n \"season\": \"all_seasons\",\n \"difficulty\": 1,\n \"recipe_class\": \"dish\",\n \"target_profit_margin\": \"80.00\",\n \"vat\": \"12.00\",\n \"current_sell_price\": {\n \"created\": \"2020-06-17 12:04:28.685633\",\n \"pricing\": 13,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n \"sell_price_history\": [\n {\n \"created\": \"2020-06-17 11:44:38.762287\",\n \"pricing\": 13,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n },\n {\n \"created\": \"2020-06-17 11:49:30.968115\",\n \"pricing\": 13,\n \"user_pk\": 3475,\n \"username\": \"john.doe@apicbase.com\"\n }\n ],\n \"created_date\": \"2020-06-17T11:44:38.737130+02:00\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"modified_date\": \"2020-06-17T12:04:28.748661+02:00\",\n \"original\": null,\n \"clones\": [],\n \"net_weight\": \"3.00\",\n \"net_weight_unit\": \"kg\",\n \"net_volume\": null,\n \"net_volume_unit\": \"\",\n \"prep_time\": \"00:05:00\",\n \"prep_time_passive\": null,\n \"cooking_time\": \"00:02:00\",\n \"cooking_time_passive\": \"00:15:30\",\n \"plating_time\": \"00:01:00\",\n \"portion_pieces\": null,\n \"custom_fields\": [\n {\n \"name\": \"Kitchen Utensils\",\n \"value\": null\n },\n {\n \"name\": \"Recipe Multi Field\",\n \"value\": [\n \"Choice 1\",\n \"Choice 3\"\n ]\n }\n ],\n \"main_stock_items\": [],\n \"shelf_life\": \"4 00:00:00\"\n }\n ]\n}"}],"_postman_id":"00c8d6c8-126b-42e4-b52d-42d9c4cb68ee"},{"name":"Get stock items","id":"2accce6e-885d-427b-a704-3f2d2ebbf9d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.apicbase.com/api/v1/products/stock_items/","description":"Gets a list of stock items in the library. Optional params can be used to filter and sort the results. Results are paginated, with 10 items being shown by page.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"A page number within the paginated result set
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"A name to query on
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"key":"id__in","value":""},{"disabled":true,"description":{"content":"Get items created by a given user. Provide the user's email
\n","type":"text/plain"},"key":"created_by","value":""},{"disabled":true,"description":{"content":"An ingredient ID to filter on
\n","type":"text/plain"},"key":"ingredient","value":null},{"disabled":true,"description":{"content":"Get items linked to a given outlet
\n","type":"text/plain"},"key":"count_outlet","value":""},{"disabled":true,"description":{"content":"boolean, If true this package can have stock and can be counted.
\n","type":"text/plain"},"key":"stockable","value":""},{"disabled":true,"description":{"content":"GTIN/EAN
\n","type":"text/plain"},"key":"gtin","value":""},{"disabled":true,"description":{"content":"last modified date, %Y-%m-%d
\n","type":"text/plain"},"key":"modified_date__date","value":""},{"disabled":true,"key":"modified_date__date__gte","value":""},{"disabled":true,"key":"modified_date__date__lte","value":""},{"disabled":true,"description":{"content":"last modified date, %H:%M:%S
\n","type":"text/plain"},"key":"modified_date__time","value":""},{"disabled":true,"key":"modified_date__time__gte","value":""},{"disabled":true,"key":"modified_date__time__lte","value":""},{"disabled":true,"description":{"content":"A field to order the results on
\n","type":"text/plain"},"key":"ordering","value":""}],"variable":[]}},"response":[{"id":"4890b1bb-b310-4ca0-afbb-ae357420cff9","name":"Without optional params","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/products/stock_items/","host":["https://app.apicbase.com/api/v1/products"],"path":["stock_items",""],"query":[{"description":"A page number within the paginated result set","key":"page","value":"","disabled":true},{"description":"A name to query on","key":"name","value":"","disabled":true},{"description":"Get items created by a given user. Provide the user's email","key":"created_by","value":"","disabled":true},{"description":"A field to order the results on","key":"ordering","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 4,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/stock_items/721794004480005/\",\n \"id\": \"721794004480005\",\n \"name\": \"Cola Can (33 cl)\",\n \"main_ingredient_id\": \"664556437850007\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"content\": \"33 cl\",\n \"package_description\": {\n \"unit\": \"cl\",\n \"quantity\": \"33.000000\"\n },\n \"average_price_per_package\": null,\n \"average_price_per_standard_unit\": null,\n \"base_stock_item_quantity\": \"1.00000\",\n \"base_stock_item_unit\": \"cl\"\n },\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/stock_items/321794593440005/\",\n \"id\": \"321794593440005\",\n \"name\": \"Tomato Passata Pot (1 l)\",\n \"main_ingredient_id\": \"664556317810006\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"content\": \"1 l\",\n \"package_description\": {\n \"unit\": \"l\",\n \"quantity\": \"1.000000\"\n },\n \"average_price_per_package\": null,\n \"average_price_per_standard_unit\": null,\n \"base_stock_item_quantity\": \"1.00000\",\n \"base_stock_item_unit\": \"l\"\n },\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/stock_items/421794978110009/\",\n \"id\": \"421794978110009\",\n \"name\": \"Milk Crate (6 x 1 l)\",\n \"main_ingredient_id\": \"264556747770006\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"content\": \"6 x 1 l\",\n \"package_description\": {\n \"unit\": \"Bottle (1 l)\",\n \"quantity\": \"6.000000\"\n },\n \"average_price_per_package\": \"4.00000\",\n \"average_price_per_standard_unit\": \"0.66667\",\n \"base_stock_item_quantity\": \"6.00000\",\n \"base_stock_item_unit\": \"l\"\n },\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/stock_items/521794758100007/\",\n \"id\": \"521794758100007\",\n \"name\": \"Milk Bottle (1 l)\",\n \"main_ingredient_id\": \"264556747770006\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"content\": \"1 l\",\n \"package_description\": {\n \"unit\": \"l\",\n \"quantity\": \"1.000000\"\n },\n \"average_price_per_package\": null,\n \"average_price_per_standard_unit\": null,\n \"base_stock_item_quantity\": \"1.00000\",\n \"base_stock_item_unit\": \"l\"\n }\n ]\n}"},{"id":"600b4af0-4717-417d-b163-b1a169ca9c69","name":"With optional params","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.apicbase.com/api/v1/products/stock_items/?page=1&name=Cola&created_by=john.doe@apicbase.com&ordering=average_price_per_package","host":["https://app.apicbase.com/api/v1/products"],"path":["stock_items",""],"query":[{"key":"page","value":"1","description":"A page number within the paginated result set"},{"key":"name","value":"Cola","description":"A name to query on"},{"key":"created_by","value":"john.doe@apicbase.com","description":"Get items created by a given user. Provide the user's email"},{"key":"ordering","value":"average_price_per_package","description":"A field to order the results on"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"url\": \"https://app.apicbase.com/api/v1/products/stock_items/721794004480005/\",\n \"id\": \"721794004480005\",\n \"name\": \"Cola Can (33 cl)\",\n \"main_ingredient_id\": \"664556437850007\",\n \"created_by\": \"john.doe@apicbase.com\",\n \"content\": \"33 cl\",\n \"package_description\": {\n \"unit\": \"cl\",\n \"quantity\": \"33.000000\"\n },\n \"average_price_per_package\": null,\n \"average_price_per_standard_unit\": null,\n \"base_stock_item_quantity\": \"1.00000\",\n \"base_stock_item_unit\": \"cl\"\n }\n ]\n}"}],"_postman_id":"2accce6e-885d-427b-a704-3f2d2ebbf9d6"},{"name":"Get stock item details","id":"7581ae58-47fd-4f50-8e8d-7da9d0e03d8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.apicbase.com/api/v1/products/stock_items/{{stockItemId}}/","description":"Gets information about a specific stock item.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"Creates a stock item.
\nWatch out: the POST method is strictly for creating new entries. Making repeated POST requests with the same payload will create duplicates! To update an existing stock item, make a PATCH request.
\nThis endpoint can also be used to create stock items for stockable recipes. In that case, the relevant field must be specified in the payload. Consult the support article about stockable recipes to know more.
\nOne of main_ingredient_id or stockable_recipe is required.
quantity is required. One of base_unit or unit_stock_item should be filled, but not both.
The unit within package_description can be a basic unit ('g', 'piece', 'l', ..) or another stock item belonging to the same ingredient
Example: a single can of Cola could be a stock item within the Cola ingredient, and its base_unit could be 'piece' or 'ml'. A stock item describing a 6-pack could have the basic stock item describing a single can of Cola as its unit_stock_item.
Check examples for clarity.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"Updates an existing stock item.
\nBeware: updating an existing stock item's PackageDescription with its associated quantity will not correct any existing stock or inventory value. This should only be done to correct mistakes. If a stock item's composition has changed, disable it and create a new one with the new quantity instead.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"Gets a list of supplier packages in the library. Optional params can be used to filter and sort the results. Results are paginated, with 10 items being shown per page by default.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{accessToken}}"}],"advancedConfig":[{"key":"clientSecret","value":"