{"items":[{"type":"link","label":"API Reference","link":"/api/rpc/reference","routeSlug":"/api/rpc/reference","content":{"contentType":"overview","meta":{"name":"API Reference"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"API Reference","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Welcome! This guide will get you up and running with our API. Our goal is to provide a powerful and intuitive interface that is easy to integrate with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our API is designed using an "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RPC (Remote Procedure Call) style over HTTP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This means that instead of focusing on RESTful resources (nouns), you'll interact with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operation-centric"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" methods that represent clear business actions (verbs)."},"children":[]}]}]}]}],"sectionId":"/api/rpc/reference"}],"sectionId":"/api/rpc/reference"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/core-principles"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Core Principles"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We designed the API with three key principles in mind to make your development experience as smooth as possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain-driven Design:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Our API is organized into domain-specific "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"namespaces"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that logically group related operations. This domain-oriented design simplifies method discovery and ensures that you are always interacting with the correct part of the system."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Process-Oriented:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Our API methods are designed to mirror your real-world business processes. Instead of generic data manipulation, you'll call functions that represent distinct steps in your workflow. For example, you'll call "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setGreenLotWeight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transferGreenLotToLocation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", directly matching the actions your team performs."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Consistency:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To guarantee data integrity, our API treats each business operation as a single, atomic request. This approach bundles all data changes into one call, preventing the data corruption and inconsistencies that can occur when an operation is split across multiple requests."},"children":[]}]}]}]}]}]}],"sectionId":"/api/rpc/reference/section/core-principles"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/request-format"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"width":"30%"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria "},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Method"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our API exclusively uses the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP method for all operations. The specific action you wish to perform (e.g., retrieving, creating, or updating data) should be specified within the request body, rather than by using different HTTP verbs like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Protocol & Security"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All communication with the API must be made over "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTPS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For security, connections made over unencrypted HTTP will be rejected."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base URL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"base path"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all endpoints is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.cropster.com/rpc/v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the current version of the API."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL Path Schema"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoints are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"hierarchical structure"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using dotted namespaces to reflect the business domain. This structure allows for clear organization and easy discovery of endpoints related to specific business operations. The following endpoint naming schema is used for all endpoints: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{domain}.{subdomain}.{operation}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inventory.roast.listRoastedLots"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All POST requests must include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requests with a different content type, or without this header, will be rejected."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The only exception to this is the OAuth token request, which requires a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/x-www-form-urlencoded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request and response bodies are in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"camelCase"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field names. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Singular nouns"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are generally used for fields representing single entities (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plural nouns"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are used for fields representing lists of entities (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"greenLots"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/api/rpc/reference/section/request-format"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Cropster API uses the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0 Client Credentials Grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flow to authenticate all requests. This is a server-to-server authentication method where applications authenticate directly rather than on behalf of a user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The process involves two main steps which are explained in the following."},"children":[]}]}]}]}],"sectionId":"/api/rpc/reference/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication/generate-api-credentials"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate API Credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before you can connect to the API, you must create a Service Account in the Cropster user interface to obtain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Client ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Client Secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in to your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://c-sar.cropster.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cropster account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and navigate to the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Service Accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assign a name and the required "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth scopes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that define the specific permissions for this account (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inventory.roast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access roast inventory data)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upon creation, your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Client ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Client Secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be displayed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Secure Your Credentials"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Client Secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is highly sensitive and is only displayed once upon creation. Store it securely and treat it like a password. Do not expose it in client-side code."},"children":[]}]}]}]}]}],"sectionId":"/api/rpc/reference/section/authentication/generate-api-credentials"}],"sectionId":"/api/rpc/reference/section/authentication/generate-api-credentials"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication/request-access-token"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Next, exchange your credentials for a temporary access token by making a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request against the OAuth2 token endpoint: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.cropster.com/oauth2/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter must include all OAuth scopes that are required for subsequent API requests. For example, to access roasted inventory data, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inventory.roast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must be included."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"openapi-code-sample","attributes":{"descriptionFile":"api-docs-api/oauth/oauth-api.yaml","operationId":"oauth2Token","codeSamplesResolved":[{"lang":"shell","title":"curl","source":"curl -i -X POST \\\n  https://auth.cropster.com/oauth2/token \\\n  -H 'Content-Type: application/x-www-form-urlencoded' \\\n  -d grant_type=client_credentials \\\n  -d 'client_id=<CLIENT_ID>' \\\n  -d 'client_secret=<CLIENT_SECRET>' \\\n  -d scope=inventory.green%20inventory.roast%20inventory.blend"},{"lang":"javascript","title":"JavaScript","source":"const formData = {\n  grant_type: 'client_credentials',\n  client_id: '<CLIENT_ID>',\n  client_secret: '<CLIENT_SECRET>',\n  scope: 'inventory.green%20inventory.roast%20inventory.blend'\n};\n\nconst resp = await fetch(\n  `https://auth.cropster.com/oauth2/token`,\n  {\n    method: 'POST',\n    headers: {\n      'Content-Type': 'application/x-www-form-urlencoded'\n    },\n    body: new URLSearchParams(formData).toString()\n  }\n);\n\nconst data = await resp.text();\nconsole.log(data);"},{"lang":"javascript","title":"Node.js","source":"import fetch from 'node-fetch';\n\nasync function run() {\n  const formData = {\n    grant_type: 'client_credentials',\n    client_id: '<CLIENT_ID>',\n    client_secret: '<CLIENT_SECRET>',\n    scope: 'inventory.green%20inventory.roast%20inventory.blend'\n  };\n\n  const resp = await fetch(\n    `https://auth.cropster.com/oauth2/token`,\n    {\n      method: 'POST',\n      headers: {\n        'Content-Type': 'application/x-www-form-urlencoded'\n      },\n      body: new URLSearchParams(formData).toString()\n    }\n  );\n\n  const data = await resp.text();\n  console.log(data);\n}\n\nrun();"},{"lang":"python","title":"Python","source":"import requests\n\nurl = \"https://auth.cropster.com/oauth2/token\"\n\npayload = {\n  \"grant_type\": \"client_credentials\",\n  \"client_id\": \"<CLIENT_ID>\",\n  \"client_secret\": \"<CLIENT_SECRET>\",\n  \"scope\": \"inventory.green%20inventory.roast%20inventory.blend\"\n}\n\nheaders = {\"Content-Type\": \"application/x-www-form-urlencoded\"}\n\nresponse = requests.post(url, data=payload, headers=headers)\n\ndata = response.json()\nprint(data)"},{"lang":"java","title":"Java","source":"import java.net.*;\nimport java.net.http.*;\nimport java.util.*;\nimport java.nio.charset.StandardCharsets;\nimport java.util.stream.Collectors;\n\npublic class App {\n  public static void main(String[] args) throws Exception {\n    var httpClient = HttpClient.newBuilder().build();\n\n    var formParams = List.of(\n      Map.entry(\"grant_type\", \"client_credentials\"),\n      Map.entry(\"client_id\", \"<CLIENT_ID>\"),\n      Map.entry(\"client_secret\", \"<CLIENT_SECRET>\"),\n      Map.entry(\"scope\", \"inventory.green%20inventory.roast%20inventory.blend\")\n    );\n\n    var form = formParams.stream()\n      .map(e -> e.getKey() + \"=\" + URLEncoder.encode(e.getValue(), StandardCharsets.UTF_8))\n      .collect(Collectors.joining(\"&\"));\n\n    var host = \"https://auth.cropster.com\";\n    var pathname = \"/oauth2/token\";\n    var request = HttpRequest.newBuilder()\n      .POST(HttpRequest.BodyPublishers.ofString(form))\n      .uri(URI.create(host + pathname ))\n      .header(\"Content-Type\", \"application/x-www-form-urlencoded\")\n      .build();\n\n    var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());\n\n    System.out.println(response.body());\n  }\n}"},{"lang":"csharp","title":"C#","source":"using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\nusing System.Collections.Generic;\n\npublic class Program\n{\n  public static async Task Main()\n  {\n    System.Net.Http.HttpClient client = new();\n\n\n    List<KeyValuePair<string, string>> postData = new List<KeyValuePair<string, string>>();\n    postData.Add(new KeyValuePair<string, string>(\"grant_type\", \"client_credentials\"));\n    postData.Add(new KeyValuePair<string, string>(\"client_id\", \"<CLIENT_ID>\"));\n    postData.Add(new KeyValuePair<string, string>(\"client_secret\", \"<CLIENT_SECRET>\"));\n    postData.Add(new KeyValuePair<string, string>(\"scope\", \"inventory.green%20inventory.roast%20inventory.blend\"));\n\n    using HttpResponseMessage request = await client.PostAsync(\"https://auth.cropster.com/oauth2/token\", new FormUrlEncodedContent(postData));\n    string response = await request.Content.ReadAsStringAsync();\n\n    Console.WriteLine(response);\n  }\n}"},{"lang":"php","title":"PHP","source":"/**\n * Requires libcurl\n */\n\n$curl = curl_init();\n\n$payload = \"grant_type=client_credentials&client_id=%3CCLIENT_ID%3E&client_secret=%3CCLIENT_SECRET%3E&scope=inventory.green%2520inventory.roast%2520inventory.blend\";\n\ncurl_setopt_array($curl, [\n  CURLOPT_HTTPHEADER => [\n    \"Content-Type: application/x-www-form-urlencoded\"\n  ],\n  CURLOPT_POSTFIELDS => $payload,\n  CURLOPT_URL => \"https://auth.cropster.com/oauth2/token\",\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_CUSTOMREQUEST => \"POST\",\n]);\n\n$response = curl_exec($curl);\n$error = curl_error($curl);\n\ncurl_close($curl);\n\nif ($error) {\n  echo \"cURL Error #:\" . $error;\n} else {\n  echo $response;\n}"},{"lang":"go","title":"Go","source":"package main\n\nimport (\n  \"fmt\"\n  \"net/url\"\n  \"strconv\"\n  \"strings\"\n  \"net/http\"\n  \"io/ioutil\"\n)\n\nfunc main() {\n  reqUrl := \"https://auth.cropster.com/oauth2/token\"\n  data := url.Values{}\n  data.Add(\"grant_type\", \"client_credentials\")\n  data.Add(\"client_id\", \"<CLIENT_ID>\")\n  data.Add(\"client_secret\", \"<CLIENT_SECRET>\")\n  data.Add(\"scope\", \"inventory.green%20inventory.roast%20inventory.blend\")\n  req, err := http.NewRequest(\"POST\", reqUrl, strings.NewReader(data.Encode()))\n  if err != nil {\n    panic(err)\n  }\n  req.Header.Add(\"Content-Type\", \"application/x-www-form-urlencoded\")\n  req.Header.Add(\"Content-Length\", strconv.Itoa(len(data.Encode())))\n  res, err := http.DefaultClient.Do(req)\n  if err != nil {\n    panic(err)\n  }\n  defer res.Body.Close()\n  body, err := ioutil.ReadAll(res.Body)\n  if err != nil {\n    panic(err)\n  }\n\n  fmt.Println(res)\n  fmt.Println(string(body))\n}"},{"lang":"ruby","title":"Ruby","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI('https://auth.cropster.com/oauth2/token')\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest['Content-Type'] = 'application/x-www-form-urlencoded'\nrequest.body = URI.encode_www_form({\n  grant_type: 'client_credentials',\n  client_id: '<CLIENT_ID>',\n  client_secret: '<CLIENT_SECRET>',\n  scope: 'inventory.green%20inventory.roast%20inventory.blend'\n})\n\nresponse = http.request(request)\nputs response.read_body\n"},{"lang":"r","title":"R","source":"library(httr)\n\nbody <- list(\n  grant_type = \"client_credentials\",\n  client_id = \"<CLIENT_ID>\",\n  client_secret = \"<CLIENT_SECRET>\",\n  scope = \"inventory.green%20inventory.roast%20inventory.blend\"\n)\n\nurl = \"https://auth.cropster.com/oauth2/token\"\n\ndata_req <- POST(\n  url,\n  add_headers(\"Content-Type\" = \"application/x-www-form-urlencoded\"),\n  body = body,\n  encode = \"form\",\n  verbose()\n)\n\ncontent(data_req)"},{"lang":"clike","title":"Payload application/x-www-form-urlencoded","source":"grant_type=client_credentials&client_id=%3CCLIENT_ID%3E&client_secret=%3CCLIENT_SECRET%3E&scope=inventory.green%2520inventory.roast%2520inventory.blend"}]},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the request is successful, the response contains the access token that must be set as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer: <ACCESS_TOKEN>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of all subsequent API requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"markdoc-example","attributes":{"renderDemo":false},"children":[{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"access_token\": \"<ACCESS_TOKEN>\",\n    \"expires_in\": 28799,\n    \"scope\": \"inventory.green%20inventory.roast%20inventory.blend\",\n    \"token_type\": \"bearer\"\n}\n","language":"markdown","title":"Successful Response","exampleContent":{"$$mdtype":"Node","errors":[],"lines":[],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[94,100],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[94,100],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[94,100],"inline":true,"attributes":{"content":"{"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":94},"end":{"line":100}}},{"$$mdtype":"Node","errors":[],"lines":[94,100],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":94},"end":{"line":100}}},{"$$mdtype":"Node","errors":[],"lines":[94,100],"inline":true,"attributes":{"content":"\"access_token\": \"<ACCESS_TOKEN>\","},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":94},"end":{"line":100}}},{"$$mdtype":"Node","errors":[],"lines":[94,100],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":94},"end":{"line":100}}},{"$$mdtype":"Node","errors":[],"lines":[94,100],"inline":true,"attributes":{"content":"\"expires_in\": 28799,"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":94},"end":{"line":100}}},{"$$mdtype":"Node","errors":[],"lines":[94,100],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":94},"end":{"line":100}}},{"$$mdtype":"Node","errors":[],"lines":[94,100],"inline":true,"attributes":{"content":"\"scope\": \"inventory.green%20inventory.roast%20inventory.blend\","},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":94},"end":{"line":100}}},{"$$mdtype":"Node","errors":[],"lines":[94,100],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":94},"end":{"line":100}}},{"$$mdtype":"Node","errors":[],"lines":[94,100],"inline":true,"attributes":{"content":"\"token_type\": \"bearer\""},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":94},"end":{"line":100}}},{"$$mdtype":"Node","errors":[],"lines":[94,100],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":94},"end":{"line":100}}},{"$$mdtype":"Node","errors":[],"lines":[94,100],"inline":true,"attributes":{"content":"}"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":94},"end":{"line":100}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":94},"end":{"line":100}}}],"type":"paragraph","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":94},"end":{"line":100}}}],"type":"document","annotations":[],"slots":{}}},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Access Token Lifetime"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The access token is valid for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8 hours"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You should cache the token in your application and reuse it until it expires to reduce latency and avoid unnecessary token requests."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/api/rpc/reference/section/authentication/request-access-token"}],"sectionId":"/api/rpc/reference/section/authentication/request-access-token"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/request-format"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Request Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section details the required request format for obtaining an access token and the structure of the response you will receive."},"children":[]}]}]}]}],"sectionId":"/api/rpc/reference/section/request-format"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/request-format/request-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Request Parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following parameters are required for the access token request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"json-schema","attributes":{"schema":{"$ref":"../oauth/oauth-api.yaml#/components/schemas/oauth2TokenRequest"},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/oauth2TokenRequest"},"oauth2TokenRequest":{"type":"object","properties":{"grant_type":{"type":"string","description":"OAuth grant type must be set to `client_credentials`.","example":"client_credentials"},"client_id":{"type":"string","description":"OAuth client ID that was generated when the service account was created.","example":"<CLIENT_ID>"},"client_secret":{"type":"string","description":"OAuth client secret that was generated when the service account was created.","example":"<CLIENT_SECRET>"},"scope":{"type":"string","description":"OAuth scopes separated by url-encoded whitespaces (`%20`). Only scopes that were granted to the service account can be requested here.","example":"inventory.green%20inventory.roast%20inventory.blend"}}}}}}},"children":[]}]}],"sectionId":"/api/rpc/reference/section/request-format/request-parameters"}],"sectionId":"/api/rpc/reference/section/request-format/request-parameters"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/request-format/response-fields"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Response Fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful request returns the access token along with its associated metadata:"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"json-schema","attributes":{"schema":{"$ref":"../oauth/oauth-api.yaml#/components/schemas/oauth2TokenResponse"},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/oauth2TokenResponse"},"oauth2TokenResponse":{"type":"object","properties":{"access_token":{"type":"string","description":"OAuth access token that must be used in the `Authorization` header as `Bearer <ACCESS_TOKEN>`.","example":"client_credentials"},"expires_in":{"type":"integer","description":"Lifetime in seconds of the access token.","example":28799},"scope":{"type":"string","description":"A string containing the list of permissions granted to the token. Scopes are delimited by a URL-encoded space (`%20`). Note: To get an array of scopes, you must first URL-decode the string and then split it by the space character.","example":"inventory.green%20inventory.roast%20inventory.blend"},"token_type":{"type":"string","description":"Type of the issued token. The value is always `Bearer`.","example":"Bearer"}}}}}}},"children":[]}]}],"sectionId":"/api/rpc/reference/section/request-format/response-fields"}],"sectionId":"/api/rpc/reference/section/request-format/response-fields"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/error-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each API request is returning a status code that indicates if the request was successfully"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed. In the following, the most common HTTP status codes are listed:"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"width":"30%"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Status Code "},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200 OK"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was successful."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request couldn't be processed by the server due to an invalid request. Possible reasons can be missing or invalid query parameters, invalid JSON payload or malformed URL."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provided authentication credentials are not correct. Please check the section Authentication on how to provide valid authentication credentials."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403 Forbidden"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client doesn't have permissions to perform the request. Please check the endpoint documentation on which permissions are required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"405 Method Not Allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This error indicates that the requested operation is not supported. For example, this error can be caused when a POST request is not supported by an endpoint."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422 Unprocessable Entity"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request failed due to semantic errors in the request body. Examples of semantic errors are missing attributes or the violation of business rules (e.g. creating a green lot with a negative weight)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client has sent too many requests in a given amount of time. Please check the Rate Limiting section for more details."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Server Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An internal error encountered within Cropster. Please check the Cropster status page to verify if all systems are operational."},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To handle errors programmatically, each error response contains one of the following error codes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"width":"30%"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Code "},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invalid_authentication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the authentication credentials provided are invalid. For example, the JWT is missing or is expired."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access_denied"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the user is authenticated but does not have the required permissions to access the requested resource. For example, a user without the appropriate role"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attempts to perform a restricted operation."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource_not_found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the specified resource could not be found. For example, an object is request by an ID that does not exist."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invalid_request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the request could not be completed due to invalid or missing information. Please review the documentation and try again."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invalid_weight"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the weight parameter in the request is invalid. For example, a negative weight amount is specified."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invalid_price"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the price parameter in the request is invalid. For example, a negative price amount is provided."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invalid_json"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the provided request is malformed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invalid_parameter"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A general-purpose error indicating that one or more parameters in the request failed validation. This is a fallback error and should include a descriptive message with more detail. Note, this error should not normally be returned unless a more specific code is not applicable."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"missing_parameter"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that a required parameter is missing from the request. For example, the name property is omitted in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"importGreenLot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource_conflict"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the request contains conflicting parameters. For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"importGreenLot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request specifies location ID and location at the same time."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unsupported_currency"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the specified currency is not an ISO 8601 compliant currency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unsupported_unit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the specified weight unit is not supported. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LBS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currently accepted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"too_many_requests"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the client has sent too many requests in a given amount of time."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bulk_operation_failed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that one or more issues occurred during the processing of a bulk request."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"server_error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates an internal server error occurred while processing the request. The accompanying error message should provide additional context."},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/api/rpc/reference/section/error-handling"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/pagination"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RPC API uses cursor-based pagination for read-centric, listing endpoints. The results are delivered in reverse-chronological order. This means that the most recently created results appear first in the result set. For the time being, only forward navigation is supported. The default page size is set to 50 items per page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.pagination.endCursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the response indicates if there are more pages. Pass this cursor value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"params.pagination.after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the next request to retrieve the next page. If there are no further pages, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.pagination.endCursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be null."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/api/rpc/reference/section/pagination"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pagination/pagination-request-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pagination Request Parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"json-schema","attributes":{"schema":{"title":"","type":"object","properties":{"params.pagination.after":{"type":"string","description":"Cursor value to retrieve the result of the next page. This value is obtained from the `meta.pagination.endCursor` field of the previous response. If not specified or `null`, the first page of results is returned."},"params.pagination.limit":{"type":"int","description":"Specifies the page size of the result set. The value must be in the range between 1 and 100. If not specified, the default value of 50 is used.","minimum":1,"maximum":100}}},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"title":"","type":"object","properties":{"params.pagination.after":{"type":"string","description":"Cursor value to retrieve the result of the next page. This value is obtained from the `meta.pagination.endCursor` field of the previous response. If not specified or `null`, the first page of results is returned."},"params.pagination.limit":{"type":"int","description":"Specifies the page size of the result set. The value must be in the range between 1 and 100. If not specified, the default value of 50 is used.","minimum":1,"maximum":100}}}}}}},"children":[]}]}],"sectionId":"/api/rpc/reference/section/pagination/pagination-request-parameters"}],"sectionId":"/api/rpc/reference/section/pagination/pagination-request-parameters"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pagination/pagination-response-field"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pagination Response Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"json-schema","attributes":{"schema":{"title":"","type":"object","properties":{"meta.pagination.endCursor":{"type":"string","description":"Cursor value to retrieve the records of the next page. This value should be passed in the `params.pagination.after` field of the next request. If there are no further pages, this value is `null`."}}},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"title":"","type":"object","properties":{"meta.pagination.endCursor":{"type":"string","description":"Cursor value to retrieve the records of the next page. This value should be passed in the `params.pagination.after` field of the next request. If there are no further pages, this value is `null`."}}}}}}},"children":[]}]}],"sectionId":"/api/rpc/reference/section/pagination/pagination-response-field"}],"sectionId":"/api/rpc/reference/section/pagination/pagination-response-field"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pagination/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the following the pagination mechanism is explained using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inventory.roast.listRoastedLots"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint as an example. The first request retrieves the first page of roasted lots created after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-01-01T00:00:00Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a page size of 10 records. Notice, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate that the first page should be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"markdoc-example","attributes":{"renderDemo":false},"children":[{"$$mdtype":"Node","type":"fence","attributes":{"content":"POST <BASE_PATH>/inventory.roast.listRoastedLots\nContent-type: application/json\nAuthorization: Bearer `<TOKEN>`\n{\n    \"params\": {\n        \"filter\": {\n            \"roastedDate\": {\n                \"from\": \"2025-01-01T00:00:00Z\"\n            }\n        },\n        \"pagination\": {\n            \"after\": null,\n            \"limit\": 10 \n        }\n    }\n}\n","title":"First request to retrive first page","exampleContent":{"$$mdtype":"Node","errors":[],"lines":[],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"POST <BASE_PATH>/inventory.roast.listRoastedLots"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"Content-type: application/json"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"Authorization: Bearer "},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"<TOKEN>"},"children":[],"type":"code","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"{"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"\"params\": {"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"\"filter\": {"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"\"roastedDate\": {"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"\"from\": \"2025-01-01T00:00:00Z\""},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"}"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"},"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"\"pagination\": {"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"\"after\": null,"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"\"limit\": 10"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"}"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"}"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}},{"$$mdtype":"Node","errors":[],"lines":[327,343],"inline":true,"attributes":{"content":"}"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}}],"type":"paragraph","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":327},"end":{"line":343}}}],"type":"document","annotations":[],"slots":{}}},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response of the above request contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.pagination.endCursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field that can be used to retrieve the next page. This value should be passed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"params.pagination.after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the next request. If there are no further pages, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.pagination.endCursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be null."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"markdoc-example","attributes":{"renderDemo":false},"children":[{"$$mdtype":"Node","type":"fence","attributes":{"content":" {\n  \"ok\": true,\n  \"result\": {\n    \"roasts\": [\n      ...\n    ]\n  },\n  \"meta\": {\n    \"pagination\": {\n      \"endCursor\": \n        \"aBc=\"\n    }\n  }\n}\n","language":"JSON","title":"Paginated response","exampleContent":{"$$mdtype":"Node","errors":[],"lines":[],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{"content":"{"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{"content":"\"ok\": true,"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{"content":"\"result\": {"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{"content":"\"roasts\": ["},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{"content":"..."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{"content":"]"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{"content":"},"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{"content":"\"meta\": {"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{"content":"\"pagination\": {"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{"content":"\"endCursor\":"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{"content":"\"aBc=\""},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{"content":"}"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{"content":"}"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}},{"$$mdtype":"Node","errors":[],"lines":[350,364],"inline":true,"attributes":{"content":"}"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}}],"type":"paragraph","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":350},"end":{"line":364}}}],"type":"document","annotations":[],"slots":{}}},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endCursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aBc="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was returned in the previous response, there are more pages"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available. To retrieve the next page, use this value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"params.pagination.after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the next request."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"markdoc-example","attributes":{"renderDemo":false},"children":[{"$$mdtype":"Node","type":"fence","attributes":{"content":"POST <BASE_PATH>/inventory.roast.listRoastedLots\nContent-type: application/json\nAuthorization: Bearer `<TOKEN>`\n{\n    \"params\": {\n        \"filter\": {\n            \"roastedDate\": {\n                \"from\": \"2025-01-01T00:00:00Z\"\n            }\n        },\n        \"pagination\": {\n            \"after\": \"aBc=\n        }\n    }\n}\n","title":"Second request to retrieve the next page","exampleContent":{"$$mdtype":"Node","errors":[],"lines":[],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"POST <BASE_PATH>/inventory.roast.listRoastedLots"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"Content-type: application/json"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"Authorization: Bearer "},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"<TOKEN>"},"children":[],"type":"code","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"{"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"\"params\": {"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"\"filter\": {"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"\"roastedDate\": {"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"\"from\": \"2025-01-01T00:00:00Z\""},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"}"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"},"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"\"pagination\": {"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"\"after\": \"aBc="},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"}"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"}"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}},{"$$mdtype":"Node","errors":[],"lines":[373,388],"inline":true,"attributes":{"content":"}"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}}],"type":"paragraph","annotations":[],"slots":{},"location":{"file":"api/rpc/reference.yaml","start":{"line":373},"end":{"line":388}}}],"type":"document","annotations":[],"slots":{}}},"children":[]}]}]}],"sectionId":"/api/rpc/reference/section/pagination/example"}],"sectionId":"/api/rpc/reference/section/pagination/example"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/rate-limiting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limiting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure fair usage and maintain optimal performance of the API, rate limiting is enforced on all endpoints. If a client exceeds the specified limits, the API will respond with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our standard rate limits are set as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 5 requests per second. This is the average throughput your application is allowed to execute."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Burst Limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 requests per second. Allows for short-term spikes in traffic. For example, your application can send up to 10 requests in a single, as long as the average rate remains within the 5 req/sec sustained limit."},"children":[]}]}]}]}]}]}],"sectionId":"/api/rpc/reference/section/rate-limiting"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our API is versioned to ensure that your integration remains stable and that future updates do not introduce breaking changes unexpectedly. We use URI path versioning, where the version is explicitly included in the request path."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current Version:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The current stable version of our API is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Future Versions:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When we introduce backward-incompatible changes, we will release a new API version (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Older versions are supported for a reasonable time, with a clear migration guide provided well in advance of retirement."},"children":[]}]}]}]}]}]}],"sectionId":"/api/rpc/reference/section/versioning"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/ai-tooling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Tooling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To accelerate your development workflow, you can integrate the Cropster API with various AI assistants and development tools:"},"children":[]}]}]}]}],"sectionId":"/api/rpc/reference/section/ai-tooling"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/ai-tooling/ai-assistant"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Assistant"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What it does:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Instantly gather quick insights, generate boilerplate code tailored to your use case, or troubleshoot configuration errors on the fly."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where to find it:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Click the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ask AI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button in the bottom-right corner of any documentation page, or type your question directly into the main search bar."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to use it:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Ask any question related to the Cropster API. The AI Assistant will provide concise answers, code snippets, and direct documentation references. You can also use the integrated copy button to quickly grab a prompt-optimized context of the API to paste into Claude, ChatGPT, or your preferred AI chatbot."},"children":[]}]}]}]}]}],"sectionId":"/api/rpc/reference/section/ai-tooling/ai-assistant"}],"sectionId":"/api/rpc/reference/section/ai-tooling/ai-assistant"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/ai-tooling/mcp-server"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MCP Server"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What it does:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" We now host a dedicated MCP server for developers using next-generation AI tools and IDEs (like Cursor, VS Code, Claude, or ChatGPT). This feature streams live API context, schemas, and definitions directly into your local development environment, significantly reducing integration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to use it:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Connect the Cropster MCP server URL to your IDE or AI client. For a deep dive into how MCP works and how to configure it in your specific environment, check out the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://modelcontextprotocol.io/docs/getting-started/intro"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Model Context Protocol Getting Started Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where to find it:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can reach the MCP server under the following link: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.cropster.com/mcp"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://docs.cropster.com/mcp"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or connecting directly to pre-defined AI tools here "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"connect-mcp","inline":true,"attributes":{"placement":"top"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"sectionId":"/api/rpc/reference/section/ai-tooling/mcp-server"}],"sectionId":"/api/rpc/reference/section/ai-tooling/mcp-server"}]}]}},{"type":"link","label":"Core Principles","link":"/api/rpc/reference/section/core-principles","routeSlug":"/api/rpc/reference/section/core-principles","content":null},{"type":"link","label":"Request Format","link":"/api/rpc/reference/section/request-format","routeSlug":"/api/rpc/reference/section/request-format","content":null},{"type":"group","label":"Authentication","link":"/api/rpc/reference/section/authentication","routeSlug":"/api/rpc/reference/section/authentication","items":[{"type":"link","label":"Generate API Credentials","link":"/api/rpc/reference/section/authentication/generate-api-credentials","routeSlug":"/api/rpc/reference/section/authentication/generate-api-credentials","content":null},{"type":"link","label":"Request Access Token","link":"/api/rpc/reference/section/authentication/request-access-token","routeSlug":"/api/rpc/reference/section/authentication/request-access-token","content":null}],"content":null},{"type":"group","label":"Request Format","link":"/api/rpc/reference/section/request-format","routeSlug":"/api/rpc/reference/section/request-format","items":[{"type":"link","label":"Request Parameters","link":"/api/rpc/reference/section/request-format/request-parameters","routeSlug":"/api/rpc/reference/section/request-format/request-parameters","content":null},{"type":"link","label":"Response Fields","link":"/api/rpc/reference/section/request-format/response-fields","routeSlug":"/api/rpc/reference/section/request-format/response-fields","content":null}],"content":null},{"type":"link","label":"Error Handling","link":"/api/rpc/reference/section/error-handling","routeSlug":"/api/rpc/reference/section/error-handling","content":null},{"type":"group","label":"Pagination","link":"/api/rpc/reference/section/pagination","routeSlug":"/api/rpc/reference/section/pagination","items":[{"type":"link","label":"Pagination Request Parameters","link":"/api/rpc/reference/section/pagination/pagination-request-parameters","routeSlug":"/api/rpc/reference/section/pagination/pagination-request-parameters","content":null},{"type":"link","label":"Pagination Response Field","link":"/api/rpc/reference/section/pagination/pagination-response-field","routeSlug":"/api/rpc/reference/section/pagination/pagination-response-field","content":null},{"type":"link","label":"Example","link":"/api/rpc/reference/section/pagination/example","routeSlug":"/api/rpc/reference/section/pagination/example","content":null}],"content":null},{"type":"link","label":"Rate Limiting","link":"/api/rpc/reference/section/rate-limiting","routeSlug":"/api/rpc/reference/section/rate-limiting","content":null},{"type":"link","label":"Versioning","link":"/api/rpc/reference/section/versioning","routeSlug":"/api/rpc/reference/section/versioning","content":null},{"type":"group","label":"AI Tooling","link":"/api/rpc/reference/section/ai-tooling","routeSlug":"/api/rpc/reference/section/ai-tooling","items":[{"type":"link","label":"AI Assistant","link":"/api/rpc/reference/section/ai-tooling/ai-assistant","routeSlug":"/api/rpc/reference/section/ai-tooling/ai-assistant","content":null},{"type":"link","label":"MCP Server","link":"/api/rpc/reference/section/ai-tooling/mcp-server","routeSlug":"/api/rpc/reference/section/ai-tooling/mcp-server","content":null}],"content":null},{"type":"separator","label":"Sample","content":null},{"type":"group","label":"Green","link":"/api/rpc/reference/green_samples","routeSlug":"/api/rpc/reference/green_samples","items":[{"label":"List Green Samples","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/green_samples/listgreensamples","routeSlug":"/api/rpc/reference/green_samples/listgreensamples","metadata":{"seo":{"title":"List Green Samples","description":"Retrieves a list of green samples."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGreenSamples","name":"List Green Samples","isWebhook":false,"pointer":"/paths/~1sample.green.listGreenSamples/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Green Samples","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of green samples."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["sample.green"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamGreenSampleFilterParam"}},"schemaId":"components/schemas/RequestParamGreenSampleFilterParam","pointer":"/paths/~1sample.green.listGreenSamples/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sample.green.listGreenSamples","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["sample.green"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestParamGreenSampleFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/sample.green.listGreenSamples","href":"green_samples/listgreensamples","openApiOperationId":"listGreenSamples","summary":"List Green Samples"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestParamGreenSampleFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamGreenSampleFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGreenSamplesResponse"}},"schemaId":"components/schemas/ListGreenSamplesResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1sample.green.listGreenSamples/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListGreenSamplesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGreenSamplesResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/green_samples/listgreensamples"}],"panels":[]}]},"httpPath":"/sample.green.listGreenSamples"},{"label":"Get Green Samples by IDs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/green_samples/getgreensamplesbyids","routeSlug":"/api/rpc/reference/green_samples/getgreensamplesbyids","metadata":{"seo":{"title":"Get Green Samples by IDs","description":"Retrieves green samples based on the provided list of IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGreenSamplesByIds","name":"Get Green Samples by IDs","isWebhook":false,"pointer":"/paths/~1sample.green.getGreenSamplesByIds/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Green Samples by IDs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves green samples based on the provided list of IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["sample.green"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamGreenSampleIdsFilterParam"}},"schemaId":"components/schemas/PaginationlessRequestParamGreenSampleIdsFilterParam","pointer":"/paths/~1sample.green.getGreenSamplesByIds/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sample.green.getGreenSamplesByIds","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["sample.green"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamGreenSampleIdsFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/sample.green.getGreenSamplesByIds","href":"green_samples/getgreensamplesbyids","openApiOperationId":"getGreenSamplesByIds","summary":"Get Green Samples by IDs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/PaginationlessRequestParamGreenSampleIdsFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamGreenSampleIdsFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetGreenSamplesByIdsResponse"}},"schemaId":"components/schemas/GetGreenSamplesByIdsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1sample.green.getGreenSamplesByIds/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetGreenSamplesByIdsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetGreenSamplesByIdsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/green_samples/getgreensamplesbyids"}],"panels":[]}]},"httpPath":"/sample.green.getGreenSamplesByIds"}],"content":{"contentType":"group","meta":{"name":"Green_Samples"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Green","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sample.green"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace contains all operations for managing your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"green samples."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this API, you can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve existing green samples."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sample.green.listGreenSamples","summary":"List Green Samples","prefix":{"name":"post","color":"post"},"badges":[],"link":"/green_samples/listgreensamples","deprecated":false},{"title":"/sample.green.getGreenSamplesByIds","summary":"Get Green Samples by IDs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/green_samples/getgreensamplesbyids","deprecated":false}]}]}]}]}},{"type":"separator","label":"Quality","content":null},{"type":"group","label":"Cupping","link":"/api/rpc/reference/cupping","routeSlug":"/api/rpc/reference/cupping","items":[{"label":"Lists Cuppings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/cupping/listcuppings","routeSlug":"/api/rpc/reference/cupping/listcuppings","metadata":{"seo":{"title":"Lists Cuppings","description":"Retrieves a list of cuppings, their cupped coffees and their result summary."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCuppings","name":"Lists Cuppings","isWebhook":false,"pointer":"/paths/~1quality.cupping.listCuppings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists Cuppings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of cuppings, their cupped coffees and their result summary."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["quality.cupping"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamCuppingFilterParam"}},"schemaId":"components/schemas/RequestParamCuppingFilterParam","pointer":"/paths/~1quality.cupping.listCuppings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quality.cupping.listCuppings","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["quality.cupping"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestParamCuppingFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/quality.cupping.listCuppings","href":"cupping/listcuppings","openApiOperationId":"listCuppings","summary":"Lists Cuppings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestParamCuppingFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamCuppingFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCuppingsResponse"}},"schemaId":"components/schemas/ListCuppingsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1quality.cupping.listCuppings/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCuppingsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCuppingsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cupping/listcuppings"}],"panels":[]}]},"httpPath":"/quality.cupping.listCuppings"},{"label":"Lists Cupping Results","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/cupping/listcuppingresults","routeSlug":"/api/rpc/reference/cupping/listcuppingresults","metadata":{"seo":{"title":"Lists Cupping Results","description":"Retrieves a list of cupping results and their items for the specified cupped coffee ids. At most 100 cupped coffee ids can be provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCuppingResults","name":"Lists Cupping Results","isWebhook":false,"pointer":"/paths/~1quality.cupping.listCuppingResults/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists Cupping Results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of cupping results and their items for the specified cupped coffee ids. At most 100 cupped coffee ids can be provided."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["quality.cupping"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamCuppingResultFilterParam"}},"schemaId":"components/schemas/RequestParamCuppingResultFilterParam","pointer":"/paths/~1quality.cupping.listCuppingResults/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quality.cupping.listCuppingResults","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["quality.cupping"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestParamCuppingResultFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/quality.cupping.listCuppingResults","href":"cupping/listcuppingresults","openApiOperationId":"listCuppingResults","summary":"Lists Cupping Results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestParamCuppingResultFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamCuppingResultFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCuppingResultsResponse"}},"schemaId":"components/schemas/ListCuppingResultsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1quality.cupping.listCuppingResults/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCuppingResultsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCuppingResultsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cupping/listcuppingresults"}],"panels":[]}]},"httpPath":"/quality.cupping.listCuppingResults"},{"label":"Gets cuppings by ids","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/cupping/getcuppingsbyids","routeSlug":"/api/rpc/reference/cupping/getcuppingsbyids","metadata":{"seo":{"title":"Gets cuppings by ids","description":"Retrives a list of cuppings, their cupped coffees and their result summary for the given list of cupping ids. A list of at most 100 cupping ids must be provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCuppingsByIds","name":"Gets cuppings by ids","isWebhook":false,"pointer":"/paths/~1quality.cupping.getCuppingsByIds/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets cuppings by ids","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrives a list of cuppings, their cupped coffees and their result summary for the given list of cupping ids. A list of at most 100 cupping ids must be provided."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["quality.cupping"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamCuppingIdsFilterParam"}},"schemaId":"components/schemas/PaginationlessRequestParamCuppingIdsFilterParam","pointer":"/paths/~1quality.cupping.getCuppingsByIds/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quality.cupping.getCuppingsByIds","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["quality.cupping"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamCuppingIdsFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/quality.cupping.getCuppingsByIds","href":"cupping/getcuppingsbyids","openApiOperationId":"getCuppingsByIds","summary":"Gets cuppings by ids"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/PaginationlessRequestParamCuppingIdsFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamCuppingIdsFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCuppingsByIdsResponse"}},"schemaId":"components/schemas/GetCuppingsByIdsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1quality.cupping.getCuppingsByIds/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCuppingsByIdsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCuppingsByIdsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cupping/getcuppingsbyids"}],"panels":[]}]},"httpPath":"/quality.cupping.getCuppingsByIds"}],"content":{"contentType":"group","meta":{"name":"Cupping"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cupping","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quality.cupping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace contains all operations for managing your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cuppings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this API, you can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve existing cuppings."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve existing cupping results."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/quality.cupping.listCuppings","summary":"Lists Cuppings","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cupping/listcuppings","deprecated":false},{"title":"/quality.cupping.listCuppingResults","summary":"Lists Cupping Results","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cupping/listcuppingresults","deprecated":false},{"title":"/quality.cupping.getCuppingsByIds","summary":"Gets cuppings by ids","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cupping/getcuppingsbyids","deprecated":false}]}]}]}]}},{"type":"group","label":"Physical","link":"/api/rpc/reference/physical","routeSlug":"/api/rpc/reference/physical","items":[{"label":"Lists Physical Analyses","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/physical/listphysicalanalyses","routeSlug":"/api/rpc/reference/physical/listphysicalanalyses","metadata":{"seo":{"title":"Lists Physical Analyses","description":"Retrieves a paginated list of physical analyses, optionally filtered by analysis date range or analysed lot."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPhysicalAnalyses","name":"Lists Physical Analyses","isWebhook":false,"pointer":"/paths/~1quality.physical.listPhysicalAnalyses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists Physical Analyses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a paginated list of physical analyses, optionally filtered by analysis date range or analysed lot."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["quality.physical"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamPhysicalAnalysisFilterParam"}},"schemaId":"components/schemas/RequestParamPhysicalAnalysisFilterParam","pointer":"/paths/~1quality.physical.listPhysicalAnalyses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quality.physical.listPhysicalAnalyses","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["quality.physical"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestParamPhysicalAnalysisFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/quality.physical.listPhysicalAnalyses","href":"physical/listphysicalanalyses","openApiOperationId":"listPhysicalAnalyses","summary":"Lists Physical Analyses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestParamPhysicalAnalysisFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamPhysicalAnalysisFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPhysicalAnalysesResponse"}},"schemaId":"components/schemas/ListPhysicalAnalysesResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1quality.physical.listPhysicalAnalyses/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPhysicalAnalysesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPhysicalAnalysesResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/physical/listphysicalanalyses"}],"panels":[]}]},"httpPath":"/quality.physical.listPhysicalAnalyses"}],"content":{"contentType":"group","meta":{"name":"Physical"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Physical","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quality.physical"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace contains all operations for managing your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"physical analyses."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this API, you can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve existing physical analyses."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/quality.physical.listPhysicalAnalyses","summary":"Lists Physical Analyses","prefix":{"name":"post","color":"post"},"badges":[],"link":"/physical/listphysicalanalyses","deprecated":false}]}]}]}]}},{"type":"separator","label":"MRP","content":null},{"type":"group","label":"Product","link":"/api/rpc/reference/product","routeSlug":"/api/rpc/reference/product","items":[{"label":"Sync Products and Variants","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/product/syncproducts","routeSlug":"/api/rpc/reference/product/syncproducts","metadata":{"seo":{"title":"Sync Products and Variants","description":"Creates or updates products and their variants based on the externalId of the product. When the product can be found it will be updated, otherwise a new product will be created. Newly created products must be reviewed manually in C-SAR. Once a variant was created it is immutable. Products can be created without variants, but variants cannot be 'null'. Products and variants will not be deleted with this request. It is possible to delete products and variants in C-SAR. Be aware that you can only submit 50 products at a time."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"syncProducts","name":"Sync Products and Variants","isWebhook":false,"pointer":"/paths/~1mrp.product.syncProducts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync Products and Variants","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates products and their variants based on the externalId of the product.\nWhen the product can be found it will be updated, otherwise a new product will be\ncreated. Newly created products must be reviewed manually in C-SAR. Once a variant was\ncreated it is immutable. Products can be created without variants, but variants cannot\nbe 'null'. Products and variants will not be deleted with this request.\nIt is possible to delete products and variants in C-SAR.\nBe aware that you can only submit 50 products at a time."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["mrp.product"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDataParamListProductRequest"}},"schemaId":"components/schemas/RequestDataParamListProductRequest","pointer":"/paths/~1mrp.product.syncProducts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/mrp.product.syncProducts","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["mrp.product"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestDataParamListProductRequest"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/mrp.product.syncProducts","href":"product/syncproducts","openApiOperationId":"syncProducts","summary":"Sync Products and Variants"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestDataParamListProductRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDataParamListProductRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SyncedProductResponse"}},"schemaId":"components/schemas/SyncedProductResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entities","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkOperationErrorResponse"}},"schemaId":"components/schemas/BulkOperationErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1mrp.product.syncProducts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SyncedProductResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SyncedProductResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/BulkOperationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkOperationErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product/syncproducts"}],"panels":[]}]},"httpPath":"/mrp.product.syncProducts"}],"content":{"contentType":"group","meta":{"name":"Product"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mrp.product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace contains all operations for managing your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"products."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this API, you can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Synchronize products and variants to C-SAR."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/mrp.product.syncProducts","summary":"Sync Products and Variants","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product/syncproducts","deprecated":false}]}]}]}]}},{"type":"group","label":"Order","link":"/api/rpc/reference/order","routeSlug":"/api/rpc/reference/order","items":[{"label":"Set Orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/order/syncorders","routeSlug":"/api/rpc/reference/order/syncorders","metadata":{"seo":{"title":"Set Orders","description":"Creates or updates orders based on the externalId of the order. If an order with the externalId does not exist a new order with status OPEN will be created. This status changes when the order is processed during the fulfillment process. The order date won't be modified when updating the order. Orders can only be updated as long as their status is OPEN. Be aware that you can only submit 50 orders at once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"syncOrders","name":"Set Orders","isWebhook":false,"pointer":"/paths/~1mrp.order.setOrders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set Orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates orders based on the externalId of the order. If an order with the\nexternalId does not exist a new order with status OPEN will be created. This status\nchanges when the order is processed during the fulfillment process. The order date won't\nbe modified when updating the order. Orders can only be updated as long as their status\nis OPEN.\nBe aware that you can only submit 50 orders at once.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["mrp.order"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDataParamListOrderRequest"}},"schemaId":"components/schemas/RequestDataParamListOrderRequest","pointer":"/paths/~1mrp.order.setOrders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/mrp.order.setOrders","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["mrp.order"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestDataParamListOrderRequest"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/mrp.order.setOrders","href":"order/syncorders","openApiOperationId":"syncOrders","summary":"Set Orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestDataParamListOrderRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDataParamListOrderRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SetOrderResponse"}},"schemaId":"components/schemas/SetOrderResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entities","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkOperationErrorResponse"}},"schemaId":"components/schemas/BulkOperationErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1mrp.order.setOrders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SetOrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SetOrderResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/BulkOperationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkOperationErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/syncorders"}],"panels":[]}]},"httpPath":"/mrp.order.setOrders"},{"label":"List Orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/order/listorders","routeSlug":"/api/rpc/reference/order/listorders","metadata":{"seo":{"title":"List Orders","description":"Returns a paginated list of orders for the organization, with optional filtering by state, external id and last-modified timestamp. Designed for external systems that poll for orders whose state has changed since their last request. Archived orders are never returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrders","name":"List Orders","isWebhook":false,"pointer":"/paths/~1mrp.order.listOrders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of orders for the organization, with optional filtering by\nstate, external id and last-modified timestamp. Designed for external systems\nthat poll for orders whose state has changed since their last request. Archived orders\nare never returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["mrp.order"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamOrderFilterParam"}},"schemaId":"components/schemas/RequestParamOrderFilterParam","pointer":"/paths/~1mrp.order.listOrders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/mrp.order.listOrders","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["mrp.order"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestParamOrderFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/mrp.order.listOrders","href":"order/listorders","openApiOperationId":"listOrders","summary":"List Orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestParamOrderFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamOrderFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}},"schemaId":"components/schemas/ListOrdersResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1mrp.order.listOrders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/listorders"}],"panels":[]}]},"httpPath":"/mrp.order.listOrders"}],"content":{"contentType":"group","meta":{"name":"Order"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mrp.order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace contains all operations for managing your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this API, you can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create or update orders and their order items."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List orders and poll for status changes since your last request."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/mrp.order.setOrders","summary":"Set Orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order/syncorders","deprecated":false},{"title":"/mrp.order.listOrders","summary":"List Orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order/listorders","deprecated":false}]}]}]}]}},{"type":"separator","label":"Inventory","content":null},{"type":"group","label":"Green","link":"/api/rpc/reference/green","routeSlug":"/api/rpc/reference/green","items":[{"label":"Transfer Green Lot To Location","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/green/transfergreenlottolocation","routeSlug":"/api/rpc/reference/green/transfergreenlottolocation","metadata":{"seo":{"title":"Transfer Green Lot To Location","description":"Transfers weight from a given green lot to another location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferGreenLotToLocation","name":"Transfer Green Lot To Location","isWebhook":false,"pointer":"/paths/~1inventory.green.transferGreenLotToLocation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer Green Lot To Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfers weight from a given green lot to another location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When transferring green lot weight the following cases need to be distinguish:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the green lot hasn't yet transferred to the destination location, a new green lot in the destination location will be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the green lot has already been transferred to the specified destination location, the green lot weight in the destination location will be increased."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please consider the following business constraints before you execute your request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consumed lots cannot be transferred"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transferred weight may not be negative"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transferred weight may be less or equal than the origin green lot weight"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["inventory.green"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDataParamTransferGreenLotRequest"}},"schemaId":"components/schemas/RequestDataParamTransferGreenLotRequest","pointer":"/paths/~1inventory.green.transferGreenLotToLocation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventory.green.transferGreenLotToLocation","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["inventory.green"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestDataParamTransferGreenLotRequest"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/inventory.green.transferGreenLotToLocation","href":"green/transfergreenlottolocation","openApiOperationId":"transferGreenLotToLocation","summary":"Transfer Green Lot To Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestDataParamTransferGreenLotRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDataParamTransferGreenLotRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferGreenLotToLocationResponse"}},"schemaId":"components/schemas/TransferGreenLotToLocationResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1inventory.green.transferGreenLotToLocation/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransferGreenLotToLocationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferGreenLotToLocationResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/green/transfergreenlottolocation"}],"panels":[]}]},"httpPath":"/inventory.green.transferGreenLotToLocation"},{"label":"Set Green Lot Weight","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/green/setgreenlotweight","routeSlug":"/api/rpc/reference/green/setgreenlotweight","metadata":{"seo":{"title":"Set Green Lot Weight","description":"Sets a new weight for a given green lot. When the green lot weight set it zero, the green lot will be marked as consumed. Notice that a negative weight is not supported."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setGreenLotWeight","name":"Set Green Lot Weight","isWebhook":false,"pointer":"/paths/~1inventory.green.setGreenLotWeight/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set Green Lot Weight","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sets a new weight for a given green lot. When the green lot weight set it zero, the\ngreen lot will be marked as consumed. Notice that a negative weight is not supported."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["inventory.green"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDataParamGreenLotWeightRequest"}},"schemaId":"components/schemas/RequestDataParamGreenLotWeightRequest","pointer":"/paths/~1inventory.green.setGreenLotWeight/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventory.green.setGreenLotWeight","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["inventory.green"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestDataParamGreenLotWeightRequest"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/inventory.green.setGreenLotWeight","href":"green/setgreenlotweight","openApiOperationId":"setGreenLotWeight","summary":"Set Green Lot Weight"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestDataParamGreenLotWeightRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDataParamGreenLotWeightRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmptyResponse"}},"schemaId":"components/schemas/EmptyResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1inventory.green.setGreenLotWeight/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmptyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmptyResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/green/setgreenlotweight"}],"panels":[]}]},"httpPath":"/inventory.green.setGreenLotWeight"},{"label":"List Green Lots","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/green/listgreenlots","routeSlug":"/api/rpc/reference/green/listgreenlots","metadata":{"seo":{"title":"List Green Lots","description":"Retrieves a list of green lots from the inventory."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGreenLots","name":"List Green Lots","isWebhook":false,"pointer":"/paths/~1inventory.green.listGreenLots/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Green Lots","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of green lots from the inventory."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["inventory.green"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamGreenFilterParam"}},"schemaId":"components/schemas/RequestParamGreenFilterParam","pointer":"/paths/~1inventory.green.listGreenLots/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventory.green.listGreenLots","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["inventory.green"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestParamGreenFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/inventory.green.listGreenLots","href":"green/listgreenlots","openApiOperationId":"listGreenLots","summary":"List Green Lots"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestParamGreenFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamGreenFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGreenLotsResponse"}},"schemaId":"components/schemas/ListGreenLotsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1inventory.green.listGreenLots/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListGreenLotsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGreenLotsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/green/listgreenlots"}],"panels":[]}]},"httpPath":"/inventory.green.listGreenLots"},{"label":"Import Green Lot","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/green/importgreenlot","routeSlug":"/api/rpc/reference/green/importgreenlot","metadata":{"seo":{"title":"Import Green Lot","description":"Imports a new green lot from an external system (e.g. ERP) into Cropster by an externalidentifier (= externalId). Optionally, providing the warehouse via locationis possible, by setting the location.externalId property."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"importGreenLot","name":"Import Green Lot","isWebhook":false,"pointer":"/paths/~1inventory.green.importGreenLot/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import Green Lot","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Imports a new green lot from an external system (e.g. ERP) into Cropster by an external"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identifier (= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Optionally, providing the warehouse via location"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is possible, by setting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location.externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["inventory.green"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDataParamImportGreenLotRequest"}},"schemaId":"components/schemas/RequestDataParamImportGreenLotRequest","pointer":"/paths/~1inventory.green.importGreenLot/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventory.green.importGreenLot","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["inventory.green"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestDataParamImportGreenLotRequest"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/inventory.green.importGreenLot","href":"green/importgreenlot","openApiOperationId":"importGreenLot","summary":"Import Green Lot"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestDataParamImportGreenLotRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDataParamImportGreenLotRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportGreenLotResponse"}},"schemaId":"components/schemas/ImportGreenLotResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1inventory.green.importGreenLot/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImportGreenLotResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportGreenLotResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/green/importgreenlot"}],"panels":[]}]},"httpPath":"/inventory.green.importGreenLot"},{"label":"Get Green Lots by IDs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/green/getgreenlotsbyids","routeSlug":"/api/rpc/reference/green/getgreenlotsbyids","metadata":{"seo":{"title":"Get Green Lots by IDs","description":"Retrieves green lots based on the provided list of IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGreenLotsByIds","name":"Get Green Lots by IDs","isWebhook":false,"pointer":"/paths/~1inventory.green.getGreenLotsByIds/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Green Lots by IDs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves green lots based on the provided list of IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["inventory.green"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamGreenLotIdsFilterParam"}},"schemaId":"components/schemas/PaginationlessRequestParamGreenLotIdsFilterParam","pointer":"/paths/~1inventory.green.getGreenLotsByIds/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventory.green.getGreenLotsByIds","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["inventory.green"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamGreenLotIdsFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/inventory.green.getGreenLotsByIds","href":"green/getgreenlotsbyids","openApiOperationId":"getGreenLotsByIds","summary":"Get Green Lots by IDs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/PaginationlessRequestParamGreenLotIdsFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamGreenLotIdsFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetGreenLotsByIdsResponse"}},"schemaId":"components/schemas/GetGreenLotsByIdsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1inventory.green.getGreenLotsByIds/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetGreenLotsByIdsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetGreenLotsByIdsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/green/getgreenlotsbyids"}],"panels":[]}]},"httpPath":"/inventory.green.getGreenLotsByIds"},{"label":"Get Green Lot Details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/green/getgreenlotdetailsbyids","routeSlug":"/api/rpc/reference/green/getgreenlotdetailsbyids","metadata":{"seo":{"title":"Get Green Lot Details","description":"Gets detailed information about green lots by their IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGreenLotDetailsByIds","name":"Get Green Lot Details","isWebhook":false,"pointer":"/paths/~1inventory.green.getGreenLotDetailsByIds/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Green Lot Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets detailed information about green lots by their IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["inventory.green"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamGreenLotIdsFilterParam"}},"schemaId":"components/schemas/PaginationlessRequestParamGreenLotIdsFilterParam","pointer":"/paths/~1inventory.green.getGreenLotDetailsByIds/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventory.green.getGreenLotDetailsByIds","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["inventory.green"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamGreenLotIdsFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/inventory.green.getGreenLotDetailsByIds","href":"green/getgreenlotdetailsbyids","openApiOperationId":"getGreenLotDetailsByIds","summary":"Get Green Lot Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/PaginationlessRequestParamGreenLotIdsFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamGreenLotIdsFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetGreenLotDetailsByIdsResponse"}},"schemaId":"components/schemas/GetGreenLotDetailsByIdsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1inventory.green.getGreenLotDetailsByIds/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetGreenLotDetailsByIdsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetGreenLotDetailsByIdsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/green/getgreenlotdetailsbyids"}],"panels":[]}]},"httpPath":"/inventory.green.getGreenLotDetailsByIds"}],"content":{"contentType":"group","meta":{"name":"Green"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Green","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inventory.green"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace contains all operations for managing your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"green lots."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this API, you can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import green lots from your ERP system to Cropster."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer green inventory to another location."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make weight adjustments to existing green lots."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the existing green lots from you inventory."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/inventory.green.transferGreenLotToLocation","summary":"Transfer Green Lot To Location","prefix":{"name":"post","color":"post"},"badges":[],"link":"/green/transfergreenlottolocation","deprecated":false},{"title":"/inventory.green.setGreenLotWeight","summary":"Set Green Lot Weight","prefix":{"name":"post","color":"post"},"badges":[],"link":"/green/setgreenlotweight","deprecated":false},{"title":"/inventory.green.listGreenLots","summary":"List Green Lots","prefix":{"name":"post","color":"post"},"badges":[],"link":"/green/listgreenlots","deprecated":false},{"title":"/inventory.green.importGreenLot","summary":"Import Green Lot","prefix":{"name":"post","color":"post"},"badges":[],"link":"/green/importgreenlot","deprecated":false},{"title":"/inventory.green.getGreenLotsByIds","summary":"Get Green Lots by IDs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/green/getgreenlotsbyids","deprecated":false},{"title":"/inventory.green.getGreenLotDetailsByIds","summary":"Get Green Lot Details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/green/getgreenlotdetailsbyids","deprecated":false}]}]}]}]}},{"type":"group","label":"Roast","link":"/api/rpc/reference/roast","routeSlug":"/api/rpc/reference/roast","items":[{"label":"List Roasted Lots","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/roast/getroastedlots","routeSlug":"/api/rpc/reference/roast/getroastedlots","metadata":{"seo":{"title":"List Roasted Lots","description":"Retrieves a list of roasted lots from inventory, optionally filterable by an inclusive roasting date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRoastedLots","name":"List Roasted Lots","isWebhook":false,"pointer":"/paths/~1inventory.roast.listRoastedLots/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Roasted Lots","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of roasted lots from inventory, optionally filterable by an inclusive\nroasting date."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["inventory.roast"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamRoastFilterParam"}},"schemaId":"components/schemas/RequestParamRoastFilterParam","pointer":"/paths/~1inventory.roast.listRoastedLots/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventory.roast.listRoastedLots","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["inventory.roast"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestParamRoastFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/inventory.roast.listRoastedLots","href":"roast/getroastedlots","openApiOperationId":"getRoastedLots","summary":"List Roasted Lots"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestParamRoastFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamRoastFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRoastedLotsResponse"}},"schemaId":"components/schemas/ListRoastedLotsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1inventory.roast.listRoastedLots/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRoastedLotsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRoastedLotsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roast/getroastedlots"}],"panels":[]}]},"httpPath":"/inventory.roast.listRoastedLots"},{"label":"List Profiles","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/roast/listprofiles","routeSlug":"/api/rpc/reference/roast/listprofiles","metadata":{"seo":{"title":"List Profiles","description":"Retrieves a list of processing profiles used for roasting. Can be filtered by created date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProfiles","name":"List Profiles","isWebhook":false,"pointer":"/paths/~1inventory.roast.listProfiles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Profiles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of processing profiles used for roasting. Can be filtered by created date."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["inventory.roast"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamProfileListFilterParam"}},"schemaId":"components/schemas/RequestParamProfileListFilterParam","pointer":"/paths/~1inventory.roast.listProfiles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventory.roast.listProfiles","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["inventory.roast"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestParamProfileListFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/inventory.roast.listProfiles","href":"roast/listprofiles","openApiOperationId":"listProfiles","summary":"List Profiles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestParamProfileListFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamProfileListFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListProfilesResponse"}},"schemaId":"components/schemas/ListProfilesResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1inventory.roast.listProfiles/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListProfilesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListProfilesResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roast/listprofiles"}],"panels":[]}]},"httpPath":"/inventory.roast.listProfiles"},{"label":"Get Roasted Lots by IDs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/roast/getroastedlotsbyids","routeSlug":"/api/rpc/reference/roast/getroastedlotsbyids","metadata":{"seo":{"title":"Get Roasted Lots by IDs","description":"Retrieves roasted lots based on the provided list of IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRoastedLotsByIds","name":"Get Roasted Lots by IDs","isWebhook":false,"pointer":"/paths/~1inventory.roast.getRoastedLotsByIds/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Roasted Lots by IDs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves roasted lots based on the provided list of IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["inventory.roast"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamRoastedLotIdsFilterParam"}},"schemaId":"components/schemas/PaginationlessRequestParamRoastedLotIdsFilterParam","pointer":"/paths/~1inventory.roast.getRoastedLotsByIds/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventory.roast.getRoastedLotsByIds","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["inventory.roast"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamRoastedLotIdsFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/inventory.roast.getRoastedLotsByIds","href":"roast/getroastedlotsbyids","openApiOperationId":"getRoastedLotsByIds","summary":"Get Roasted Lots by IDs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/PaginationlessRequestParamRoastedLotIdsFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamRoastedLotIdsFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRoastedLotsByIdsResponse"}},"schemaId":"components/schemas/GetRoastedLotsByIdsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1inventory.roast.getRoastedLotsByIds/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetRoastedLotsByIdsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRoastedLotsByIdsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roast/getroastedlotsbyids"}],"panels":[]}]},"httpPath":"/inventory.roast.getRoastedLotsByIds"},{"label":"Get Roast Details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/roast/getroastdetailsbyids","routeSlug":"/api/rpc/reference/roast/getroastdetailsbyids","metadata":{"seo":{"title":"Get Roast Details","description":"Gets detailed information about roasts by their IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRoastDetailsByIds","name":"Get Roast Details","isWebhook":false,"pointer":"/paths/~1inventory.roast.getRoastDetailsByIds/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Roast Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets detailed information about roasts by their IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["inventory.roast"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamRoastDetailsFilterParam"}},"schemaId":"components/schemas/PaginationlessRequestParamRoastDetailsFilterParam","pointer":"/paths/~1inventory.roast.getRoastDetailsByIds/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventory.roast.getRoastDetailsByIds","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["inventory.roast"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamRoastDetailsFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/inventory.roast.getRoastDetailsByIds","href":"roast/getroastdetailsbyids","openApiOperationId":"getRoastDetailsByIds","summary":"Get Roast Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/PaginationlessRequestParamRoastDetailsFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamRoastDetailsFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRoastDetailsByIdsResponse"}},"schemaId":"components/schemas/GetRoastDetailsByIdsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1inventory.roast.getRoastDetailsByIds/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetRoastDetailsByIdsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRoastDetailsByIdsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roast/getroastdetailsbyids"}],"panels":[]}]},"httpPath":"/inventory.roast.getRoastDetailsByIds"},{"label":"Get Curves For a Roast","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/roast/getroastcurvesbyid","routeSlug":"/api/rpc/reference/roast/getroastcurvesbyid","metadata":{"seo":{"title":"Get Curves For a Roast","description":"Gets the curves for a roast by the roasted lot ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRoastCurvesById","name":"Get Curves For a Roast","isWebhook":false,"pointer":"/paths/~1inventory.roast.getRoastCurvesById/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Curves For a Roast","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the curves for a roast by the roasted lot ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["inventory.roast"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamRoastCurvesFilterParam"}},"schemaId":"components/schemas/PaginationlessRequestParamRoastCurvesFilterParam","pointer":"/paths/~1inventory.roast.getRoastCurvesById/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventory.roast.getRoastCurvesById","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["inventory.roast"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamRoastCurvesFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/inventory.roast.getRoastCurvesById","href":"roast/getroastcurvesbyid","openApiOperationId":"getRoastCurvesById","summary":"Get Curves For a Roast"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/PaginationlessRequestParamRoastCurvesFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamRoastCurvesFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRoastCurvesByIdResponse"}},"schemaId":"components/schemas/GetRoastCurvesByIdResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1inventory.roast.getRoastCurvesById/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetRoastCurvesByIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRoastCurvesByIdResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roast/getroastcurvesbyid"}],"panels":[]}]},"httpPath":"/inventory.roast.getRoastCurvesById"},{"label":"Get Profiles by IDs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/roast/getprofilesbyids","routeSlug":"/api/rpc/reference/roast/getprofilesbyids","metadata":{"seo":{"title":"Get Profiles by IDs","description":"Retrieves processing profiles by their IDs. Only filters by profile IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProfilesByIds","name":"Get Profiles by IDs","isWebhook":false,"pointer":"/paths/~1inventory.roast.getProfilesByIds/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Profiles by IDs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves processing profiles by their IDs. Only filters by profile IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["inventory.roast"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamProfileIdsFilterParam"}},"schemaId":"components/schemas/PaginationlessRequestParamProfileIdsFilterParam","pointer":"/paths/~1inventory.roast.getProfilesByIds/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventory.roast.getProfilesByIds","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["inventory.roast"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamProfileIdsFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/inventory.roast.getProfilesByIds","href":"roast/getprofilesbyids","openApiOperationId":"getProfilesByIds","summary":"Get Profiles by IDs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/PaginationlessRequestParamProfileIdsFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamProfileIdsFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetProfilesByIdsResponse"}},"schemaId":"components/schemas/GetProfilesByIdsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1inventory.roast.getProfilesByIds/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetProfilesByIdsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetProfilesByIdsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roast/getprofilesbyids"}],"panels":[]}]},"httpPath":"/inventory.roast.getProfilesByIds"}],"content":{"contentType":"group","meta":{"name":"Roast"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Roast","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inventory.roast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace allows you to retrieve"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"roasted lots from your inventory."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/inventory.roast.listRoastedLots","summary":"List Roasted Lots","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roast/getroastedlots","deprecated":false},{"title":"/inventory.roast.listProfiles","summary":"List Profiles","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roast/listprofiles","deprecated":false},{"title":"/inventory.roast.getRoastedLotsByIds","summary":"Get Roasted Lots by IDs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roast/getroastedlotsbyids","deprecated":false},{"title":"/inventory.roast.getRoastDetailsByIds","summary":"Get Roast Details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roast/getroastdetailsbyids","deprecated":false},{"title":"/inventory.roast.getRoastCurvesById","summary":"Get Curves For a Roast","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roast/getroastcurvesbyid","deprecated":false},{"title":"/inventory.roast.getProfilesByIds","summary":"Get Profiles by IDs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roast/getprofilesbyids","deprecated":false}]}]}]}]}},{"type":"group","label":"Blend","link":"/api/rpc/reference/blend","routeSlug":"/api/rpc/reference/blend","items":[{"label":"List Blended Lots","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/blend/getblendedlotslist","routeSlug":"/api/rpc/reference/blend/getblendedlotslist","metadata":{"seo":{"title":"List Blended Lots","description":"Retrieves a list of post-roast blended lots from inventory, optionally filterable by an inclusive blended date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBlendedLotsList","name":"List Blended Lots","isWebhook":false,"pointer":"/paths/~1inventory.blend.listBlendedLots/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Blended Lots","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of post-roast blended lots from inventory, optionally filterable by\nan inclusive blended date."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["inventory.blend"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamBlendFilterParams"}},"schemaId":"components/schemas/RequestParamBlendFilterParams","pointer":"/paths/~1inventory.blend.listBlendedLots/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventory.blend.listBlendedLots","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["inventory.blend"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestParamBlendFilterParams"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/inventory.blend.listBlendedLots","href":"blend/getblendedlotslist","openApiOperationId":"getBlendedLotsList","summary":"List Blended Lots"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestParamBlendFilterParams","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamBlendFilterParams"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBlendedLotsResponse"}},"schemaId":"components/schemas/ListBlendedLotsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1inventory.blend.listBlendedLots/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBlendedLotsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBlendedLotsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blend/getblendedlotslist"}],"panels":[]}]},"httpPath":"/inventory.blend.listBlendedLots"}],"content":{"contentType":"group","meta":{"name":"Blend"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Blend","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inventory.blend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace allows you to retrieve blended lots"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from your inventory."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/inventory.blend.listBlendedLots","summary":"List Blended Lots","prefix":{"name":"post","color":"post"},"badges":[],"link":"/blend/getblendedlotslist","deprecated":false}]}]}]}]}},{"type":"separator","label":"Core","content":null},{"type":"group","label":"Location","link":"/api/rpc/reference/location","routeSlug":"/api/rpc/reference/location","items":[{"label":"List Locations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/location/getlocationlist","routeSlug":"/api/rpc/reference/location/getlocationlist","metadata":{"seo":{"title":"List Locations","description":"Retrieves a list of locations based on provided filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLocationList","name":"List Locations","isWebhook":false,"pointer":"/paths/~1core.location.listLocations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Locations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of locations based on provided filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["core.location"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamLocationFilterParam"}},"schemaId":"components/schemas/RequestParamLocationFilterParam","pointer":"/paths/~1core.location.listLocations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core.location.listLocations","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["core.location"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestParamLocationFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/core.location.listLocations","href":"location/getlocationlist","openApiOperationId":"getLocationList","summary":"List Locations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestParamLocationFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamLocationFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListLocationsResponse"}},"schemaId":"components/schemas/ListLocationsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1core.location.listLocations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListLocationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListLocationsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/location/getlocationlist"}],"panels":[]}]},"httpPath":"/core.location.listLocations"}],"content":{"contentType":"group","meta":{"name":"Location"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Location","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"core.location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace contains all operations for managing your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"locations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this API, you can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve existing locations."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/core.location.listLocations","summary":"List Locations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/location/getlocationlist","deprecated":false}]}]}]}]}},{"type":"group","label":"Project","link":"/api/rpc/reference/project","routeSlug":"/api/rpc/reference/project","items":[{"label":"List Projects","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/project/getprojectlist","routeSlug":"/api/rpc/reference/project/getprojectlist","metadata":{"seo":{"title":"List Projects","description":"Retrieves a list of projects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectList","name":"List Projects","isWebhook":false,"pointer":"/paths/~1core.project.listProjects/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Projects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of projects."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["core.project"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamVoid"}},"schemaId":"components/schemas/RequestParamVoid","pointer":"/paths/~1core.project.listProjects/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core.project.listProjects","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["core.project"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestParamVoid"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/core.project.listProjects","href":"project/getprojectlist","openApiOperationId":"getProjectList","summary":"List Projects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestParamVoid","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamVoid"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListProjectsResponse"}},"schemaId":"components/schemas/ListProjectsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1core.project.listProjects/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListProjectsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListProjectsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/getprojectlist"}],"panels":[]}]},"httpPath":"/core.project.listProjects"},{"label":"Import project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/project/importproject","routeSlug":"/api/rpc/reference/project/importproject","metadata":{"seo":{"title":"Import project","description":"Imports a new project from an external system into Cropster."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"importProject","name":"Import project","isWebhook":false,"pointer":"/paths/~1core.project.importProject/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Imports a new project from an external system into Cropster."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["core.project"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDataParamImportProjectRequest"}},"schemaId":"components/schemas/RequestDataParamImportProjectRequest","pointer":"/paths/~1core.project.importProject/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core.project.importProject","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["core.project"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestDataParamImportProjectRequest"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/core.project.importProject","href":"project/importproject","openApiOperationId":"importProject","summary":"Import project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestDataParamImportProjectRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDataParamImportProjectRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportProjectResponse"}},"schemaId":"components/schemas/ImportProjectResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1core.project.importProject/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImportProjectResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportProjectResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/importproject"}],"panels":[]}]},"httpPath":"/core.project.importProject"}],"content":{"contentType":"group","meta":{"name":"Project"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"core.project"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace contains all operations for managing your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"projects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this API, you can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve existing projects."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/core.project.listProjects","summary":"List Projects","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project/getprojectlist","deprecated":false},{"title":"/core.project.importProject","summary":"Import project","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project/importproject","deprecated":false}]}]}]}]}},{"type":"group","label":"Supply Network","link":"/api/rpc/reference/supply-network","routeSlug":"/api/rpc/reference/supply-network","items":[{"label":"List Suppliers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/supply-network/getsupplierlist","routeSlug":"/api/rpc/reference/supply-network/getsupplierlist","metadata":{"seo":{"title":"List Suppliers","description":"Retrieves a list of supply network members."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSupplierList","name":"List Suppliers","isWebhook":false,"pointer":"/paths/~1core.supplyNetwork.listSuppliers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Suppliers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of supply network members."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["core.supplyNetwork"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamVoid"}},"schemaId":"components/schemas/RequestParamVoid","pointer":"/paths/~1core.supplyNetwork.listSuppliers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core.supplyNetwork.listSuppliers","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["core.supplyNetwork"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestParamVoid"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/core.supplyNetwork.listSuppliers","href":"supply-network/getsupplierlist","openApiOperationId":"getSupplierList","summary":"List Suppliers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestParamVoid","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestParamVoid"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSuppliersResponse"}},"schemaId":"components/schemas/ListSuppliersResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1core.supplyNetwork.listSuppliers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListSuppliersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSuppliersResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supply-network/getsupplierlist"}],"panels":[]}]},"httpPath":"/core.supplyNetwork.listSuppliers"},{"label":"Import supplier","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/supply-network/importsupplier","routeSlug":"/api/rpc/reference/supply-network/importsupplier","metadata":{"seo":{"title":"Import supplier","description":"Imports a new supplier from an external system into Cropster."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"importSupplier","name":"Import supplier","isWebhook":false,"pointer":"/paths/~1core.supplyNetwork.importSupplier/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import supplier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Imports a new supplier from an external system into Cropster."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["core.supplyNetwork"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDataParamImportSupplierRequest"}},"schemaId":"components/schemas/RequestDataParamImportSupplierRequest","pointer":"/paths/~1core.supplyNetwork.importSupplier/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core.supplyNetwork.importSupplier","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["core.supplyNetwork"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestDataParamImportSupplierRequest"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/core.supplyNetwork.importSupplier","href":"supply-network/importsupplier","openApiOperationId":"importSupplier","summary":"Import supplier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/RequestDataParamImportSupplierRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDataParamImportSupplierRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportSupplierResponse"}},"schemaId":"components/schemas/ImportSupplierResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1core.supplyNetwork.importSupplier/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImportSupplierResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportSupplierResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supply-network/importsupplier"}],"panels":[]}]},"httpPath":"/core.supplyNetwork.importSupplier"},{"label":"Get Suppliers by IDs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/rpc/reference/supply-network/getsuppliersbyids","routeSlug":"/api/rpc/reference/supply-network/getsuppliersbyids","metadata":{"seo":{"title":"Get Suppliers by IDs","description":"Retrieves supply network members by their IDs. Only filters by supplier IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSuppliersByIds","name":"Get Suppliers by IDs","isWebhook":false,"pointer":"/paths/~1core.supplyNetwork.getSuppliersByIds/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Suppliers by IDs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves supply network members by their IDs. Only filters by supplier IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":["core.supplyNetwork"],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamSupplierIdsFilterParam"}},"schemaId":"components/schemas/PaginationlessRequestParamSupplierIdsFilterParam","pointer":"/paths/~1core.supplyNetwork.getSuppliersByIds/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core.supplyNetwork.getSuppliersByIds","servers":[{"url":"https://api.cropster.com/rpc/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}],"scopes":["core.supplyNetwork"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamSupplierIdsFilterParam"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/core.supplyNetwork.getSuppliersByIds","href":"supply-network/getsuppliersbyids","openApiOperationId":"getSuppliersByIds","summary":"Get Suppliers by IDs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"schemaId":"components/schemas/PaginationlessRequestParamSupplierIdsFilterParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaginationlessRequestParamSupplierIdsFilterParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetSuppliersByIdsResponse"}},"schemaId":"components/schemas/GetSuppliersByIdsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1core.supplyNetwork.getSuppliersByIds/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetSuppliersByIdsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetSuppliersByIdsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/supply-network/getsuppliersbyids"}],"panels":[]}]},"httpPath":"/core.supplyNetwork.getSuppliersByIds"}],"content":{"contentType":"group","meta":{"name":"Supply Network"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Supply Network","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"core.supplyNetwork"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace contains all operations for managing your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supply network."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this API, you can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import suppliers from your ERP system to Cropster."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve existing suppliers."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/core.supplyNetwork.listSuppliers","summary":"List Suppliers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supply-network/getsupplierlist","deprecated":false},{"title":"/core.supplyNetwork.importSupplier","summary":"Import supplier","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supply-network/importsupplier","deprecated":false},{"title":"/core.supplyNetwork.getSuppliersByIds","summary":"Get Suppliers by IDs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/supply-network/getsuppliersbyids","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/BulkOperationErrorDataResponse":{"id":"components/schemas/BulkOperationErrorDataResponse","kind":"json-schema","title":"BulkOperationErrorDataResponse","data":{"type":"object","properties":{"details":{"type":"array","description":"A detailed list of issues detected in the request.","items":{"$ref":"#/components/schemas/BulkOperationErrorItemResponse"}}},"description":"Defines additional information about the error."}},"components/schemas/BulkOperationErrorItemResponse":{"id":"components/schemas/BulkOperationErrorItemResponse","kind":"json-schema","title":"BulkOperationErrorItemResponse","data":{"type":"object","properties":{"code":{"type":"string","description":"Specifies error code that can be handled programmatically.","example":"invalid_parameter"},"message":{"type":"string","description":"A detailed description of the occurred error.","example":"Invalid parameter provided."}},"description":"A detailed list of issues detected in the request."}},"components/schemas/BulkOperationErrorRecord":{"id":"components/schemas/BulkOperationErrorRecord","kind":"json-schema","title":"BulkOperationErrorRecord","data":{"type":"object","properties":{"code":{"type":"string","description":"Indicates that one or multiple items are invalid and no changes were saved.","example":"bulk_operation_failed"},"message":{"type":"string","description":"A detailed description of the occurred error.","example":"One or multiple items are invalid. No changes were saved."},"data":{"$ref":"#/components/schemas/BulkOperationErrorDataResponse"}}}},"components/schemas/BulkOperationErrorResponse":{"id":"components/schemas/BulkOperationErrorResponse","kind":"json-schema","title":"BulkOperationErrorResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful or not","example":false},"error":{"$ref":"#/components/schemas/BulkOperationErrorRecord"}}}},"components/schemas/ErrorRecord":{"id":"components/schemas/ErrorRecord","kind":"json-schema","title":"ErrorRecord","data":{"type":"object","properties":{"code":{"type":"string","description":"Specifies error code that can be handled programmatically.","example":"invalid_parameter"},"message":{"type":"string","description":"A detailed description of the occurred error.","example":"Invalid parameter provided"}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful or not","example":false},"error":{"$ref":"#/components/schemas/ErrorRecord"}}}},"components/schemas/DateTimeParam":{"id":"components/schemas/DateTimeParam","kind":"json-schema","title":"DateTimeParam","data":{"type":"object","properties":{"from":{"type":"string","description":"Filters the results to include only records created on or after this date. The date must be provided in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). The filter is inclusive.","format":"date-time","example":"2023-10-05T14:48:00Z"}}}},"components/schemas/DateTimeRangeParam":{"id":"components/schemas/DateTimeRangeParam","kind":"json-schema","title":"DateTimeRangeParam","data":{"type":"object","properties":{"from":{"type":"string","description":"Filters the results to include only records created on or after this date. The date must be provided in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). The filter is inclusive.","format":"date-time","example":"2023-10-05T14:48:00Z"},"to":{"type":"string","description":"Filters the results to include only records created before this date. The date must be provided in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). The filter is exclusive.","format":"date-time","example":"2023-10-05T14:48:00Z"}}}},"components/schemas/GreenSampleFilterParam":{"id":"components/schemas/GreenSampleFilterParam","kind":"json-schema","title":"GreenSampleFilterParam","data":{"type":"object","properties":{"registrationDate":{"$ref":"#/components/schemas/DateTimeRangeParam"},"lastModifiedDate":{"$ref":"#/components/schemas/DateTimeParam"}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/PaginationParam":{"id":"components/schemas/PaginationParam","kind":"json-schema","title":"PaginationParam","data":{"type":"object","properties":{"limit":{"maximum":100,"minimum":1,"type":"integer","description":"The number of elements to be returned","format":"int32","example":20,"default":50},"after":{"type":"string","description":"The cursor to retrieve the next page. This is an opaque value that should not be interpreted by the client.","example":"aBc="}},"description":"Defines all required and optional pagination parameters for the operation."}},"components/schemas/RequestFilterParamGreenSampleFilterParam":{"id":"components/schemas/RequestFilterParamGreenSampleFilterParam","kind":"json-schema","title":"RequestFilterParamGreenSampleFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/GreenSampleFilterParam"},"pagination":{"$ref":"#/components/schemas/PaginationParam"}}}},"components/schemas/RequestParamGreenSampleFilterParam":{"id":"components/schemas/RequestParamGreenSampleFilterParam","kind":"json-schema","title":"RequestParamGreenSampleFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/RequestFilterParamGreenSampleFilterParam"}}}},"components/schemas/ExternalIdentifierResponse":{"id":"components/schemas/ExternalIdentifierResponse","kind":"json-schema","title":"ExternalIdentifierResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the object.","format":"uuid","readOnly":true,"example":"550e8400-e29b-41d4-a716-446655440000"},"externalId":{"type":"string","description":"Represents the unique identifier of this object in an external system (e.g. ERP).","example":"location-1234"}},"description":"Represents the relationship between an internal object and its external identifier."}},"components/schemas/GreenSampleCollectionResponse":{"id":"components/schemas/GreenSampleCollectionResponse","kind":"json-schema","title":"GreenSampleCollectionResponse","data":{"type":"object","properties":{"greenSamples":{"type":"array","items":{"$ref":"#/components/schemas/GreenSampleResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/GreenSampleResponse":{"id":"components/schemas/GreenSampleResponse","kind":"json-schema","title":"GreenSampleResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the green sample.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"sampleNumber":{"type":"string","description":"A human-readable identifier for a green sample.","example":"SG-1234"},"name":{"type":"string","description":"The name of the green sample.","example":"Honduras Washed"},"icoNumber":{"type":"string","description":"The ICO (International Coffee Organization) number associated with the green sample.","example":"013-8281-0094"},"externalId":{"type":"string","description":"Represents the unique identifier of the green sample in an external system (e.g. ERP).","example":"green-sample-9876"},"weight":{"$ref":"#/components/schemas/Weight"},"location":{"$ref":"#/components/schemas/ExternalIdentifierResponse"},"sampleType":{"type":"string","description":"The type of a green sample.","example":"SPOT_OFFER","enum":["TYPE_SAMPLE","OFFER","SPOT_OFFER","PRE_SHIPMENT","ARRIVAL","EVALUATION"]},"lastModifiedDate":{"type":"string","description":"The date and time when the sample was last modified, in ISO 8601 format.","example":"2024-05-01T08:00:00Z"},"registrationDate":{"type":"string","description":"The date and time when the sample was registered, in ISO 8601 format.","example":"2024-05-01T08:00:00Z"}},"description":"Represents a green coffee sample."}},"components/schemas/ListGreenSamplesResponse":{"id":"components/schemas/ListGreenSamplesResponse","kind":"json-schema","title":"ListGreenSamplesResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/GreenSampleCollectionResponse"},"meta":{"$ref":"#/components/schemas/MetaResponse"}}}},"components/schemas/MetaResponse":{"id":"components/schemas/MetaResponse","kind":"json-schema","title":"MetaResponse","data":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"description":"Contains the metadata (e.g. pagination information) of the response."}},"components/schemas/PaginationResponse":{"id":"components/schemas/PaginationResponse","kind":"json-schema","title":"PaginationResponse","data":{"type":"object","properties":{"endCursor":{"type":"string","description":"Cursor value to retrieve the records of the next page. If there no further pages, this value is null.","example":"aBc="}},"description":"Represents the pagination fields of the response."}},"components/schemas/Weight":{"id":"components/schemas/Weight","kind":"json-schema","title":"Weight","data":{"required":["amount","unit"],"type":"object","properties":{"amount":{"multipleOf":0.001,"type":"number","description":"The weight amount represented as floating-point number.","format":"double","example":12.5},"unit":{"type":"string","description":"The weight unit of the object.","example":"KG","enum":["KG","LBS"]}},"description":"Represents the current weight of the object."}},"components/schemas/GreenSampleIdsFilterParam":{"id":"components/schemas/GreenSampleIdsFilterParam","kind":"json-schema","title":"GreenSampleIdsFilterParam","data":{"required":["greenSampleIds"],"type":"object","properties":{"greenSampleIds":{"uniqueItems":true,"type":"array","description":"A set of unique identifiers (UUIDs) of green samples to fetch","example":["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],"items":{"type":"string","description":"A set of unique identifiers (UUIDs) of green samples to fetch","format":"uuid"}}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/PaginationlessFilterParamGreenSampleIdsFilterParam":{"id":"components/schemas/PaginationlessFilterParamGreenSampleIdsFilterParam","kind":"json-schema","title":"PaginationlessFilterParamGreenSampleIdsFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/GreenSampleIdsFilterParam"}}}},"components/schemas/PaginationlessRequestParamGreenSampleIdsFilterParam":{"id":"components/schemas/PaginationlessRequestParamGreenSampleIdsFilterParam","kind":"json-schema","title":"PaginationlessRequestParamGreenSampleIdsFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/PaginationlessFilterParamGreenSampleIdsFilterParam"}}}},"components/schemas/GetGreenSamplesByIdsResponse":{"id":"components/schemas/GetGreenSamplesByIdsResponse","kind":"json-schema","title":"GetGreenSamplesByIdsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/GreenSampleCollectionResponse"}}}},"components/schemas/PhysicalAnalysisFilterParam":{"id":"components/schemas/PhysicalAnalysisFilterParam","kind":"json-schema","title":"PhysicalAnalysisFilterParam","data":{"type":"object","properties":{"analysisDate":{"$ref":"#/components/schemas/DateTimeRangeParam"},"analysedLotIds":{"uniqueItems":true,"type":"array","description":"Filters physical analyses to only include those that analysed one of the given coffees.","example":["550e8400-e29b-41d4-a716-446655440000"],"items":{"type":"string","description":"Filters physical analyses to only include those that analysed one of the given coffees.","format":"uuid"}}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/RequestFilterParamPhysicalAnalysisFilterParam":{"id":"components/schemas/RequestFilterParamPhysicalAnalysisFilterParam","kind":"json-schema","title":"RequestFilterParamPhysicalAnalysisFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/PhysicalAnalysisFilterParam"},"pagination":{"$ref":"#/components/schemas/PaginationParam"}}}},"components/schemas/RequestParamPhysicalAnalysisFilterParam":{"id":"components/schemas/RequestParamPhysicalAnalysisFilterParam","kind":"json-schema","title":"RequestParamPhysicalAnalysisFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/RequestFilterParamPhysicalAnalysisFilterParam"}}}},"components/schemas/Density":{"id":"components/schemas/Density","kind":"json-schema","title":"Density","data":{"required":["amount","unit"],"type":"object","properties":{"amount":{"multipleOf":0.001,"type":"number","description":"The density amount represented as a floating-point number.","format":"double","example":11.1},"unit":{"type":"string","description":"The unit of the density.","example":"G_PER_ML","enum":["G_PER_ML"]}},"description":"Represents a density value as an amount and its unit."}},"components/schemas/IdAndTypeReferenceResponse":{"id":"components/schemas/IdAndTypeReferenceResponse","kind":"json-schema","title":"IdAndTypeReferenceResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the referenced entity.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"type":{"type":"string","description":"The type of the referenced entity, which can be used to determine at which endpoint the 'id' field can be used to retrieve the full entity details.","example":"INVENTORY_ROAST"}},"description":"A reference to a polymorphic object, containing its unique identifier and type."}},"components/schemas/ListPhysicalAnalysesResponse":{"id":"components/schemas/ListPhysicalAnalysesResponse","kind":"json-schema","title":"ListPhysicalAnalysesResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/PhysicalAnalysisCollectionResponse"},"meta":{"$ref":"#/components/schemas/MetaResponse"}}}},"components/schemas/PhysicalAnalysisCollectionResponse":{"id":"components/schemas/PhysicalAnalysisCollectionResponse","kind":"json-schema","title":"PhysicalAnalysisCollectionResponse","data":{"type":"object","properties":{"physicalAnalyses":{"type":"array","items":{"$ref":"#/components/schemas/PhysicalAnalysisResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/PhysicalAnalysisResponse":{"id":"components/schemas/PhysicalAnalysisResponse","kind":"json-schema","title":"PhysicalAnalysisResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the physical analysis.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"analysisNumber":{"type":"string","description":"A human-readable identifier for the analysis.","example":"QC-0001"},"analysisDate":{"type":"string","description":"The date on which the analysis was performed, in ISO 8601 format.","example":"2023-10-05T14:48:00Z"},"moisture":{"$ref":"#/components/schemas/RelativeAmount","description":"The moisture measurement of the analysed coffee."},"waterActivity":{"$ref":"#/components/schemas/RelativeAmount","description":"The water activity measurement of the analysed coffee."},"density":{"$ref":"#/components/schemas/Density","description":"The density measurement of the analysed coffee."},"analysedLot":{"$ref":"#/components/schemas/IdAndTypeReferenceResponse","description":"A reference to the coffee that was analysed."}},"description":"Represents a physical analysis result for an analysed coffee."}},"components/schemas/RelativeAmount":{"id":"components/schemas/RelativeAmount","kind":"json-schema","title":"RelativeAmount","data":{"required":["amount","unit"],"type":"object","properties":{"amount":{"multipleOf":0.001,"type":"number","description":"The amount represented as a floating-point number.","format":"double","example":12.5},"unit":{"type":"string","description":"The unit of the amount.","example":"PERCENT","enum":["PERCENT","FRACTION"]}},"description":"Represents a relative amount as a value and its unit."}},"components/schemas/CuppingFilterParam":{"id":"components/schemas/CuppingFilterParam","kind":"json-schema","title":"CuppingFilterParam","data":{"type":"object","properties":{"startDate":{"$ref":"#/components/schemas/DateTimeRangeParam"},"state":{"type":"string","description":"The state of a cupping.","example":"OPEN","enum":["OPEN","CLOSED","DRAFT"]}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/RequestFilterParamCuppingFilterParam":{"id":"components/schemas/RequestFilterParamCuppingFilterParam","kind":"json-schema","title":"RequestFilterParamCuppingFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/CuppingFilterParam"},"pagination":{"$ref":"#/components/schemas/PaginationParam"}}}},"components/schemas/RequestParamCuppingFilterParam":{"id":"components/schemas/RequestParamCuppingFilterParam","kind":"json-schema","title":"RequestParamCuppingFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/RequestFilterParamCuppingFilterParam"}}}},"components/schemas/CuppedCoffeeResponse":{"id":"components/schemas/CuppedCoffeeResponse","kind":"json-schema","title":"CuppedCoffeeResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The cupped coffee's unique identifier.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"cuppedCoffeeNumber":{"type":"string","description":"A human-readable identifier for the cupped coffee.","example":"QC-0001"},"averageScore":{"type":"number","description":"The average score of the cupped coffee.","format":"double","example":85.5},"cuppedLot":{"$ref":"#/components/schemas/IdAndTypeReferenceResponse"}},"description":"Response containing details of a cupped coffee"}},"components/schemas/CuppingResponse":{"id":"components/schemas/CuppingResponse","kind":"json-schema","title":"CuppingResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the cupping.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"cuppingNumber":{"type":"string","description":"A human-readable identifier for the cupping.","example":"QS-0001"},"startDate":{"type":"string","description":"The start date of the cupping in ISO 8601 format.","example":"2023-10-05T14:48:00Z"},"state":{"type":"string","description":"The state of a cupping.","example":"OPEN","enum":["OPEN","CLOSED","DRAFT"]},"cuppingSheet":{"$ref":"#/components/schemas/NameReferenceResponse","description":"The cupping sheet used for this cupping."},"cuppedCoffees":{"type":"array","description":"The coffee that was cupped in this session.","items":{"$ref":"#/components/schemas/CuppedCoffeeResponse"}}},"description":"Represents a cupping session with its details and result summary."}},"components/schemas/CuppingcollectionResponse":{"id":"components/schemas/CuppingcollectionResponse","kind":"json-schema","title":"CuppingcollectionResponse","data":{"type":"object","properties":{"cuppings":{"type":"array","items":{"$ref":"#/components/schemas/CuppingResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/ListCuppingsResponse":{"id":"components/schemas/ListCuppingsResponse","kind":"json-schema","title":"ListCuppingsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/CuppingcollectionResponse"},"meta":{"$ref":"#/components/schemas/MetaResponse"}}}},"components/schemas/NameReferenceResponse":{"id":"components/schemas/NameReferenceResponse","kind":"json-schema","title":"NameReferenceResponse","data":{"type":"object","properties":{"name":{"type":"string"}},"description":"Represents a reference to an object by its name.","example":"MyObject"}},"components/schemas/CuppingResultFilterParam":{"id":"components/schemas/CuppingResultFilterParam","kind":"json-schema","title":"CuppingResultFilterParam","data":{"required":["cuppedCoffeeIds"],"type":"object","properties":{"cuppedCoffeeIds":{"uniqueItems":true,"type":"array","description":"A set of cupped coffee ids to filter the cupping results by. At most 100 cupped coffee ids can be provided.","example":["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],"items":{"type":"string","description":"A set of cupped coffee ids to filter the cupping results by. At most 100 cupped coffee ids can be provided.","format":"uuid"}}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/RequestFilterParamCuppingResultFilterParam":{"id":"components/schemas/RequestFilterParamCuppingResultFilterParam","kind":"json-schema","title":"RequestFilterParamCuppingResultFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/CuppingResultFilterParam"},"pagination":{"$ref":"#/components/schemas/PaginationParam"}}}},"components/schemas/RequestParamCuppingResultFilterParam":{"id":"components/schemas/RequestParamCuppingResultFilterParam","kind":"json-schema","title":"RequestParamCuppingResultFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/RequestFilterParamCuppingResultFilterParam"}}}},"components/schemas/CuppingResultCollectionResponse":{"id":"components/schemas/CuppingResultCollectionResponse","kind":"json-schema","title":"CuppingResultCollectionResponse","data":{"type":"object","properties":{"cuppingResults":{"type":"array","items":{"$ref":"#/components/schemas/CuppingResultResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/CuppingResultResponse":{"id":"components/schemas/CuppingResultResponse","kind":"json-schema","title":"CuppingResultResponse","data":{"type":"object","properties":{"note":{"type":"string","description":"Additional notes captured during the cupping."},"finalScore":{"type":"number","description":"Final score of the cupping, calculated as defined in the cupping sheet.","format":"double","example":85.5},"scoringState":{"type":"string","description":"Indicates whether or not the cupping result is accounted for in the cupped coffees total score calculation.","example":"EXCLUDED","enum":["INCLUDED","EXCLUDED"]},"evaluator":{"$ref":"#/components/schemas/NameReferenceResponse","description":"The evaluator that performed the cupping."},"sensorialAttributes":{"type":"array","description":"List of the evaluated aspects and its results as defined in the cupping sheet.","items":{"$ref":"#/components/schemas/SensorialAttributeResponse"}},"cuppedCoffee":{"$ref":"#/components/schemas/IdReferenceResponse","description":"References the cupped coffee that the result belongs to."}},"description":"Represents a cupping result with its details, including the note, final score, state, evaluator, sensorial attributes and the associated cupped coffee."}},"components/schemas/DescriptorResponse":{"id":"components/schemas/DescriptorResponse","kind":"json-schema","title":"DescriptorResponse","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the descriptor.","example":"Nutty"},"sentiment":{"type":"string","description":"Describes whether a flavor is considered positive or negative for the attribute it belongs to.","example":"POSITIVE","enum":["POSITIVE","NEGATIVE"]},"level":{"type":"string","description":"Describes the intensity of a flavor for the attribute it belongs to.","example":"WEAK","enum":["WEAK","NORMAL","STRONG"]}},"description":"Describes the flavor of an attribute."}},"components/schemas/IdReferenceResponse":{"id":"components/schemas/IdReferenceResponse","kind":"json-schema","title":"IdReferenceResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the object.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"}},"description":"Represents a reference to an object by its unique identifier."}},"components/schemas/ListCuppingResultsResponse":{"id":"components/schemas/ListCuppingResultsResponse","kind":"json-schema","title":"ListCuppingResultsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/CuppingResultCollectionResponse"},"meta":{"$ref":"#/components/schemas/MetaResponse"}}}},"components/schemas/SensorialAttributeResponse":{"id":"components/schemas/SensorialAttributeResponse","kind":"json-schema","title":"SensorialAttributeResponse","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the aspect that the attribute describes, as defined in the cupping sheet.","example":"Aftertaste"},"score":{"type":"number","description":"Score that the evaluator assigned to this attribute.","format":"double","example":7},"intensity":{"type":"number","description":"Intensity of the attribute, if applicable. The meaning of this field depends on the cupping sheet definition and how the evaluator used it during the evaluation.","format":"double","example":5},"descriptors":{"type":"array","description":"List of descriptors associated with the attribute.","items":{"$ref":"#/components/schemas/DescriptorResponse"}}},"description":"Represents a sensorial attribute of the coffee alongside its grading, as defined in the cupping sheet."}},"components/schemas/CuppingIdsFilterParam":{"id":"components/schemas/CuppingIdsFilterParam","kind":"json-schema","title":"CuppingIdsFilterParam","data":{"required":["cuppingIds"],"type":"object","properties":{"cuppingIds":{"uniqueItems":true,"type":"array","description":"A set of unique identifiers (UUIDs) representing the cupping IDs to filter the cuppings.","example":["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],"items":{"type":"string","description":"A set of unique identifiers (UUIDs) representing the cupping IDs to filter the cuppings.","format":"uuid"}}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/PaginationlessFilterParamCuppingIdsFilterParam":{"id":"components/schemas/PaginationlessFilterParamCuppingIdsFilterParam","kind":"json-schema","title":"PaginationlessFilterParamCuppingIdsFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/CuppingIdsFilterParam"}}}},"components/schemas/PaginationlessRequestParamCuppingIdsFilterParam":{"id":"components/schemas/PaginationlessRequestParamCuppingIdsFilterParam","kind":"json-schema","title":"PaginationlessRequestParamCuppingIdsFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/PaginationlessFilterParamCuppingIdsFilterParam"}}}},"components/schemas/GetCuppingsByIdsResponse":{"id":"components/schemas/GetCuppingsByIdsResponse","kind":"json-schema","title":"GetCuppingsByIdsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/CuppingcollectionResponse"}}}},"components/schemas/CoffeeOption":{"id":"components/schemas/CoffeeOption","kind":"json-schema","title":"CoffeeOption","data":{"required":["grindStyle","packageSize"],"type":"object","properties":{"packageSize":{"type":"string","description":"The size of the package to be produced.","example":"PACKAGE250G","enum":["PACKAGE0G","PACKAGE1G","PACKAGE5G","PACKAGE6G","PACKAGE10G","PACKAGE12G","PACKAGE13_2G","PACKAGE14_2G","PACKAGE15G","PACKAGE20G","PACKAGE30G","PACKAGE40G","PACKAGE50G","PACKAGE60G","PACKAGE65G","PACKAGE70G","PACKAGE71G","PACKAGE75G","PACKAGE80G","PACKAGE85G","PACKAGE90G","PACKAGE95G","PACKAGE96G","PACKAGE100G","PACKAGE105G","PACKAGE110G","PACKAGE120G","PACKAGE121G","PACKAGE125G","PACKAGE140G","PACKAGE142G","PACKAGE150G","PACKAGE156_25G","PACKAGE164G","PACKAGE170G","PACKAGE175G","PACKAGE180G","PACKAGE200G","PACKAGE225G","PACKAGE227G","PACKAGE230G","PACKAGE250G","PACKAGE265G","PACKAGE285G","PACKAGE300G","PACKAGE310G","PACKAGE312_5G","PACKAGE333G","PACKAGE340G","PACKAGE350G","PACKAGE380G","PACKAGE400G","PACKAGE450G","PACKAGE454G","PACKAGE500G","PACKAGE600G","PACKAGE750G","PACKAGE676G","PACKAGE900G","PACKAGE950G","PACKAGE1KG","PACKAGE1_135KG","PACKAGE1_2KG","PACKAGE1_25KG","PACKAGE1_5KG","PACKAGE2KG","PACKAGE2_27KG","PACKAGE2_5KG","PACKAGE2_72KG","PACKAGE2_8KG","PACKAGE3KG","PACKAGE3_5KG","PACKAGE3_6KG","PACKAGE4KG","PACKAGE4_29KG","PACKAGE5KG","PACKAGE5_6KG","PACKAGE6KG","PACKAGE6_25KG","PACKAGE7KG","PACKAGE7_5KG","PACKAGE8KG","PACKAGE9KG","PACKAGE10KG","PACKAGE12KG","PACKAGE14KG","PACKAGE15KG","PACKAGE20KG","PACKAGE25KG","PACKAGE30KG","PACKAGE35KG","PACKAGE50KG","PACKAGE69KG","PACKAGE70KG","PACKAGE920KG","PACKAGE0_5LBS","PACKAGE1LBS","PACKAGE1_1LBS","PACKAGE1_5LBS","PACKAGE1_75LBS","PACKAGE2LBS","PACKAGE2_5LBS","PACKAGE3LBS","PACKAGE3_5LBS","PACKAGE3_75LBS","PACKAGE3_85LBS","PACKAGE4LBS","PACKAGE4_5LBS","PACKAGE5LBS","PACKAGE6LBS","PACKAGE7LBS","PACKAGE7_5LBS","PACKAGE8_5LBS","PACKAGE9LBS","PACKAGE10LBS","PACKAGE10_5LBS","PACKAGE11LBS","PACKAGE12LBS","PACKAGE12_5LBS","PACKAGE15LBS","PACKAGE16LBS","PACKAGE20LBS","PACKAGE21LBS","PACKAGE22_5LBS","PACKAGE24LBS","PACKAGE25LBS","PACKAGE30LBS","PACKAGE40LBS","PACKAGE50LBS","PACKAGE125LBS","PACKAGE800LBS","PACKAGE1OZ","PACKAGE2OZ","PACKAGE2_5OZ","PACKAGE3OZ","PACKAGE4OZ","PACKAGE5OZ","PACKAGE6OZ","PACKAGE7OZ","PACKAGE8OZ","PACKAGE9OZ","PACKAGE10OZ","PACKAGE10_5OZ","PACKAGE10_9OZ","PACKAGE11OZ","PACKAGE12OZ","PACKAGE12_07OZ","PACKAGE14OZ","PACKAGE16OZ","PACKAGE18OZ","PACKAGE22OZ","PACKAGE24OZ","PACKAGE35OZ","PACKAGE36OZ","PACKAGE45OZ","PACKAGE48OZ","PACKAGE72OZ","PACKAGE90OZ","PACKAGE120OZ","PACKAGE144OZ","PACKAGE6912OZ"]},"grindStyle":{"type":"string","description":"The grind style of the coffee.","example":"Whole Bean"}},"description":"Options specific for Coffee products."}},"components/schemas/ProductRequest":{"id":"components/schemas/ProductRequest","kind":"json-schema","title":"ProductRequest","data":{"required":["externalId","name","variants"],"type":"object","properties":{"externalId":{"type":"string","description":"Represents the unique identifier of the imported product in an external system (e.g. ERP)","example":"PRC-PROD-101"},"name":{"type":"string","description":"The name of the product.","example":"Ethiopia Natural"},"variants":{"type":"array","description":"List of variants of the imported product, can be empty but not null","items":{"$ref":"#/components/schemas/VariantRequest"}}},"description":"Defines the data required for the operation, including all mandatory and optional fields."}},"components/schemas/RequestDataParamListProductRequest":{"id":"components/schemas/RequestDataParamListProductRequest","kind":"json-schema","title":"RequestDataParamListProductRequest","data":{"type":"object","properties":{"data":{"type":"array","description":"Defines the data required for the operation, including all mandatory and optional fields.","items":{"$ref":"#/components/schemas/ProductRequest"}}}}},"components/schemas/VariantRequest":{"id":"components/schemas/VariantRequest","kind":"json-schema","title":"VariantRequest","data":{"required":["coffeeOptions","sku"],"type":"object","properties":{"sku":{"type":"string","description":"Unique identifier of the variant.","example":"ETH-250G-WB"},"coffeeOptions":{"$ref":"#/components/schemas/CoffeeOption"}},"description":"List of variants of the imported product, can be empty but not null"}},"components/schemas/ProductResponse":{"id":"components/schemas/ProductResponse","kind":"json-schema","title":"ProductResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the product.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"externalId":{"type":"string","description":"Represents the unique identifier of the imported product in an external system (e.g. ERP)","example":"PRC-PROD-101"},"name":{"type":"string","description":"The name of the product.","example":"Ethiopia Natural"},"reviewState":{"type":"string","description":"Indicates if actions in C-SAR are required - unreviewed products cannot be processed in C-SAR.","example":"REVIEWED or UNREVIEWED","enum":["REVIEWED","UNREVIEWED"]},"variants":{"type":"array","description":"List of all available variants of the product.","items":{"$ref":"#/components/schemas/VariantResponse"}}}}},"components/schemas/SyncedProductResponse":{"id":"components/schemas/SyncedProductResponse","kind":"json-schema","title":"SyncedProductResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/SyncedProducts"}}}},"components/schemas/SyncedProducts":{"id":"components/schemas/SyncedProducts","kind":"json-schema","title":"SyncedProducts","data":{"type":"object","properties":{"syncedProducts":{"type":"array","items":{"$ref":"#/components/schemas/ProductResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/VariantResponse":{"id":"components/schemas/VariantResponse","kind":"json-schema","title":"VariantResponse","data":{"type":"object","properties":{"sku":{"type":"string","description":"Unique identifier of the variant.","example":"EN-250G-WB"},"reviewState":{"type":"string","description":"Indicates if actions in C-SAR are required because at least one more option value is missing.","example":"REVIEWED or UNREVIEWED","enum":["REVIEWED","UNREVIEWED"]},"coffeeOptions":{"$ref":"#/components/schemas/CoffeeOption"}},"description":"List of all available variants of the product."}},"components/schemas/OrderItemRequest":{"id":"components/schemas/OrderItemRequest","kind":"json-schema","title":"OrderItemRequest","data":{"required":["quantity","sku"],"type":"object","properties":{"sku":{"type":"string","description":"Stock keeping unit of the ordered variant.","example":"ETH-250G-WB"},"quantity":{"type":"integer","description":"Specifies the number of the ordered variant, must be larger than zero.","format":"int32","example":1}},"description":"List of order item of the imported order, cannot be empty."}},"components/schemas/OrderRequest":{"id":"components/schemas/OrderRequest","kind":"json-schema","title":"OrderRequest","data":{"required":["externalId","orderDate","orderItems"],"type":"object","properties":{"externalId":{"type":"string","description":"Represents the unique identifier of the imported order in an external system (e.g. ERP)","example":"PRC-ORD-101"},"orderDate":{"type":"string","description":"Order date of the imported order. The date must be provided in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ).","format":"date-time","example":"2026-01-01T01:11:00Z"},"customer":{"type":"string","description":"Name of the customer/company of the order.","example":"John Doe"},"customerType":{"type":"string","description":"Tells if the order is from a retail or wholesale customer.","example":"RETAIL","enum":["RETAIL","WHOLESALE"]},"orderItems":{"type":"array","description":"List of order item of the imported order, cannot be empty.","items":{"$ref":"#/components/schemas/OrderItemRequest"}}},"description":"Defines the data required for the operation, including all mandatory and optional fields."}},"components/schemas/RequestDataParamListOrderRequest":{"id":"components/schemas/RequestDataParamListOrderRequest","kind":"json-schema","title":"RequestDataParamListOrderRequest","data":{"type":"object","properties":{"data":{"type":"array","description":"Defines the data required for the operation, including all mandatory and optional fields.","items":{"$ref":"#/components/schemas/OrderRequest"}}}}},"components/schemas/OrderResponse":{"id":"components/schemas/OrderResponse","kind":"json-schema","title":"OrderResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the order.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"externalId":{"type":"string","description":"Represents the unique identifier of the imported order in an external system (e.g. ERP)","example":"PRC-ORD-101"}}}},"components/schemas/SetOrderResponse":{"id":"components/schemas/SetOrderResponse","kind":"json-schema","title":"SetOrderResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/SetOrders"}}}},"components/schemas/SetOrders":{"id":"components/schemas/SetOrders","kind":"json-schema","title":"SetOrders","data":{"type":"object","properties":{"syncedOrders":{"type":"array","items":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/OrderFilterParam":{"id":"components/schemas/OrderFilterParam","kind":"json-schema","title":"OrderFilterParam","data":{"type":"object","properties":{"lastModifiedDate":{"$ref":"#/components/schemas/DateTimeRangeParam"},"status":{"uniqueItems":true,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Filters orders by internal fulfillment status. An empty array behaves like omitting the filter. Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":["RECEIVED","SCHEDULED"],"deprecated":true,"items":{"type":"string","description":"Detailed internal lifecycle position of a production order.","example":"[\"RECEIVED\",\"SCHEDULED\"]","deprecated":true,"enum":["RECEIVED","SCHEDULED","IN_PROGRESS","ROASTED","PACKAGED"]}},"state":{"uniqueItems":true,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters orders by lifecycle state. An empty array behaves like omitting the filter. Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":["OPEN","SCHEDULED"],"items":{"type":"string","description":"Lifecycle state of a production order.","example":"[\"OPEN\",\"SCHEDULED\"]","enum":["OPEN","SCHEDULED","IN_PROGRESS","ROASTED","COMPLETED"]}},"externalIds":{"uniqueItems":true,"type":"array","description":"Filters orders to only include those whose externalId matches one of the given values. An empty array behaves like omitting the filter.","example":["ERP-INV-00042","ERP-INV-00043"],"items":{"type":"string","description":"Filters orders to only include those whose externalId matches one of the given values. An empty array behaves like omitting the filter.","example":"[\"ERP-INV-00042\",\"ERP-INV-00043\"]"}}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/RequestFilterParamOrderFilterParam":{"id":"components/schemas/RequestFilterParamOrderFilterParam","kind":"json-schema","title":"RequestFilterParamOrderFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/OrderFilterParam"},"pagination":{"$ref":"#/components/schemas/PaginationParam"}}}},"components/schemas/RequestParamOrderFilterParam":{"id":"components/schemas/RequestParamOrderFilterParam","kind":"json-schema","title":"RequestParamOrderFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/RequestFilterParamOrderFilterParam"}}}},"components/schemas/ListOrdersResponse":{"id":"components/schemas/ListOrdersResponse","kind":"json-schema","title":"ListOrdersResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/OrderCollectionResponse"},"meta":{"$ref":"#/components/schemas/MetaResponse"}}}},"components/schemas/OrderCollectionResponse":{"id":"components/schemas/OrderCollectionResponse","kind":"json-schema","title":"OrderCollectionResponse","data":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/OrderSummaryResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/OrderSummaryResponse":{"id":"components/schemas/OrderSummaryResponse","kind":"json-schema","title":"OrderSummaryResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the order.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"externalId":{"type":"string","description":"The identifier provided by the external system when the order was created. Null for orders created manually in the Cropster UI.","example":"MY-ORD-5544"},"status":{"type":"string","description":"Detailed internal lifecycle position of a production order.","example":"PACKAGED","deprecated":true,"enum":["RECEIVED","SCHEDULED","IN_PROGRESS","ROASTED","PACKAGED"]},"state":{"type":"string","description":"Lifecycle state of a production order.","example":"COMPLETED","enum":["OPEN","SCHEDULED","IN_PROGRESS","ROASTED","COMPLETED"]},"lastModifiedDate":{"type":"string","description":"The timestamp of the most recent update to the order, in ISO 8601 format.","example":"2026-06-16T10:47:00Z"},"orderDate":{"type":"string","description":"The original order date, in ISO 8601 format.","example":"2026-06-10T09:00:00Z"}},"description":"Represents the header-level information of an order."}},"components/schemas/RequestFilterParamRoastFilterParam":{"id":"components/schemas/RequestFilterParamRoastFilterParam","kind":"json-schema","title":"RequestFilterParamRoastFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/RoastFilterParam"},"pagination":{"$ref":"#/components/schemas/PaginationParam"}}}},"components/schemas/RequestParamRoastFilterParam":{"id":"components/schemas/RequestParamRoastFilterParam","kind":"json-schema","title":"RequestParamRoastFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/RequestFilterParamRoastFilterParam"}}}},"components/schemas/RoastFilterParam":{"id":"components/schemas/RoastFilterParam","kind":"json-schema","title":"RoastFilterParam","data":{"type":"object","properties":{"roastedDate":{"$ref":"#/components/schemas/DateTimeParam"},"lastModifiedDate":{"$ref":"#/components/schemas/DateTimeParam"}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/ListRoastedLotsResponse":{"id":"components/schemas/ListRoastedLotsResponse","kind":"json-schema","title":"ListRoastedLotsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/RoastedLotCollectionResponse"},"meta":{"$ref":"#/components/schemas/MetaResponse"}}}},"components/schemas/LotRelationResponse":{"id":"components/schemas/LotRelationResponse","kind":"json-schema","title":"LotRelationResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the lot.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","description":"The name of the lot.","example":"Colombia Washed"},"externalId":{"type":"string","description":"Represents the unique identifier of this lot in an external system (e.g. ERP).","example":"lot-5382"},"usedWeight":{"$ref":"#/components/schemas/Weight","description":"The amount of weight consumed from the sourceLot and contributed to the destinationLot during a specific operation (e.g. roasting, blending). For example, 5 KG of a green lot were used in the roast."}},"description":"The green lots that were used for roasting."}},"components/schemas/NameAndIdReferenceResponse":{"id":"components/schemas/NameAndIdReferenceResponse","kind":"json-schema","title":"NameAndIdReferenceResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the object.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","description":"The name of the Object.","example":"Sample object name"}},"description":"Represents a reference to an object by its name and unique identifier."}},"components/schemas/ProfileRelationResponse":{"id":"components/schemas/ProfileRelationResponse","kind":"json-schema","title":"ProfileRelationResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique id of the profile.","format":"uuid","example":"09afcba6-60db-4d44-b359-008911790897"},"name":{"type":"string","description":"The name of the profile.","example":"Light Roast"},"externalId":{"type":"string","description":"Represents the unique identifier this profile in an external system (e.g. ERP).","example":"light-roast"}},"description":"The profile that was used for roasting the lot."}},"components/schemas/RoastedLotCollectionResponse":{"id":"components/schemas/RoastedLotCollectionResponse","kind":"json-schema","title":"RoastedLotCollectionResponse","data":{"type":"object","properties":{"roastedLots":{"type":"array","items":{"$ref":"#/components/schemas/RoastedLotResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/RoastedLotResponse":{"id":"components/schemas/RoastedLotResponse","kind":"json-schema","title":"RoastedLotResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the roasted lot.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"lotNumber":{"type":"string","description":"A human-readable identifier for a roasted lot.","example":"PR-1234"},"name":{"type":"string","description":"The name of the roasted lot.","example":"Colombia Washed"},"weight":{"$ref":"#/components/schemas/Weight"},"weightLoss":{"$ref":"#/components/schemas/Weight","description":"Represents the weight loss during roasting."},"greenLots":{"type":"array","description":"The green lots that were used for roasting.","items":{"$ref":"#/components/schemas/LotRelationResponse"}},"profile":{"$ref":"#/components/schemas/ProfileRelationResponse"},"location":{"$ref":"#/components/schemas/ExternalIdentifierResponse"},"roastedDate":{"type":"string","description":"The date when the lot was roasted in ISO 8601 format","example":"2023-10-05T14:48:00Z"},"lastModifiedDate":{"type":"string","description":"The date when the lot was last modified in ISO 8601 format","example":"2023-10-06T10:15:30Z"},"projects":{"type":"array","items":{"$ref":"#/components/schemas/NameAndIdReferenceResponse"},"description":"The projects that the roasted lot belongs to."}},"description":"Represents a lot that was roasted with a specific profile."}},"components/schemas/ProfileListFilterParam":{"id":"components/schemas/ProfileListFilterParam","kind":"json-schema","title":"ProfileListFilterParam","data":{"type":"object","properties":{"createdDate":{"$ref":"#/components/schemas/DateTimeParam"}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/RequestFilterParamProfileListFilterParam":{"id":"components/schemas/RequestFilterParamProfileListFilterParam","kind":"json-schema","title":"RequestFilterParamProfileListFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/ProfileListFilterParam"},"pagination":{"$ref":"#/components/schemas/PaginationParam"}}}},"components/schemas/RequestParamProfileListFilterParam":{"id":"components/schemas/RequestParamProfileListFilterParam","kind":"json-schema","title":"RequestParamProfileListFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/RequestFilterParamProfileListFilterParam"}}}},"components/schemas/ListProfilesResponse":{"id":"components/schemas/ListProfilesResponse","kind":"json-schema","title":"ListProfilesResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/ProfileCollectionResponse"},"meta":{"$ref":"#/components/schemas/MetaResponse"}}}},"components/schemas/ProfileCollectionResponse":{"id":"components/schemas/ProfileCollectionResponse","kind":"json-schema","title":"ProfileCollectionResponse","data":{"type":"object","properties":{"profiles":{"type":"array","description":"The list of profiles.","items":{"$ref":"#/components/schemas/ProfileResponse"}}},"description":"A collection of processing profiles."}},"components/schemas/ProfileComponentResponse":{"id":"components/schemas/ProfileComponentResponse","kind":"json-schema","title":"ProfileComponentResponse","data":{"type":"object","properties":{"percentage":{"type":"number","description":"The percentage this component contributes (0-100).","format":"double","example":50},"greenLots":{"type":"array","description":"The green lots that are part of this component.","items":{"$ref":"#/components/schemas/NameAndIdReferenceResponse"}}},"description":"A component of a processing profile, representing green lots and their percentage."}},"components/schemas/ProfileResponse":{"id":"components/schemas/ProfileResponse","kind":"json-schema","title":"ProfileResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the profile.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","description":"The name of the profile.","example":"La Loma | Dark"},"profileType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of profile: 'PRE_ROAST_BLEND' for profiles with 2 or more components, or 'SINGLE_ORIGIN' for profiles with 1 component."},"children":[]}]}]}],"example":"SINGLE_ORIGIN","enum":["SINGLE_ORIGIN","PRE_ROAST_BLEND"]},"profileGroup":{"$ref":"#/components/schemas/NameReferenceResponse"},"components":{"type":"array","description":"The components (green lots) that make up this profile.","items":{"$ref":"#/components/schemas/ProfileComponentResponse"}},"referenceRoast":{"$ref":"#/components/schemas/NameAndIdReferenceResponse"},"projects":{"type":"array","items":{"$ref":"#/components/schemas/NameAndIdReferenceResponse"}}},"description":"Represents a processing profile used for roasting."}},"components/schemas/PaginationlessFilterParamRoastedLotIdsFilterParam":{"id":"components/schemas/PaginationlessFilterParamRoastedLotIdsFilterParam","kind":"json-schema","title":"PaginationlessFilterParamRoastedLotIdsFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/RoastedLotIdsFilterParam"}}}},"components/schemas/PaginationlessRequestParamRoastedLotIdsFilterParam":{"id":"components/schemas/PaginationlessRequestParamRoastedLotIdsFilterParam","kind":"json-schema","title":"PaginationlessRequestParamRoastedLotIdsFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/PaginationlessFilterParamRoastedLotIdsFilterParam"}}}},"components/schemas/RoastedLotIdsFilterParam":{"id":"components/schemas/RoastedLotIdsFilterParam","kind":"json-schema","title":"RoastedLotIdsFilterParam","data":{"required":["roastedLotIds"],"type":"object","properties":{"roastedLotIds":{"uniqueItems":true,"type":"array","description":"A set of unique identifiers (UUIDs) of roasted lots to fetch","example":["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],"items":{"type":"string","description":"A set of unique identifiers (UUIDs) of roasted lots to fetch","format":"uuid"}}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/GetRoastedLotsByIdsResponse":{"id":"components/schemas/GetRoastedLotsByIdsResponse","kind":"json-schema","title":"GetRoastedLotsByIdsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/RoastedLotCollectionResponse"}}}},"components/schemas/PaginationlessFilterParamRoastDetailsFilterParam":{"id":"components/schemas/PaginationlessFilterParamRoastDetailsFilterParam","kind":"json-schema","title":"PaginationlessFilterParamRoastDetailsFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/RoastDetailsFilterParam"}}}},"components/schemas/PaginationlessRequestParamRoastDetailsFilterParam":{"id":"components/schemas/PaginationlessRequestParamRoastDetailsFilterParam","kind":"json-schema","title":"PaginationlessRequestParamRoastDetailsFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/PaginationlessFilterParamRoastDetailsFilterParam"}}}},"components/schemas/RoastDetailsFilterParam":{"id":"components/schemas/RoastDetailsFilterParam","kind":"json-schema","title":"RoastDetailsFilterParam","data":{"required":["roastedLotIds"],"type":"object","properties":{"roastedLotIds":{"uniqueItems":true,"type":"array","description":"A set of unique identifiers (UUIDs) representing the roasted lot IDs to filter the roast details.","example":["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],"items":{"type":"string","description":"A set of unique identifiers (UUIDs) representing the roasted lot IDs to filter the roast details.","format":"uuid"}}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/GetRoastDetailsByIdsResponse":{"id":"components/schemas/GetRoastDetailsByIdsResponse","kind":"json-schema","title":"GetRoastDetailsByIdsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/RoastDetailCollectionResponse"}}}},"components/schemas/RoastDetailCollectionResponse":{"id":"components/schemas/RoastDetailCollectionResponse","kind":"json-schema","title":"RoastDetailCollectionResponse","data":{"type":"object","properties":{"roastDetails":{"type":"array","items":{"$ref":"#/components/schemas/RoastDetailResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/RoastDetailResponse":{"id":"components/schemas/RoastDetailResponse","kind":"json-schema","title":"RoastDetailResponse","data":{"type":"object","properties":{"roastTechnician":{"$ref":"#/components/schemas/NameReferenceResponse"},"note":{"type":"string","description":"Additional notes recorded for the roast.","example":"The roast went well, but the machine was making a strange noise at the end."},"startTemperature":{"$ref":"#/components/schemas/Temperature","description":"The starting temperature at the beginning of the roast."},"endTemperature":{"$ref":"#/components/schemas/Temperature","description":"The ending temperature at the conclusion of the roast."},"roastValue":{"$ref":"#/components/schemas/RoastValue","description":"Color of the roasted beans before grinding."},"roastValue2":{"$ref":"#/components/schemas/RoastValue","description":"Color of the roasted beans after grinding."},"roastDuration":{"$ref":"#/components/schemas/Time","description":"The total duration of the roast process."},"firstCrackTime":{"$ref":"#/components/schemas/Time","description":"The time at which the first crack occurs during roasting relative to the start of the roast."},"colorChangeTime":{"$ref":"#/components/schemas/Time","description":"The time at which the color changes during roasting relative to the start of the roast."},"machine":{"$ref":"#/components/schemas/NameReferenceResponse"},"roastedLot":{"$ref":"#/components/schemas/NameAndIdReferenceResponse"}},"description":"Represents details captured for a specific roast."}},"components/schemas/RoastValue":{"id":"components/schemas/RoastValue","kind":"json-schema","title":"RoastValue","data":{"required":["amount","unit"],"type":"object","properties":{"amount":{"multipleOf":0.1,"type":"number","description":"The roast value amount represented as a floating-point number.","format":"double","example":55},"unit":{"type":"string","description":"The roast value unit of measurement.","example":"AGTRON_GOURMET","enum":["AGTRON_GOURMET","AGTRON_COMMERCIAL","COLORTRACK","DIPPER","ESPRESSO_VISION","NEUHAUS_NEOTEC","PROBAT_COLORETTE","HUNTER_L","JAVALYTICS","KONICA_MINOLTA","TONINO","LIGHTTELLS","ROAMI","ROASTRITE"]}},"description":"Represents a roast value along with its unit of measurement."}},"components/schemas/Temperature":{"id":"components/schemas/Temperature","kind":"json-schema","title":"Temperature","data":{"required":["amount","unit"],"type":"object","properties":{"amount":{"multipleOf":0.1,"type":"number","description":"The temperature amount represented as a floating-point number.","format":"double","example":25},"unit":{"type":"string","description":"The temperature unit of measurement.","example":"CELSIUS","enum":["CELSIUS","FAHRENHEIT"]}},"description":"Represents a temperature value along with its unit of measurement."}},"components/schemas/Time":{"id":"components/schemas/Time","kind":"json-schema","title":"Time","data":{"required":["amount","unit"],"type":"object","properties":{"amount":{"multipleOf":0.1,"type":"number","description":"The time amount represented as a floating-point number.","format":"double","example":30},"unit":{"type":"string","description":"The time unit of measurement.","example":"SECOND","enum":["MILLISECOND","SECOND","MINUTE","HOUR"]}},"description":"Represents a time value along with its unit of measurement."}},"components/schemas/PaginationlessFilterParamRoastCurvesFilterParam":{"id":"components/schemas/PaginationlessFilterParamRoastCurvesFilterParam","kind":"json-schema","title":"PaginationlessFilterParamRoastCurvesFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/RoastCurvesFilterParam"}}}},"components/schemas/PaginationlessRequestParamRoastCurvesFilterParam":{"id":"components/schemas/PaginationlessRequestParamRoastCurvesFilterParam","kind":"json-schema","title":"PaginationlessRequestParamRoastCurvesFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/PaginationlessFilterParamRoastCurvesFilterParam"}}}},"components/schemas/RoastCurvesFilterParam":{"id":"components/schemas/RoastCurvesFilterParam","kind":"json-schema","title":"RoastCurvesFilterParam","data":{"required":["roastedLotId"],"type":"object","properties":{"roastedLotId":{"type":"string","description":"A unique identifier (UUID) representing the roasted lot ID to get the roast curves for.","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/CurveResponse":{"id":"components/schemas/CurveResponse","kind":"json-schema","title":"CurveResponse","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the curve.","example":"beanTemperature"},"unit":{"type":"string","description":"The unit of all the values in the curve. Can be different types of units depending on the curve, e.g. temperature, pressure...","example":"CELSIUS"},"dataPoints":{"type":"array","description":"The data points of the curve, where each point consists of a time (in milliseconds since the start of the roast) and a value.","items":{"$ref":"#/components/schemas/DataPoint"}}},"description":"Represents a curve captured during the roast, such as bean temperature."}},"components/schemas/DataPoint":{"id":"components/schemas/DataPoint","kind":"json-schema","title":"DataPoint","data":{"type":"object","properties":{"time":{"type":"number","description":"The time of the data point in milliseconds since the start of the roast.","format":"double","example":1200},"value":{"type":"number","description":"The value of the data point.","format":"double","example":200}},"description":"The data points of the curve, where each point consists of a time (in milliseconds since the start of the roast) and a value."}},"components/schemas/GetRoastCurvesByIdResponse":{"id":"components/schemas/GetRoastCurvesByIdResponse","kind":"json-schema","title":"GetRoastCurvesByIdResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/RoastCurveCollectionResponse"}}}},"components/schemas/RoastCurveCollectionResponse":{"id":"components/schemas/RoastCurveCollectionResponse","kind":"json-schema","title":"RoastCurveCollectionResponse","data":{"type":"object","properties":{"roastCurves":{"type":"array","items":{"$ref":"#/components/schemas/CurveResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/PaginationlessFilterParamProfileIdsFilterParam":{"id":"components/schemas/PaginationlessFilterParamProfileIdsFilterParam","kind":"json-schema","title":"PaginationlessFilterParamProfileIdsFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/ProfileIdsFilterParam"}}}},"components/schemas/PaginationlessRequestParamProfileIdsFilterParam":{"id":"components/schemas/PaginationlessRequestParamProfileIdsFilterParam","kind":"json-schema","title":"PaginationlessRequestParamProfileIdsFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/PaginationlessFilterParamProfileIdsFilterParam"}}}},"components/schemas/ProfileIdsFilterParam":{"id":"components/schemas/ProfileIdsFilterParam","kind":"json-schema","title":"ProfileIdsFilterParam","data":{"type":"object","properties":{"profileIds":{"uniqueItems":true,"type":"array","items":{"type":"string","format":"uuid"}}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/GetProfilesByIdsResponse":{"id":"components/schemas/GetProfilesByIdsResponse","kind":"json-schema","title":"GetProfilesByIdsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/ProfileCollectionResponse"}}}},"components/schemas/RequestDataParamTransferGreenLotRequest":{"id":"components/schemas/RequestDataParamTransferGreenLotRequest","kind":"json-schema","title":"RequestDataParamTransferGreenLotRequest","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TransferGreenLotRequest"}}}},"components/schemas/TransferGreenLotRequest":{"id":"components/schemas/TransferGreenLotRequest","kind":"json-schema","title":"TransferGreenLotRequest","data":{"required":["destinationLocationId","greenLotId","weight"],"type":"object","properties":{"greenLotId":{"type":"string","description":"The green lot that should be transferred to another location","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"weight":{"$ref":"#/components/schemas/Weight"},"destinationLocationId":{"type":"string","description":"The destination location where the green lot should be transferred to","format":"uuid","example":"660e8400-e29b-41d4-a716-446655440000"}},"description":"Defines the data required for the operation, including all mandatory and optional fields."}},"components/schemas/TransferGreenLotPairResponse":{"id":"components/schemas/TransferGreenLotPairResponse","kind":"json-schema","title":"TransferGreenLotPairResponse","data":{"type":"object","properties":{"sourceGreenLot":{"$ref":"#/components/schemas/TransferGreenLotResponse","description":"The source green lot from which weight was transferred."},"destinationGreenLot":{"$ref":"#/components/schemas/TransferGreenLotResponse","description":"The destination green lot that received the transferred weight."}},"description":"Contains the response data of a successful request."}},"components/schemas/TransferGreenLotResponse":{"id":"components/schemas/TransferGreenLotResponse","kind":"json-schema","title":"TransferGreenLotResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the green lot.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"weight":{"$ref":"#/components/schemas/Weight"},"locationId":{"type":"string","description":"The location identifier that is associated to the green lot.","format":"uuid","example":"660e8400-e29b-41d4-a716-446655440000"}}}},"components/schemas/TransferGreenLotToLocationResponse":{"id":"components/schemas/TransferGreenLotToLocationResponse","kind":"json-schema","title":"TransferGreenLotToLocationResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/TransferGreenLotPairResponse"}}}},"components/schemas/GreenLotWeightRequest":{"id":"components/schemas/GreenLotWeightRequest","kind":"json-schema","title":"GreenLotWeightRequest","data":{"required":["greenLotId","weight"],"type":"object","properties":{"greenLotId":{"type":"string","description":"The unique identifier of the green lot for which the weight will be set","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"weight":{"$ref":"#/components/schemas/Weight"}},"description":"Defines the data required for the operation, including all mandatory and optional fields."}},"components/schemas/RequestDataParamGreenLotWeightRequest":{"id":"components/schemas/RequestDataParamGreenLotWeightRequest","kind":"json-schema","title":"RequestDataParamGreenLotWeightRequest","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GreenLotWeightRequest"}}}},"components/schemas/EmptyResponse":{"id":"components/schemas/EmptyResponse","kind":"json-schema","title":"EmptyResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true}}}},"components/schemas/GreenFilterParam":{"id":"components/schemas/GreenFilterParam","kind":"json-schema","title":"GreenFilterParam","data":{"type":"object","properties":{"lastModifiedDate":{"$ref":"#/components/schemas/DateTimeParam"}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/RequestFilterParamGreenFilterParam":{"id":"components/schemas/RequestFilterParamGreenFilterParam","kind":"json-schema","title":"RequestFilterParamGreenFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/GreenFilterParam"},"pagination":{"$ref":"#/components/schemas/PaginationParam"}}}},"components/schemas/RequestParamGreenFilterParam":{"id":"components/schemas/RequestParamGreenFilterParam","kind":"json-schema","title":"RequestParamGreenFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/RequestFilterParamGreenFilterParam"}}}},"components/schemas/GreenLotCollectionResponse":{"id":"components/schemas/GreenLotCollectionResponse","kind":"json-schema","title":"GreenLotCollectionResponse","data":{"type":"object","properties":{"greenLots":{"type":"array","items":{"$ref":"#/components/schemas/GreenLotResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/GreenLotResponse":{"id":"components/schemas/GreenLotResponse","kind":"json-schema","title":"GreenLotResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the green lot.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"lotNumber":{"type":"string","description":"A human-readable identifier for a green lot.","example":"PG-1234"},"name":{"type":"string","description":"The name of the green lot.","example":"Ethiopia Natural"},"icoNumber":{"type":"string","description":"The ICO (International Coffee Organization) number associated with the green lot.","example":"5412"},"externalId":{"type":"string","description":"Represents the unique identifier of the imported green lot in an external system (e.g. ERP).","example":"green-lot-9876"},"weight":{"$ref":"#/components/schemas/Weight"},"price":{"$ref":"#/components/schemas/Price"},"location":{"$ref":"#/components/schemas/ExternalIdentifierResponse"},"projects":{"type":"array","items":{"$ref":"#/components/schemas/NameAndIdReferenceResponse"},"description":"The projects that the green lot belongs to."},"lastModifiedDate":{"type":"string","description":"The date and time when the lot was last modified, in ISO 8601 format.","example":"2024-06-01T12:34:56Z"},"registrationDate":{"type":"string","description":"The date and time when the lot was registered, in ISO 8601 format.","example":"2024-05-01T08:00:00Z"}},"description":"Represents a lot of green coffee beans."}},"components/schemas/ListGreenLotsResponse":{"id":"components/schemas/ListGreenLotsResponse","kind":"json-schema","title":"ListGreenLotsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/GreenLotCollectionResponse"},"meta":{"$ref":"#/components/schemas/MetaResponse"}}}},"components/schemas/Price":{"id":"components/schemas/Price","kind":"json-schema","title":"Price","data":{"required":["amount","currency"],"type":"object","properties":{"amount":{"multipleOf":0.01,"type":"number","description":"The price amount represented as floating-point number.","example":25.5},"currency":{"maxLength":3,"minLength":3,"type":"string","description":"The currency of the price, represented as ISO 4217 currency code.","example":"USD"}},"description":"Represents a price with an amount and a currency."}},"components/schemas/ImportGreenLotRequest":{"id":"components/schemas/ImportGreenLotRequest","kind":"json-schema","title":"ImportGreenLotRequest","data":{"required":["externalId","name","weight"],"type":"object","properties":{"name":{"type":"string","description":"The name of the imported green lot","example":"Ethiopia Natural"},"icoNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ICO (= International Coffee Organization) number associated with the green lot"},"children":[]}]}]}],"example":"5412"},"externalId":{"type":"string","description":"Represents the unique identifier of the imported green lot in an external system (e.g. ERP).","example":"green-lot-9876"},"weight":{"$ref":"#/components/schemas/Weight"},"price":{"$ref":"#/components/schemas/Price"},"location":{"$ref":"#/components/schemas/ExternalIdentifierResponse","description":"The location of the green lot specified by its externalId. Mutually exclusive with locationId. Deprecated, use locationId instead."},"locationId":{"type":"string","description":"The UUID of the location where the green lot is stored. Mutually exclusive with location.externalId.","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"projectId":{"type":"string","description":"The UUID of the project to which the green lot is associated.","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}},"description":"Defines the data required for the operation, including all mandatory and optional fields."}},"components/schemas/RequestDataParamImportGreenLotRequest":{"id":"components/schemas/RequestDataParamImportGreenLotRequest","kind":"json-schema","title":"RequestDataParamImportGreenLotRequest","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImportGreenLotRequest"}}}},"components/schemas/GreenLotSingleResponse":{"id":"components/schemas/GreenLotSingleResponse","kind":"json-schema","title":"GreenLotSingleResponse","data":{"type":"object","properties":{"greenLot":{"$ref":"#/components/schemas/GreenLotResponse"}},"description":"Contains the response data of a successful request."}},"components/schemas/ImportGreenLotResponse":{"id":"components/schemas/ImportGreenLotResponse","kind":"json-schema","title":"ImportGreenLotResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/GreenLotSingleResponse"}}}},"components/schemas/GreenLotIdsFilterParam":{"id":"components/schemas/GreenLotIdsFilterParam","kind":"json-schema","title":"GreenLotIdsFilterParam","data":{"required":["greenLotIds"],"type":"object","properties":{"greenLotIds":{"uniqueItems":true,"type":"array","description":"A set of unique identifiers (UUIDs) of green lots to fetch","example":["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],"items":{"type":"string","description":"A set of unique identifiers (UUIDs) of green lots to fetch","format":"uuid"}}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/PaginationlessFilterParamGreenLotIdsFilterParam":{"id":"components/schemas/PaginationlessFilterParamGreenLotIdsFilterParam","kind":"json-schema","title":"PaginationlessFilterParamGreenLotIdsFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/GreenLotIdsFilterParam"}}}},"components/schemas/PaginationlessRequestParamGreenLotIdsFilterParam":{"id":"components/schemas/PaginationlessRequestParamGreenLotIdsFilterParam","kind":"json-schema","title":"PaginationlessRequestParamGreenLotIdsFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/PaginationlessFilterParamGreenLotIdsFilterParam"}}}},"components/schemas/GetGreenLotsByIdsResponse":{"id":"components/schemas/GetGreenLotsByIdsResponse","kind":"json-schema","title":"GetGreenLotsByIdsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/GreenLotCollectionResponse"}}}},"components/schemas/EudrNumberResponse":{"id":"components/schemas/EudrNumberResponse","kind":"json-schema","title":"EudrNumberResponse","data":{"type":"object","properties":{"number":{"type":"string","description":"The type of the EUDR reference number.","example":"EUDR-12345"}},"description":"Reference numbers for EUDR conformity."}},"components/schemas/GetGreenLotDetailsByIdsResponse":{"id":"components/schemas/GetGreenLotDetailsByIdsResponse","kind":"json-schema","title":"GetGreenLotDetailsByIdsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/GreenLotDetailsCollectionResponse"}}}},"components/schemas/GreenLotDetailResponse":{"id":"components/schemas/GreenLotDetailResponse","kind":"json-schema","title":"GreenLotDetailResponse","data":{"type":"object","properties":{"note":{"type":"string","description":"Additional information about the green lot.","example":"First lot of new harvest, very good quality."},"grade":{"type":"string","description":"A custom grade given to the lot.","example":"AAA"},"cropYear":{"type":"string","description":"Describes the time period a lot was cropped in. This field is a plain string to allow more detailed descriptions.","example":"Start of 2024"},"processingMethods":{"type":"array","description":"The processing methods applied to the lot.","items":{"type":"string","description":"The processing methods applied to the lot."}},"countriesOfOrigin":{"type":"array","description":"The countries a lot originates from in ISO 3166-1 format.","example":["DEU","USA"],"items":{"type":"string","description":"The countries a lot originates from in ISO 3166-1 format.","example":"[\"DEU\",\"USA\"]"}},"varieties":{"type":"array","description":"The varieties associated with the lot","items":{"$ref":"#/components/schemas/NameReferenceResponse"}},"certifications":{"type":"array","description":"The certifications a lot has.","items":{"$ref":"#/components/schemas/NameReferenceResponse"}},"eudrReferences":{"type":"array","description":"Reference numbers for EUDR conformity.","items":{"$ref":"#/components/schemas/EudrNumberResponse"}},"greenLot":{"$ref":"#/components/schemas/NameAndIdReferenceResponse","description":"Reference to the green lot this response describes."}}}},"components/schemas/GreenLotDetailsCollectionResponse":{"id":"components/schemas/GreenLotDetailsCollectionResponse","kind":"json-schema","title":"GreenLotDetailsCollectionResponse","data":{"type":"object","properties":{"greenLotDetails":{"type":"array","items":{"$ref":"#/components/schemas/GreenLotDetailResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/BlendFilterParams":{"id":"components/schemas/BlendFilterParams","kind":"json-schema","title":"BlendFilterParams","data":{"type":"object","properties":{"blendedDate":{"$ref":"#/components/schemas/DateTimeParam"}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/RequestFilterParamBlendFilterParams":{"id":"components/schemas/RequestFilterParamBlendFilterParams","kind":"json-schema","title":"RequestFilterParamBlendFilterParams","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/BlendFilterParams"},"pagination":{"$ref":"#/components/schemas/PaginationParam"}}}},"components/schemas/RequestParamBlendFilterParams":{"id":"components/schemas/RequestParamBlendFilterParams","kind":"json-schema","title":"RequestParamBlendFilterParams","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/RequestFilterParamBlendFilterParams"}}}},"components/schemas/BlendedLotCollectionResponse":{"id":"components/schemas/BlendedLotCollectionResponse","kind":"json-schema","title":"BlendedLotCollectionResponse","data":{"type":"object","properties":{"blendedLots":{"type":"array","items":{"$ref":"#/components/schemas/BlendedLotResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/BlendedLotResponse":{"id":"components/schemas/BlendedLotResponse","kind":"json-schema","title":"BlendedLotResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the blended lot.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"lotNumber":{"type":"string","description":"A human-readable identifier for a blended lot.","example":"PB-1234"},"name":{"type":"string","description":"The name of the blended lot.","example":"House Blend"},"weight":{"$ref":"#/components/schemas/Weight"},"roastedLots":{"type":"array","description":"The roasted lots that were used to create this blended lot.","items":{"$ref":"#/components/schemas/LotRelationResponse"}},"location":{"$ref":"#/components/schemas/ExternalIdentifierResponse"},"blendedDate":{"type":"string","description":"The date when the lot was blended in ISO 8601 format","example":"2023-10-05T14:48:00Z"},"projects":{"type":"array","items":{"$ref":"#/components/schemas/NameAndIdReferenceResponse"},"description":"The projects that the blended lot belongs to."}},"description":"Represents a lot that was blended from one or multiple roasted lots."}},"components/schemas/ListBlendedLotsResponse":{"id":"components/schemas/ListBlendedLotsResponse","kind":"json-schema","title":"ListBlendedLotsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/BlendedLotCollectionResponse"},"meta":{"$ref":"#/components/schemas/MetaResponse"}}}},"components/schemas/RequestFilterParamVoid":{"id":"components/schemas/RequestFilterParamVoid","kind":"json-schema","title":"RequestFilterParamVoid","data":{"type":"object","properties":{"filter":{"type":"object","description":"Defines all required and optional filter parameters for the operation."},"pagination":{"$ref":"#/components/schemas/PaginationParam"}}}},"components/schemas/RequestParamVoid":{"id":"components/schemas/RequestParamVoid","kind":"json-schema","title":"RequestParamVoid","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/RequestFilterParamVoid"}}}},"components/schemas/ListSuppliersResponse":{"id":"components/schemas/ListSuppliersResponse","kind":"json-schema","title":"ListSuppliersResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/SupplierCollectionResponse"},"meta":{"$ref":"#/components/schemas/MetaResponse"}}}},"components/schemas/SupplierCollectionResponse":{"id":"components/schemas/SupplierCollectionResponse","kind":"json-schema","title":"SupplierCollectionResponse","data":{"type":"object","properties":{"suppliers":{"type":"array","items":{"$ref":"#/components/schemas/SupplierResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/SupplierResponse":{"id":"components/schemas/SupplierResponse","kind":"json-schema","title":"SupplierResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the supplier","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","description":"The name of the supplier","example":"Super nice supplier"},"roles":{"type":"array","description":"The roles the supplier plays in the supply chain","items":{"type":"string","description":"The role a supply network member plays in the supply chain.","enum":["FIELD","FARM","ASSOCIATION","COOPERATIVE","COMMUNITY","WETMILL","DRYMILL","EXPORTER","IMPORTER","ROASTER","OTHER","PICKER","VENDOR","CUSTOMER"]}},"country":{"type":"string","description":"The ISO 3166-1 formatted country code of the supplier","example":"KEN"}},"description":"Suppliers represent the members of your supply network, such as farms, cooperatives, importers or exporters."}},"components/schemas/ImportSupplierRequest":{"id":"components/schemas/ImportSupplierRequest","kind":"json-schema","title":"ImportSupplierRequest","data":{"required":["name","roles"],"type":"object","properties":{"name":{"type":"string","description":"The name of the supplier to be imported. Cannot be blank.","example":"Super nice supplier"},"roles":{"type":"array","description":"The roles the supplier plays in the supply chain. At least one role is required.","items":{"type":"string","description":"The role a supply network member plays in the supply chain.","enum":["FIELD","FARM","ASSOCIATION","COOPERATIVE","COMMUNITY","WETMILL","DRYMILL","EXPORTER","IMPORTER","ROASTER","OTHER","PICKER","VENDOR","CUSTOMER"]}},"country":{"type":"string","description":"The ISO 3166-1 alpha-3 code of the country the supplier operates from.","example":"KEN"}},"description":"Defines the data required for the operation, including all mandatory and optional fields."}},"components/schemas/RequestDataParamImportSupplierRequest":{"id":"components/schemas/RequestDataParamImportSupplierRequest","kind":"json-schema","title":"RequestDataParamImportSupplierRequest","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImportSupplierRequest"}}}},"components/schemas/ImportSupplierResponse":{"id":"components/schemas/ImportSupplierResponse","kind":"json-schema","title":"ImportSupplierResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/SupplierSingleResponse"}}}},"components/schemas/SupplierSingleResponse":{"id":"components/schemas/SupplierSingleResponse","kind":"json-schema","title":"SupplierSingleResponse","data":{"type":"object","properties":{"supplier":{"$ref":"#/components/schemas/SupplierResponse"}},"description":"Contains the response data of a successful request."}},"components/schemas/PaginationlessFilterParamSupplierIdsFilterParam":{"id":"components/schemas/PaginationlessFilterParamSupplierIdsFilterParam","kind":"json-schema","title":"PaginationlessFilterParamSupplierIdsFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/SupplierIdsFilterParam"}}}},"components/schemas/PaginationlessRequestParamSupplierIdsFilterParam":{"id":"components/schemas/PaginationlessRequestParamSupplierIdsFilterParam","kind":"json-schema","title":"PaginationlessRequestParamSupplierIdsFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/PaginationlessFilterParamSupplierIdsFilterParam"}}}},"components/schemas/SupplierIdsFilterParam":{"id":"components/schemas/SupplierIdsFilterParam","kind":"json-schema","title":"SupplierIdsFilterParam","data":{"type":"object","properties":{"supplierIds":{"uniqueItems":true,"type":"array","items":{"type":"string","format":"uuid"}}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/GetSuppliersByIdsResponse":{"id":"components/schemas/GetSuppliersByIdsResponse","kind":"json-schema","title":"GetSuppliersByIdsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/SupplierCollectionResponse"}}}},"components/schemas/ListProjectsResponse":{"id":"components/schemas/ListProjectsResponse","kind":"json-schema","title":"ListProjectsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/ProjectCollectionResponse"},"meta":{"$ref":"#/components/schemas/MetaResponse"}}}},"components/schemas/ProjectCollectionResponse":{"id":"components/schemas/ProjectCollectionResponse","kind":"json-schema","title":"ProjectCollectionResponse","data":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/ProjectResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/ProjectResponse":{"id":"components/schemas/ProjectResponse","kind":"json-schema","title":"ProjectResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the project","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","description":"The name of the project","example":"Blend Experiments 2024"},"description":{"type":"string","description":"A description of the project","example":"This project contains all experiments for new blends in 2024"}},"description":"Projects are a way to group certain objects together"}},"components/schemas/ImportProjectRequest":{"id":"components/schemas/ImportProjectRequest","kind":"json-schema","title":"ImportProjectRequest","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the project to be imported. Must be unique.","example":"Blends 2026"},"description":{"type":"string","description":"A optional description of the project.","example":"This project contains all blends for the year 2026."}},"description":"Defines the data required for the operation, including all mandatory and optional fields."}},"components/schemas/RequestDataParamImportProjectRequest":{"id":"components/schemas/RequestDataParamImportProjectRequest","kind":"json-schema","title":"RequestDataParamImportProjectRequest","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImportProjectRequest"}}}},"components/schemas/ImportProjectResponse":{"id":"components/schemas/ImportProjectResponse","kind":"json-schema","title":"ImportProjectResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/ProjectSingleResponse"}}}},"components/schemas/ProjectSingleResponse":{"id":"components/schemas/ProjectSingleResponse","kind":"json-schema","title":"ProjectSingleResponse","data":{"type":"object","properties":{"project":{"$ref":"#/components/schemas/ProjectResponse"}},"description":"Contains the response data of a successful request."}},"components/schemas/LocationFilterParam":{"id":"components/schemas/LocationFilterParam","kind":"json-schema","title":"LocationFilterParam","data":{"type":"object","properties":{"externalIds":{"uniqueItems":true,"type":"array","description":"A set of user-defined unique identifiers (Strings)  to filter locations.","example":["external-id-1","external-id-2"],"items":{"type":"string","description":"A set of user-defined unique identifiers (Strings)  to filter locations.","example":"[\"external-id-1\",\"external-id-2\"]"}}},"description":"Defines all required and optional filter parameters for the operation."}},"components/schemas/RequestFilterParamLocationFilterParam":{"id":"components/schemas/RequestFilterParamLocationFilterParam","kind":"json-schema","title":"RequestFilterParamLocationFilterParam","data":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/LocationFilterParam"},"pagination":{"$ref":"#/components/schemas/PaginationParam"}}}},"components/schemas/RequestParamLocationFilterParam":{"id":"components/schemas/RequestParamLocationFilterParam","kind":"json-schema","title":"RequestParamLocationFilterParam","data":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/RequestFilterParamLocationFilterParam"}}}},"components/schemas/ListLocationsResponse":{"id":"components/schemas/ListLocationsResponse","kind":"json-schema","title":"ListLocationsResponse","data":{"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates whether the request was successful.","example":true},"result":{"$ref":"#/components/schemas/LocationCollectionResponse"},"meta":{"$ref":"#/components/schemas/MetaResponse"}}}},"components/schemas/LocationCollectionResponse":{"id":"components/schemas/LocationCollectionResponse","kind":"json-schema","title":"LocationCollectionResponse","data":{"type":"object","properties":{"locations":{"type":"array","items":{"$ref":"#/components/schemas/LocationResponse"}}},"description":"Contains the response data of a successful request."}},"components/schemas/LocationResponse":{"id":"components/schemas/LocationResponse","kind":"json-schema","title":"LocationResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the location","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","description":"The name of the location","example":"Main Roastery"},"externalId":{"type":"string","description":"A user-defined unique identifier for the location to identify it in external systems.","example":"roastery-main-001"}},"description":"Locations represent physical places such as warehouses, roasteries etc."}}},"exampleStore":{},"securitySchemeStore":{"oauth2":{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.cropster.com/oauth2/token","scopes":{"core.location":"core.location","core.project":"core.project","core.supplyNetwork":"core.supplyNetwork","inventory.roast":"inventory.roast","inventory.green":"inventory.green","inventory.blend":"inventory.blend","quality.cupping":"quality.cupping","quality.physical":"quality.physical","mrp.product":"mrp.product","mrp.order":"mrp.order","sample.green":"sample.green"}}}}},"servers":[{"url":"https://api.cropster.com/rpc/v1"}],"specType":"openapi"},"options":{"hideDownloadButtons":true,"jsonSamplesExpandLevel":"all","schemasExpansionLevel":2,"hidePropertiesPrefix":true,"layout":"three-panel","hideSchemaTitles":true,"hideReplay":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/api/rpc/reference.json?download"},{"url":"/_bundle/api/rpc/reference.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"API Reference","description":"Welcome! This guide will get you up and running with our API. Our goal is to provide a powerful and intuitive interface that is easy to integrate with.\n\nOur API is designed using an **RPC (Remote Procedure Call) style over HTTP**. This means that instead of focusing on RESTful resources (nouns), you'll interact with **operation-centric** methods that represent clear business actions (verbs).\n\n# Core Principles\n\nWe designed the API with three key principles in mind to make your development experience as smooth as possible.\n\n- **Domain-driven Design:** Our API is organized into domain-specific **namespaces** that logically group related operations. This domain-oriented design simplifies method discovery and ensures that you are always interacting with the correct part of the system.\n\n- **Business Process-Oriented:** Our API methods are designed to mirror your real-world business processes. Instead of generic data manipulation, you'll call functions that represent distinct steps in your workflow. For example, you'll call `setGreenLotWeight` or `transferGreenLotToLocation`, directly matching the actions your team performs.\n\n- **Data Consistency:** To guarantee data integrity, our API treats each business operation as a single, atomic request. This approach bundles all data changes into one call, preventing the data corruption and inconsistencies that can occur when an operation is split across multiple requests.\n\n\n# Request Format\n\n{% table %}\n- Criteria {% width=\"30%\" %}\n- Description\n\n---\n\n- **HTTP Method**\n- Our API exclusively uses the `POST` HTTP method for all operations. The specific action you wish to perform (e.g., retrieving, creating, or updating data) should be specified within the request body, rather than by using different HTTP verbs like `GET`, `PUT`, or `DELETE`.\n\n---\n\n- **Protocol & Security**\n- All communication with the API must be made over **HTTPS**. For security, connections made over unencrypted HTTP will be rejected.\n\n\n---\n\n- **Base URL**\n- The **base path** for all endpoints is `https://api.cropster.com/rpc/v1` where `v1` is the current version of the API.\n\n---\n\n- **URL Path Schema**\n- The endpoints are **hierarchical structure** using dotted namespaces to reflect the business domain. This structure allows for clear organization and easy discovery of endpoints related to specific business operations. The following endpoint naming schema is used for all endpoints: `{domain}.{subdomain}.{operation}` (e.g., `inventory.roast.listRoastedLots`).\n\n---\n\n\n- **Content-Type**\n- All POST requests must include a `Content-Type` header set to `application/json`. Requests with a different content type, or without this header, will be rejected.\n  The only exception to this is the OAuth token request, which requires a `Content-Type` of `application/x-www-form-urlencoded`.\n\n---\n\n- **Payload**\n- Request and response bodies are in **JSON** format with **camelCase** field names. **Singular nouns** are generally used for fields representing single entities (e.g. `locationId`). **Plural nouns** are used for fields representing lists of entities (e.g. `greenLots`).\n\n{% /table %}\n\n# Authentication\n\nThe Cropster API uses the **OAuth 2.0 Client Credentials Grant** flow to authenticate all requests. This is a server-to-server authentication method where applications authenticate directly rather than on behalf of a user.\n\nThe process involves two main steps which are explained in the following.\n\n### Generate API Credentials\n\nBefore you can connect to the API, you must create a Service Account in the Cropster user interface to obtain a `Client ID` and `Client Secret`.\n\n1.  Log in to your [Cropster account](https://c-sar.cropster.com) and navigate to the **Settings > Service Accounts** section.\n2.  Create a new **Service Account**.\n3.  Assign a name and the required **OAuth scopes** that define the specific permissions for this account (e.g., `inventory.roast` to access roast inventory data).\n4.  Upon creation, your `Client ID` and `Client Secret` will be displayed.\n    \n{% admonition type=\"warning\" name=\"Secure Your Credentials\" %}\n  Your `Client Secret` is highly sensitive and is only displayed once upon creation. Store it securely and treat it like a password. Do not expose it in client-side code.\n{% /admonition %}\n\n\n\n## Request Access Token\n\nNext, exchange your credentials for a temporary access token by making a `POST` request against the OAuth2 token endpoint: `https://auth.cropster.com/oauth2/token`.\n\nNote that the `scope` parameter must include all OAuth scopes that are required for subsequent API requests. For example, to access roasted inventory data, the `inventory.roast` scope\nmust be included.\n\n{% openapi-code-sample\n  descriptionFile=\"../oauth/oauth-api.yaml\"\n  operationId=\"oauth2Token\"\n/%}\n\nIf the request is successful, the response contains the access token that must be set as\n`Bearer: <ACCESS_TOKEN>` in the `Authorization` header of all subsequent API requests.\n\n{% markdoc-example renderDemo=false %}\n```markdown {% title=\"Successful Response\" %}\n{\n    \"access_token\": \"<ACCESS_TOKEN>\",\n    \"expires_in\": 28799,\n    \"scope\": \"inventory.green%20inventory.roast%20inventory.blend\",\n    \"token_type\": \"bearer\"\n}\n```\n{% /markdoc-example %}\n\n{% admonition type=\"info\" name=\"Access Token Lifetime\" %}\nThe access token is valid for **8 hours**. You should cache the token in your application and reuse it until it expires to reduce latency and avoid unnecessary token requests.\n{% /admonition %}\n\n---\n\n<h1>Request Format</h1>\n\nThis section details the required request format for obtaining an access token and the structure of the response you will receive.\n\n<h2>Request Parameters</h2>\n\nThe following parameters are required for the access token request:\n\n{% json-schema\nschema={\n\"$ref\": \"../oauth/oauth-api.yaml#/components/schemas/oauth2TokenRequest\"\n}\n/%}\n\n<h2>Response Fields</h2>\n\nA successful request returns the access token along with its associated metadata:\n\n{% json-schema\nschema={\n\"$ref\": \"../oauth/oauth-api.yaml#/components/schemas/oauth2TokenResponse\"\n}\n/%}\n\n\n\n# Error Handling\n\nEach API request is returning a status code that indicates if the request was successfully\ncompleted. In the following, the most common HTTP status codes are listed:\n\n{% table %}\n- HTTP Status Code {% width=\"30%\" %}\n- Description\n \n---\n\n- **200 OK**\n- The request was successful.\n\n---\n\n- **400 Bad Request**\n- The request couldn't be processed by the server due to an invalid request. Possible reasons can be missing or invalid query parameters, invalid JSON payload or malformed URL.\n    \n---\n\n- **401 Unauthorized**\n- The provided authentication credentials are not correct. Please check the section Authentication on how to provide valid authentication credentials.\n\n---\n\n- **403 Forbidden**\n- The client doesn't have permissions to perform the request. Please check the endpoint documentation on which permissions are required.\n    \n---\n\n- **405 Method Not Allowed**\n- This error indicates that the requested operation is not supported. For example, this error can be caused when a POST request is not supported by an endpoint.\n    \n---\n\n- **422 Unprocessable Entity**\n- The request failed due to semantic errors in the request body. Examples of semantic errors are missing attributes or the violation of business rules (e.g. creating a green lot with a negative weight).\n    \n---\n\n- **429 Too Many Requests**\n- The client has sent too many requests in a given amount of time. Please check the Rate Limiting section for more details.\n\n---\n\n- **500 Server Error**\n- An internal error encountered within Cropster. Please check the Cropster status page to verify if all systems are operational.\n    \n---\n{% /table %}\n\nTo handle errors programmatically, each error response contains one of the following error codes:\n\n{% table %}\n\n- Error Code {% width=\"30%\" %}\n- Description\n\n---\n\n- **invalid_authentication**\n- Indicates that the authentication credentials provided are invalid. For example, the JWT is missing or is expired.\n\n---\n\n- **access_denied**\n- Indicates that the user is authenticated but does not have the required permissions to access the requested resource. For example, a user without the appropriate role\n  attempts to perform a restricted operation.\n\n\n---\n\n- **resource_not_found**\n- Indicates that the specified resource could not be found. For example, an object is request by an ID that does not exist.\n\n---\n\n- **invalid_request**\n- Indicates that the request could not be completed due to invalid or missing information. Please review the documentation and try again.\n\n---\n\n- **invalid_weight**\n- Indicates that the weight parameter in the request is invalid. For example, a negative weight amount is specified.\n\n---\n\n- **invalid_price**\n- Indicates that the price parameter in the request is invalid. For example, a negative price amount is provided.\n\n---\n\n- **invalid_json**\n- Indicates that the provided request is malformed.\n\n---\n\n- **invalid_parameter**\n- A general-purpose error indicating that one or more parameters in the request failed validation. This is a fallback error and should include a descriptive message with more detail. Note, this error should not normally be returned unless a more specific code is not applicable.\n\n--- \n\n- **missing_parameter**\n- Indicates that a required parameter is missing from the request. For example, the name property is omitted in the `importGreenLot` request.\n\n---\n\n- **resource_conflict**\n- Indicates that the request contains conflicting parameters. For example, the `importGreenLot` request specifies location ID and location at the same time.\n\n---\n\n- **unsupported_currency**\n- Indicates that the specified currency is not an ISO 8601 compliant currency\n  code.\n\n---\n\n- **unsupported_unit**\n- Indicates that the specified weight unit is not supported. Only `KG` and `LBS` are\n  currently accepted.\n\n---\n\n- **too_many_requests**\n- Indicates that the client has sent too many requests in a given amount of time.\n\n---\n\n- **bulk_operation_failed**\n- Indicates that one or more issues occurred during the processing of a bulk request.\n\n---\n\n- **server_error**\n- Indicates an internal server error occurred while processing the request. The accompanying error message should provide additional context.\n\n---\n\n{% /table %}\n\n# Pagination\n\nThe RPC API uses cursor-based pagination for read-centric, listing endpoints. The results are delivered in reverse-chronological order. This means that the most recently created results appear first in the result set. For the time being, only forward navigation is supported. The default page size is set to 50 items per page. \n\nThe `meta.pagination.endCursor` field in the response indicates if there are more pages. Pass this cursor value in the `params.pagination.after` field of the next request to retrieve the next page. If there are no further pages, `meta.pagination.endCursor` will be null.\n\n---\n\n<h2>Pagination Request Parameters</h2>\n\n{% json-schema\n  schema={\n    \"title\": \"\",\n    \"type\": \"object\",\n    \"properties\": {\n      \"params.pagination.after\": {\n        \"type\": \"string\",\n        \"description\": \"Cursor value to retrieve the result of the next page. This value is obtained from the `meta.pagination.endCursor` field of the previous response. If not specified or `null`, the first page of results is returned.\",\n      },\n      \"params.pagination.limit\": {\n        \"type\": \"int\",\n        \"description\": \"Specifies the page size of the result set. The value must be in the range between 1 and 100. If not specified, the default value of 50 is used.\",\n        \"minimum\": 1,\n        \"maximum\": 100\n      }\n    }\n  }\n/%}\n\n<h2>Pagination Response Field</h2>\n\n{% json-schema\n  schema={\n    \"title\": \"\",\n    \"type\": \"object\",\n    \"properties\": {\n      \"meta.pagination.endCursor\": {\n        \"type\": \"string\",\n        \"description\": \"Cursor value to retrieve the records of the next page. This value should be passed in the `params.pagination.after` field of the next request. If there are no further pages, this value is `null`.\"\n      }\n    }\n  }\n/%}\n\n<h2>Example</h2>\n\nIn the following the pagination mechanism is explained using the `inventory.roast.listRoastedLots` endpoint as an example. The first request retrieves the first page of roasted lots created after `2025-01-01T00:00:00Z` with a page size of 10 records. Notice, the `after` field is set to `null` to indicate that the first page should be returned.\n\n{% markdoc-example renderDemo=false %}\n``` JSON {% title=\"First request to retrive first page\" %}\nPOST <BASE_PATH>/inventory.roast.listRoastedLots\nContent-type: application/json\nAuthorization: Bearer `<TOKEN>`\n{\n    \"params\": {\n        \"filter\": {\n            \"roastedDate\": {\n                \"from\": \"2025-01-01T00:00:00Z\"\n            }\n        },\n        \"pagination\": {\n            \"after\": null,\n            \"limit\": 10 \n        }\n    }\n}\n```\n{% /markdoc-example %}\n\nThe response of the above request contains the `meta.pagination.endCursor` field that can be used to retrieve the next page. This value should be passed in the `params.pagination.after` field of the next request. If there are no further pages, `meta.pagination.endCursor` will be null.\n\n{% markdoc-example renderDemo=false %}\n```JSON {% title=\"Paginated response\" %}\n {\n  \"ok\": true,\n  \"result\": {\n    \"roasts\": [\n      ...\n    ]\n  },\n  \"meta\": {\n    \"pagination\": {\n      \"endCursor\": \n        \"aBc=\"\n    }\n  }\n}\n```\n{% /markdoc-example %}\n\n\nSince an `endCursor` value of `aBc=` was returned in the previous response, there are more pages \navailable. To retrieve the next page, use this value in the `params.pagination.after` field in the next request.\n\n{% markdoc-example renderDemo=false %}\n``` JSON {% title=\"Second request to retrieve the next page\" %}\nPOST <BASE_PATH>/inventory.roast.listRoastedLots\nContent-type: application/json\nAuthorization: Bearer `<TOKEN>`\n{\n    \"params\": {\n        \"filter\": {\n            \"roastedDate\": {\n                \"from\": \"2025-01-01T00:00:00Z\"\n            }\n        },\n        \"pagination\": {\n            \"after\": \"aBc=\n        }\n    }\n}\n```\n{% /markdoc-example %}\n\n# Rate Limiting\n\nTo ensure fair usage and maintain optimal performance of the API, rate limiting is enforced on all endpoints. If a client exceeds the specified limits, the API will respond with an `429 Too Many Requests` HTTP status code.\n\nOur standard rate limits are set as follows:\n\n- **Rate Limit:** 5 requests per second. This is the average throughput your application is allowed to execute.\n\n- **Burst Limit:** 10 requests per second. Allows for short-term spikes in traffic. For example, your application can send up to 10 requests in a single, as long as the average rate remains within the 5 req/sec sustained limit. \n\n# Versioning\n\nOur API is versioned to ensure that your integration remains stable and that future updates do not introduce breaking changes unexpectedly. We use URI path versioning, where the version is explicitly included in the request path.\n\n- **Current Version:** The current stable version of our API is `v1`. \n\n- **Future Versions:** \nWhen we introduce backward-incompatible changes, we will release a new API version (e.g., `v2`, `v3`). Older versions are supported for a reasonable time, with a clear migration guide provided well in advance of retirement.\n\n# AI Tooling\n\nTo accelerate your development workflow, you can integrate the Cropster API with various AI assistants and development tools:\n\n### AI Assistant\n\n* **What it does:** Instantly gather quick insights, generate boilerplate code tailored to your use case, or troubleshoot configuration errors on the fly.\n* **Where to find it:** Click the **Ask AI** button in the bottom-right corner of any documentation page, or type your question directly into the main search bar.\n* **How to use it:** Ask any question related to the Cropster API. The AI Assistant will provide concise answers, code snippets, and direct documentation references. You can also use the integrated copy button to quickly grab a prompt-optimized context of the API to paste into Claude, ChatGPT, or your preferred AI chatbot.\n\n### MCP Server\n\n* **What it does:** We now host a dedicated MCP server for developers using next-generation AI tools and IDEs (like Cursor, VS Code, Claude, or ChatGPT). This feature streams live API context, schemas, and definitions directly into your local development environment, significantly reducing integration time.\n* **How to use it:** Connect the Cropster MCP server URL to your IDE or AI client. For a deep dive into how MCP works and how to configure it in your specific environment, check out the [Model Context Protocol Getting Started Guide](https://modelcontextprotocol.io/docs/getting-started/intro).\n* **Where to find it:** You can reach the MCP server under the following link: [https://docs.cropster.com/mcp](https://docs.cropster.com/mcp) or connecting directly to pre-defined AI tools here {% connect-mcp placement=\"top\" /%}."}},"baseSlug":"/api/rpc/reference","routesMapping":{}}